~ubuntu-branches/ubuntu/utopic/castle-game-engine/utopic

« back to all changes in this revision

Viewing changes to doc/pasdoc/html/CastleControls.TCastlePanel.html

  • Committer: Package Import Robot
  • Author(s): Abou Al Montacir
  • Date: 2013-04-27 18:06:40 UTC
  • Revision ID: package-import@ubuntu.com-20130427180640-eink4nmwzuivez1c
Tags: upstream-4.0.1
ImportĀ upstreamĀ versionĀ 4.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
 
2
<html>
 
3
<head>
 
4
<title>Castle Game Engine: CastleControls: Class TCastlePanel</title>
 
5
<meta name="generator" content="PasDoc 0.12.1">
 
6
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
 
7
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
 
8
</head>
 
9
<body>
 
10
<table class="container"><tr><td class="navigation">
 
11
<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">
 
12
<a name="TCastlePanel"></a><h1 class="cio">Class TCastlePanel</h1>
 
13
<table class="sections wide_list">
 
14
<tr>
 
15
<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>
 
16
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
 
17
<p class="unitlink">
 
18
<a  href="CastleControls.html">CastleControls</a></p>
 
19
<h2 class="declaration">Declaration</h2>
 
20
<p class="declaration">
 
21
<code>type TCastlePanel = class(<a class="normal" href="CastleUIControls.TUIControlPos.html">TUIControlPos</a>)</code></p>
 
22
<h2 class="description">Description</h2>
 
23
<p>
 
24
Panel inside OpenGL context. Use as a comfortable (and with matching colors) background for other controls like buttons and such. May be used as a toolbar, together with appropriately placed <a class="normal" href="CastleControls.TCastleButton.html">TCastleButton</a> over it.</p>
 
25
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
 
26
<ul class="hierarchy"><li class="ancestor">TComponent</li>
 
27
<li class="ancestor"><a class="normal" href="CastleUIControls.TInputListener.html">TInputListener</a></li>
 
28
<li class="ancestor"><a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a></li>
 
29
<li class="ancestor"><a class="normal" href="CastleUIControls.TUIControlPos.html">TUIControlPos</a></li>
 
30
<li class="thisitem">TCastlePanel</li></ul><h2 class="overview">Overview</h2>
 
31
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
 
32
<table class="summary wide_list">
 
33
<tr class="list">
 
34
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
35
<td class="itemcode"><code>constructor <b><a  href="CastleControls.TCastlePanel.html#Create">Create</a></b>(AOwner: TComponent); override;</code></td>
 
36
</tr>
 
37
<tr class="list2">
 
38
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
39
<td class="itemcode"><code>destructor <b><a  href="CastleControls.TCastlePanel.html#Destroy">Destroy</a></b>; override;</code></td>
 
40
</tr>
 
41
<tr class="list">
 
42
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
43
<td class="itemcode"><code>function <b><a  href="CastleControls.TCastlePanel.html#DrawStyle">DrawStyle</a></b>: <a  href="CastleUIControls.html#TUIControlDrawStyle">TUIControlDrawStyle</a>; override;</code></td>
 
44
</tr>
 
45
<tr class="list2">
 
46
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
47
<td class="itemcode"><code>procedure <b><a  href="CastleControls.TCastlePanel.html#Draw">Draw</a></b>; override;</code></td>
 
48
</tr>
 
49
<tr class="list">
 
50
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
51
<td class="itemcode"><code>function <b><a  href="CastleControls.TCastlePanel.html#PositionInside">PositionInside</a></b>(const X, Y: Integer): boolean; override;</code></td>
 
52
</tr>
 
53
<tr class="list2">
 
54
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
55
<td class="itemcode"><code>procedure <b><a  href="CastleControls.TCastlePanel.html#Idle">Idle</a></b>(const CompSpeed: Single; const HandleMouseAndKeys: boolean; var LetOthersHandleMouseAndKeys: boolean); override;</code></td>
 
56
</tr>
 
57
<tr class="list">
 
58
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
59
<td class="itemcode"><code>class function <b><a  href="CastleControls.TCastlePanel.html#SeparatorSize">SeparatorSize</a></b>: Cardinal;</code></td>
 
60
</tr>
 
61
</table>
 
62
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
 
63
<table class="summary wide_list">
 
64
<tr class="list">
 
65
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
66
<td class="itemcode"><code>property <b><a  href="CastleControls.TCastlePanel.html#VerticalSeparators">VerticalSeparators</a></b>: <a  href="CastleUtils.TCardinalList.html">TCardinalList</a> read FVerticalSeparators;</code></td>
 
67
</tr>
 
68
<tr class="list2">
 
69
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
 
70
<td class="itemcode"><code>property <b><a  href="CastleControls.TCastlePanel.html#Width">Width</a></b>: Cardinal read FWidth write SetWidth default 0;</code></td>
 
71
</tr>
 
72
<tr class="list">
 
73
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
 
74
<td class="itemcode"><code>property <b><a  href="CastleControls.TCastlePanel.html#Height">Height</a></b>: Cardinal read FHeight write SetHeight default 0;</code></td>
 
75
</tr>
 
76
<tr class="list2">
 
77
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
 
