File: CastleUIControls.TUIRectangularControl.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 (186 lines) | stat: -rw-r--r-- 13,730 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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<!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: CastleUIControls: Class TUIRectangularControl</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="TUIRectangularControl"></a><h1 class="cio">Class TUIRectangularControl</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="CastleUIControls.html">CastleUIControls</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TUIRectangularControl = class(<a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a>)</code></p>
<h2 class="description">Description</h2>
<p>
<a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a> that has a position and takes some rectangular space on the container.

<p>The position is controlled using the Left, Bottom fields. The rectangle where the control is visible can be queried using the <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Rect">Rect</a> virtual method.

<p>Note that each descendant has it's own definition of the size of the control. E.g. some descendants may automatically calculate the size (based on text or images or such placed within the control). Some descendants may allow to control the size explicitly using fields like Width, Height, FullSize. Some descendants may allow both approaches, switchable by property like <a class="normal" href="CastleControls.TCastleButton.html#AutoSize">TCastleButton.AutoSize</a> or <a class="normal" href="CastleControls.TCastleImageControl.html#Stretch">TCastleImageControl.Stretch</a>.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TComponent</li>
<li class="ancestor"><a class="normal" href="CastleUIControls.TInputListener.html">TInputListener</a></li>
<li class="ancestor"><a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a></li>
<li class="thisitem">TUIRectangularControl</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="CastleUIControls.TUIRectangularControl.html#DefineProperties">DefineProperties</a></b>(Filer: TFiler); 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>function <b><a  href="CastleUIControls.TUIRectangularControl.html#Rect">Rect</a></b>: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; 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="CastleUIControls.TUIRectangularControl.html#AlignHorizontal">AlignHorizontal</a></b>( const ControlPosition: <a  href="CastleUIControls.html#TPositionRelative">TPositionRelative</a> = prMiddle; const ContainerPosition: <a  href="CastleUIControls.html#TPositionRelative">TPositionRelative</a> = prMiddle; const X: Integer = 0); deprecated;</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="CastleUIControls.TUIRectangularControl.html#Align">Align</a></b>( const ControlPosition: <a  href="CastleRectangles.html#THorizontalPosition">THorizontalPosition</a>; const ContainerPosition: <a  href="CastleRectangles.html#THorizontalPosition">THorizontalPosition</a>; const X: Integer = 0);</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="CastleUIControls.TUIRectangularControl.html#AlignVertical">AlignVertical</a></b>( const ControlPosition: <a  href="CastleUIControls.html#TPositionRelative">TPositionRelative</a> = prMiddle; const ContainerPosition: <a  href="CastleUIControls.html#TPositionRelative">TPositionRelative</a> = prMiddle; const Y: Integer = 0); deprecated;</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="CastleUIControls.TUIRectangularControl.html#Align">Align</a></b>( const ControlPosition: <a  href="CastleRectangles.html#TVerticalPosition">TVerticalPosition</a>; const ContainerPosition: <a  href="CastleRectangles.html#TVerticalPosition">TVerticalPosition</a>; const Y: Integer = 0);</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="CastleUIControls.TUIRectangularControl.html#Center">Center</a></b>;</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleUIControls.TUIRectangularControl.html#Left">Left</a></b>: Integer read FLeft write SetLeft stored false default 0;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleUIControls.TUIRectangularControl.html#Bottom">Bottom</a></b>: Integer read FBottom write SetBottom default 0;</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="DefineProperties"></a><code>procedure <b>DefineProperties</b>(Filer: TFiler); 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="Rect"></a><code>function <b>Rect</b>: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Position and size of this control, assuming it <a class="normal" href="CastleUIControls.TUIControl.html#Exists">exists</a>. This must ignore the current value of the <a class="normal" href="CastleUIControls.TUIControl.html#GetExists">GetExists</a> method and <a class="normal" href="CastleUIControls.TUIControl.html#Exists">Exists</a> property, that is: the result of this function assumes that control does exist.</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="AlignHorizontal"></a><code>procedure <b>AlignHorizontal</b>( const ControlPosition: <a  href="CastleUIControls.html#TPositionRelative">TPositionRelative</a> = prMiddle; const ContainerPosition: <a  href="CastleUIControls.html#TPositionRelative">TPositionRelative</a> = prMiddle; const X: Integer = 0); deprecated;</code></td>
</tr>
<tr><td colspan="2">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Position the control with respect to the container by adjusting <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Left">Left</a>. Deprecated, use <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Align">Align</a> with <a class="normal" href="CastleRectangles.html#THorizontalPosition">THorizontalPosition</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="Align"></a><code>procedure <b>Align</b>( const ControlPosition: <a  href="CastleRectangles.html#THorizontalPosition">THorizontalPosition</a>; const ContainerPosition: <a  href="CastleRectangles.html#THorizontalPosition">THorizontalPosition</a>; const X: Integer = 0);</code></td>
</tr>
<tr><td colspan="2">
<p>
Position the control with respect to the container by adjusting <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Left">Left</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="AlignVertical"></a><code>procedure <b>AlignVertical</b>( const ControlPosition: <a  href="CastleUIControls.html#TPositionRelative">TPositionRelative</a> = prMiddle; const ContainerPosition: <a  href="CastleUIControls.html#TPositionRelative">TPositionRelative</a> = prMiddle; const Y: Integer = 0); deprecated;</code></td>
</tr>
<tr><td colspan="2">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Position the control with respect to the container by adjusting <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Bottom">Bottom</a>. Deprecated, use <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Align">Align</a> with <a class="normal" href="CastleRectangles.html#TVerticalPosition">TVerticalPosition</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="Align"></a><code>procedure <b>Align</b>( const ControlPosition: <a  href="CastleRectangles.html#TVerticalPosition">TVerticalPosition</a>; const ContainerPosition: <a  href="CastleRectangles.html#TVerticalPosition">TVerticalPosition</a>; const Y: Integer = 0);</code></td>
</tr>
<tr><td colspan="2">
<p>
Position the control with respect to the container by adjusting <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Bottom">Bottom</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="Center"></a><code>procedure <b>Center</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Center the control within the container both horizontally and vertically.</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="Left"></a><code>property <b>Left</b>: Integer read FLeft write SetLeft stored false default 0;</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="Bottom"></a><code>property <b>Bottom</b>: Integer read FBottom write SetBottom default 0;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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:12</em>
</span>
</td></tr></table></body></html>