File: CastleOnScreenMenu.TMenuSlider.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (153 lines) | stat: -rw-r--r-- 9,686 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleOnScreenMenu: Class TMenuSlider</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TMenuSlider"></a><h1 class="cio">Class TMenuSlider</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a  href="CastleOnScreenMenu.html">CastleOnScreenMenu</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TMenuSlider = class(<a class="normal" href="CastleOnScreenMenu.TMenuAccessory.html">TMenuAccessory</a>)</code></p>
<h2 class="description">Description</h2>
<div class="nodescription">no description available, TMenuAccessory description follows</div><p>
Attachment to a specific menu item of <a class="normal" href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a>, for example may store a value associated with given menu option, and allow to change it by a slider.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor"><a class="normal" href="CastleOnScreenMenu.TMenuAccessory.html">TMenuAccessory</a></li>
<li class="thisitem">TMenuSlider</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleOnScreenMenu.TMenuSlider.html#DrawSliderPosition">DrawSliderPosition</a></b>(const Rectangle: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; const Position: Single);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleOnScreenMenu.TMenuSlider.html#XCoordToSliderPosition">XCoordToSliderPosition</a></b>(const XCoord: Single; const Rectangle: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>): Single;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleOnScreenMenu.TMenuSlider.html#DrawSliderText">DrawSliderText</a></b>(const Rectangle: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; const Text: string);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a  href="CastleOnScreenMenu.TMenuSlider.html#Create">Create</a></b>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleOnScreenMenu.TMenuSlider.html#GetWidth">GetWidth</a></b>: Integer; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleOnScreenMenu.TMenuSlider.html#Draw">Draw</a></b>(const Rectangle: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>); override;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleOnScreenMenu.TMenuSlider.html#DisplayValue">DisplayValue</a></b>: boolean
      read FDisplayValue write FDisplayValue default true;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="DrawSliderPosition"></a><code>procedure <b>DrawSliderPosition</b>(const Rectangle: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; const Position: Single);</code></td>
</tr>
<tr><td colspan="2">
<p>
Draw a slider at given Position. If Position is outside 0..1, it is clamped to 0..1 (this way we do not show slider at some wild position if it's outside the expected range; but <a class="normal" href="CastleOnScreenMenu.TMenuSlider.html#DrawSliderText">DrawSliderText</a> will still show the true, unclamped, value).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="XCoordToSliderPosition"></a><code>function <b>XCoordToSliderPosition</b>(const XCoord: Single; const Rectangle: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>): Single;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns a value of Position, always in 0..1 range, that would result in slider being drawn at XCoord screen position by <a class="normal" href="CastleOnScreenMenu.TMenuSlider.html#DrawSliderPosition">DrawSliderPosition</a>. Takes Rectangle as the rectangle currently occupied by the whole slider.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="DrawSliderText"></a><code>procedure <b>DrawSliderText</b>(const Rectangle: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; const Text: string);</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="GetWidth"></a><code>function <b>GetWidth</b>: Integer; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Draw"></a><code>procedure <b>Draw</b>(const Rectangle: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="DisplayValue"></a><code>property <b>DisplayValue</b>: boolean
      read FDisplayValue write FDisplayValue default true;</code></td>
</tr>
<tr><td colspan="2">
<p>
Should the Value be displayed as text ? Usually useful &mdash; but only if the Value has some meaning for the user. If <code>True</code>, then ValueToStr is used.</p>
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  _paq.push(["trackPageView"]);
  _paq.push(["enableLinkTracking"]);

  (function() {
    var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
    _paq.push(["setTrackerUrl", u+"piwik.php"]);
    _paq.push(["setSiteId", "1"]);
    var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
    g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
  })();
</script>
<!-- End Piwik Code -->

<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&amp;rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:10</em>
</span>
</td></tr></table></body></html>