78
<td class="itemcode"><code>property <b><a  href="CastleControls.TCastlePanel.html#Opacity">Opacity</a></b>: Single read FOpacity write FOpacity default 1.0;</code></td>
 
79
</tr>
 
80
</table>
 
81
<h2 class="description">Description</h2>
 
82
<h3 class="detail">Methods</h3>
 
83
<table class="detail wide_list">
 
84
<tr class="list">
 
85
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
86
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(AOwner: TComponent); override;</code></td>
 
87
</tr>
 
88
<tr><td colspan="2">
 
89
&nbsp;</td></tr>
 
90
</table>
 
91
<table class="detail wide_list">
 
92
<tr class="list">
 
93
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
94
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
 
95
</tr>
 
96
<tr><td colspan="2">
 
97
&nbsp;</td></tr>
 
98
</table>
 
99
<table class="detail wide_list">
 
100
<tr class="list">
 
101
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
102
<td class="itemcode"><a name="DrawStyle"></a><code>function <b>DrawStyle</b>: <a  href="CastleUIControls.html#TUIControlDrawStyle">TUIControlDrawStyle</a>; override;</code></td>
 
103
</tr>
 
104
<tr><td colspan="2">
 
105
&nbsp;</td></tr>
 
106
</table>
 
107
<table class="detail wide_list">
 
108
<tr class="list">
 
109
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
110
<td class="itemcode"><a name="Draw"></a><code>procedure <b>Draw</b>; override;</code></td>
 
111
</tr>
 
112
<tr><td colspan="2">
 
113
&nbsp;</td></tr>
 
114
</table>
 
115
<table class="detail wide_list">
 
116
<tr class="list">
 
117
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
118
<td class="itemcode"><a name="PositionInside"></a><code>function <b>PositionInside</b>(const X, Y: Integer): boolean; override;</code></td>
 
119
</tr>
 
120
<tr><td colspan="2">
 
121
&nbsp;</td></tr>
 
122
</table>
 
123
<table class="detail wide_list">
 
124
<tr class="list">
 
125
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
126
<td class="itemcode"><a name="Idle"></a><code>procedure <b>Idle</b>(const CompSpeed: Single; const HandleMouseAndKeys: boolean; var LetOthersHandleMouseAndKeys: boolean); override;</code></td>
 
127
</tr>
 
128
<tr><td colspan="2">
 
129
&nbsp;</td></tr>
 
130
</table>
 
131
<table class="detail wide_list">
 
132
<tr class="list">
 
133
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
134
<td class="itemcode"><a name="SeparatorSize"></a><code>class function <b>SeparatorSize</b>: Cardinal;</code></td>
 
135
</tr>
 
136
<tr><td colspan="2">
 
137
&nbsp;</td></tr>
 
138
</table>
 
139
<h3 class="detail">Properties</h3>
 
140
<table class="detail wide_list">
 
141
<tr class="list">
 
142
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
143
<td class="itemcode"><a name="VerticalSeparators"></a><code>property <b>VerticalSeparators</b>: <a  href="CastleUtils.TCardinalList.html">TCardinalList</a> read FVerticalSeparators;</code></td>
 
144
</tr>
 
145
<tr><td colspan="2">
 
146
<p>
 
147
Separator lines drawn on panel. Useful if you want to visually separate groups of contols (like a groups of buttons when you use this panel as a toolbar).
 
148
 
 
149
<p>Values are the horizontal positions of the separators (with respect to this panel <a class="normal" href="CastleUIControls.TUIControlPos.html#Left">Left</a>). Width of the separator is in <a class="normal" href="CastleControls.TCastlePanel.html#SeparatorSize">SeparatorSize</a>.</p>
 
150
</td></tr>
 
151
</table>
 
152
<table class="detail wide_list">
 
153
<tr class="list">
 
154
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
 
155
<td class="itemcode"><a name="Width"></a><code>property <b>Width</b>: Cardinal read FWidth write SetWidth default 0;</code></td>
 
156
</tr>
 
157
<tr><td colspan="2">
 
158
&nbsp;</td></tr>
 
159
</table>
 
160
<table class="detail wide_list">
 
161
<tr class="list">
 
162
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
 
163
<td class="itemcode"><a name="Height"></a><code>property <b>Height</b>: Cardinal read FHeight write SetHeight default 0;</code></td>
 
164
</tr>
 
165
<tr><td colspan="2">
 
166
&nbsp;</td></tr>
 
167
</table>
 
168
<table class="detail wide_list">
 
169
<tr class="list">
 
170
<td class="visibility"><a  href="legend.html"><img  src="published.gif" alt="Published" title="Published"></a></td>
 
171
<td class="itemcode"><a name="Opacity"></a><code>property <b>Opacity</b>: Single read FOpacity write FOpacity default 1.0;</code></td>
 
172
</tr>
 
173
<tr><td colspan="2">
 
174
<p>
 
175
Opacity (1 - transparency) with which control is drawn. When this is &lt; 1, we draw control with nice blending. Make sure you have some background control underneath in this case.</p>
 
176
</td></tr>
 
177
</table>
 
178
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.12.1</a> on 2013-02-04 20:26:50</em>
 
179
</span>
 
180
</td></tr></table></body></html>