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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<!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 TMenuAccessory</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="TMenuAccessory"></a><h1 class="cio">Class TMenuAccessory</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 TMenuAccessory = class(TObject)</code></p>
<h2 class="description">Description</h2>
<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="thisitem">TMenuAccessory</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a href="CastleOnScreenMenu.TMenuAccessory.html#Create">Create</a></b>;</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>function <b><a href="CastleOnScreenMenu.TMenuAccessory.html#GetWidth">GetWidth</a></b>: Integer; virtual; abstract;</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>procedure <b><a href="CastleOnScreenMenu.TMenuAccessory.html#Draw">Draw</a></b>(const Rectangle: <a href="CastleRectangles.TRectangle.html">TRectangle</a>); virtual; abstract;</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>function <b><a href="CastleOnScreenMenu.TMenuAccessory.html#KeyDown">KeyDown</a></b>(Key: <a href="CastleKeysMouse.html#TKey">TKey</a>; C: char; ParentMenu: <a href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a>): boolean; virtual;</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.TMenuAccessory.html#MouseDown">MouseDown</a></b>(const Event: <a href="CastleKeysMouse.TInputPressRelease.html">TInputPressRelease</a>; const Rectangle: <a href="CastleRectangles.TRectangle.html">TRectangle</a>; ParentMenu: <a href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a>): boolean; virtual;</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.TMenuAccessory.html#Motion">Motion</a></b>(const Event: <a href="CastleKeysMouse.TInputMotion.html">TInputMotion</a>; const Rectangle: <a href="CastleRectangles.TRectangle.html">TRectangle</a>; ParentMenu: <a href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a>); virtual;</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.TMenuAccessory.html#OwnedByParent">OwnedByParent</a></b>: boolean
read FOwnedByParent write FOwnedByParent 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="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">
</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; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Return the width you will need to display yourself.
<p>Note that this will be asked only from FixItemsRectangles from <a class="normal" href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a>. So for example <a class="normal" href="CastleOnScreenMenu.TMenuArgument.html">TMenuArgument</a> is *not* supposed to return here something based on current <a class="normal" href="CastleOnScreenMenu.TMenuArgument.html#Value">TMenuArgument.Value</a>, because we will not query <code>GetWidth</code> after every change of <a class="normal" href="CastleOnScreenMenu.TMenuArgument.html#Value">TMenuArgument.Value</a>. Instead, <a class="normal" href="CastleOnScreenMenu.TMenuArgument.html">TMenuArgument</a> should return here the width of widest possible Value.</p>
</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>); virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Draw (2D) contents. Note that Rectangle.Width is for sure the same as you returned in <a class="normal" href="CastleOnScreenMenu.TMenuAccessory.html#GetWidth">GetWidth</a>.</p>
</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="KeyDown"></a><code>function <b>KeyDown</b>(Key: <a href="CastleKeysMouse.html#TKey">TKey</a>; C: char; ParentMenu: <a href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a>): boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
This will be called if user will press a key when currently selected item has this <a class="normal" href="CastleOnScreenMenu.TMenuAccessory.html">TMenuAccessory</a>.
<p>You can use ParentMenu to call ParentMenu.AccessoryValueChanged.</p>
</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="MouseDown"></a><code>function <b>MouseDown</b>(const Event: <a href="CastleKeysMouse.TInputPressRelease.html">TInputPressRelease</a>; const Rectangle: <a href="CastleRectangles.TRectangle.html">TRectangle</a>; ParentMenu: <a href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a>): boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Called when user clicks the mouse when currently selected item has this <a class="normal" href="CastleOnScreenMenu.TMenuAccessory.html">TMenuAccessory</a>.
<p>Called only if Event.MousePosition is within current Rectangle (place on screen) of this accessory. This Rectangle is also passed here, so you can e.g. calculate mouse position relative to current accessory as (Event.Position[0] - Rectangle.Left, Event.Position[1] - Rectangle.Bottom).
<p>Note that while the user holds the mouse clicked (Event.Pressed <> []), the mouse is "grabbed" by this accessory, and even when the user will move the mouse over other items, they will not receive their <code>MouseDown</code>/<a class="normal" href="CastleOnScreenMenu.TMenuAccessory.html#Motion">Motion</a> messages until user will let the mouse go. This prevents the bad situation when user does <code>MouseDown</code> e.g. on "Sound Volume" slider, slides it to the right and then accidentaly moves the mouse also a little down, and suddenly he's over "Music Volume" slider and he changed the position of "Music Volume" slider.
<p>You can use ParentMenu to call ParentMenu.AccessoryValueChanged.</p>
</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="Motion"></a><code>procedure <b>Motion</b>(const Event: <a href="CastleKeysMouse.TInputMotion.html">TInputMotion</a>; const Rectangle: <a href="CastleRectangles.TRectangle.html">TRectangle</a>; ParentMenu: <a href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a>); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Called when user moves the mouse over the currently selected menu item and menu item has this accessory.
<p>Just like with <a class="normal" href="CastleOnScreenMenu.TMenuAccessory.html#MouseDown">MouseDown</a>: This will be called only if Event.Position is within appropriate Rectangle of accessory. You can use ParentMenu to call ParentMenu.AccessoryValueChanged.</p>
</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="OwnedByParent"></a><code>property <b>OwnedByParent</b>: boolean
read FOwnedByParent write FOwnedByParent default true;</code></td>
</tr>
<tr><td colspan="2">
<p>
Should this accessory be freed when <a class="normal" href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a> using it is freed. Useful to set this to <code>False</code> when you want to share one <a class="normal" href="CastleOnScreenMenu.TMenuAccessory.html">TMenuAccessory</a> across more than one <a class="normal" href="CastleOnScreenMenu.TCastleOnScreenMenu.html">TCastleOnScreenMenu</a>.</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&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>
|
