File: CastleControls.TCastleButton.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 (526 lines) | stat: -rw-r--r-- 32,595 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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
<!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: CastleControls: Class TCastleButton</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="TCastleButton"></a><h1 class="cio">Class TCastleButton</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><a class="section" href="#PasDoc-Fields">Fields</a></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="CastleControls.html">CastleControls</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCastleButton = class(<a class="normal" href="CastleControls.TUIControlFont.html">TUIControlFont</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Button inside OpenGL context.

<p>This is <a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a> descendant, so to use it just add it to the <a class="normal" href="CastleWindow.TCastleWindowCustom.html#Controls">TCastleWindowCustom.Controls</a> or <a class="normal" href="CastleControl.TCastleControlCustom.html#Controls">TCastleControlCustom.Controls</a> list. You will also usually want to adjust position (TCastleButton.Left, TCastleButton.Bottom), <a class="normal" href="CastleControls.TCastleButton.html#Caption">TCastleButton.Caption</a>, and assign <a class="normal" href="CastleControls.TCastleButton.html#OnClick">TCastleButton.OnClick</a> (or ovevrride <a class="normal" href="CastleControls.TCastleButton.html#DoClick">TCastleButton.DoClick</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="ancestor"><a class="normal" href="CastleUIControls.TUIRectangularControl.html">TUIRectangularControl</a></li>
<li class="ancestor"><a class="normal" href="CastleControls.TUIControlFont.html">TUIControlFont</a></li>
<li class="thisitem">TCastleButton</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Fields"></a><h3 class="summary">Fields</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>internal const <b><a  href="CastleControls.TCastleButton.html#DefaultImageMargin">DefaultImageMargin</a></b> = 10;</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>internal const <b><a  href="CastleControls.TCastleButton.html#DefaultPaddingHorizontal">DefaultPaddingHorizontal</a></b> = 10;</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>internal const <b><a  href="CastleControls.TCastleButton.html#DefaultPaddingVertical">DefaultPaddingVertical</a></b> = 10;</code></td>
</tr>
</table>
<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="CastleControls.TCastleButton.html#FontChanged">FontChanged</a></b>; 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>constructor <b><a  href="CastleControls.TCastleButton.html#Create">Create</a></b>(AOwner: TComponent); override;</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>destructor <b><a  href="CastleControls.TCastleButton.html#Destroy">Destroy</a></b>; 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="CastleControls.TCastleButton.html#Render">Render</a></b>; override;</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="CastleControls.TCastleButton.html#PositionInside">PositionInside</a></b>(const Position: <a  href="CastleVectors.html#TVector2Single">TVector2Single</a>): boolean; 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="CastleControls.TCastleButton.html#GLContextOpen">GLContextOpen</a></b>; override;</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="CastleControls.TCastleButton.html#GLContextClose">GLContextClose</a></b>; 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="CastleControls.TCastleButton.html#Press">Press</a></b>(const Event: <a  href="CastleKeysMouse.TInputPressRelease.html">TInputPressRelease</a>): boolean; override;</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="CastleControls.TCastleButton.html#Release">Release</a></b>(const Event: <a  href="CastleKeysMouse.TInputPressRelease.html">TInputPressRelease</a>): boolean; 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="CastleControls.TCastleButton.html#Rect">Rect</a></b>: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; override;</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="CastleControls.TCastleButton.html#DoClick">DoClick</a></b>; 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="CastleControls.TCastleButton.html#SetFocused">SetFocused</a></b>(const Value: boolean); 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="CastleControls.TCastleButton.html#Image">Image</a></b>: <a  href="CastleImages.TCastleImage.html">TCastleImage</a> read FImage write SetImage;</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>property <b><a  href="CastleControls.TCastleButton.html#OwnsImage">OwnsImage</a></b>: boolean read FOwnsImage write FOwnsImage default false;</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>property <b><a  href="CastleControls.TCastleButton.html#MinImageWidth">MinImageWidth</a></b>: Cardinal read FMinImageWidth write FMinImageWidth default 0;</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>property <b><a  href="CastleControls.TCastleButton.html#MinImageHeight">MinImageHeight</a></b>: Cardinal read FMinImageHeight write FMinImageHeight default 0;</code></td>
</tr>
<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="CastleControls.TCastleButton.html#Width">Width</a></b>: Cardinal read FWidth write SetWidth 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="CastleControls.TCastleButton.html#Height">Height</a></b>: Cardinal read FHeight write SetHeight default 0;</code></td>
</tr>
<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="CastleControls.TCastleButton.html#PaddingHorizontal">PaddingHorizontal</a></b>: Cardinal
      read FPaddingHorizontal write FPaddingHorizontal default <a  href="CastleControls.TCastleButton.html#DefaultPaddingHorizontal">DefaultPaddingHorizontal</a>;</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="CastleControls.TCastleButton.html#PaddingVertical">PaddingVertical</a></b>: Cardinal
      read FPaddingVertical write FPaddingVertical default <a  href="CastleControls.TCastleButton.html#DefaultPaddingVertical">DefaultPaddingVertical</a>;</code></td>
</tr>
<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="CastleControls.TCastleButton.html#AutoSize">AutoSize</a></b>: boolean read FAutoSize write SetAutoSize default true;</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="CastleControls.TCastleButton.html#AutoSizeWidth">AutoSizeWidth</a></b>: boolean read FAutoSizeWidth write SetAutoSizeWidth default true;</code></td>
</tr>
<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="CastleControls.TCastleButton.html#AutoSizeHeight">AutoSizeHeight</a></b>: boolean read FAutoSizeHeight write SetAutoSizeHeight default true;</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="CastleControls.TCastleButton.html#MinWidth">MinWidth</a></b>: Cardinal read FMinWidth write SetMinWidth default 0;</code></td>
</tr>
<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="CastleControls.TCastleButton.html#MinHeight">MinHeight</a></b>: Cardinal read FMinHeight write SetMinHeight 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="CastleControls.TCastleButton.html#OnClick">OnClick</a></b>: TNotifyEvent read FOnClick write FOnClick;</code></td>
</tr>
<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="CastleControls.TCastleButton.html#Caption">Caption</a></b>: string read FCaption write SetCaption;</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="CastleControls.TCastleButton.html#Toggle">Toggle</a></b>: boolean read FToggle write FToggle default false;</code></td>
</tr>
<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="CastleControls.TCastleButton.html#Pressed">Pressed</a></b>: boolean read FPressed write SetPressed default false;</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="CastleControls.TCastleButton.html#ImageLayout">ImageLayout</a></b>: <a  href="CastleControls.html#TCastleButtonImageLayout">TCastleButtonImageLayout</a>
      read FImageLayout write SetImageLayout default ilLeft;</code></td>
</tr>
<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="CastleControls.TCastleButton.html#ImageAlphaTest">ImageAlphaTest</a></b>: boolean
      read FImageAlphaTest write FImageAlphaTest default false;</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="CastleControls.TCastleButton.html#ImageMargin">ImageMargin</a></b>: Cardinal read FImageMargin write SetImageMargin
      default <a  href="CastleControls.TCastleButton.html#DefaultImageMargin">DefaultImageMargin</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</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="DefaultImageMargin"></a><code>internal const <b>DefaultImageMargin</b> = 10;</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="DefaultPaddingHorizontal"></a><code>internal const <b>DefaultPaddingHorizontal</b> = 10;</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="DefaultPaddingVertical"></a><code>internal const <b>DefaultPaddingVertical</b> = 10;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<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="FontChanged"></a><code>procedure <b>FontChanged</b>; 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="Create"></a><code>constructor <b>Create</b>(AOwner: TComponent); 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="Destroy"></a><code>destructor <b>Destroy</b>; 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="Render"></a><code>procedure <b>Render</b>; 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="PositionInside"></a><code>function <b>PositionInside</b>(const Position: <a  href="CastleVectors.html#TVector2Single">TVector2Single</a>): boolean; 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="GLContextOpen"></a><code>procedure <b>GLContextOpen</b>; 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="GLContextClose"></a><code>procedure <b>GLContextClose</b>; 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="Press"></a><code>function <b>Press</b>(const Event: <a  href="CastleKeysMouse.TInputPressRelease.html">TInputPressRelease</a>): boolean; 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="Release"></a><code>function <b>Release</b>(const Event: <a  href="CastleKeysMouse.TInputPressRelease.html">TInputPressRelease</a>): boolean; 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>; 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="DoClick"></a><code>procedure <b>DoClick</b>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Called when user clicks the button. In this class, simply calls <a class="normal" href="CastleControls.TCastleButton.html#OnClick">OnClick</a> callback.</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="SetFocused"></a><code>procedure <b>SetFocused</b>(const Value: boolean); 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="Image"></a><code>property <b>Image</b>: <a  href="CastleImages.TCastleImage.html">TCastleImage</a> read FImage write SetImage;</code></td>
</tr>
<tr><td colspan="2">
<p>
Set this to non-nil to display an image on the button.</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="OwnsImage"></a><code>property <b>OwnsImage</b>: boolean read FOwnsImage write FOwnsImage default false;</code></td>
</tr>
<tr><td colspan="2">
<p>
Should we free the <a class="normal" href="CastleControls.TCastleButton.html#Image">Image</a> when you set another one or at destructor.</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="MinImageWidth"></a><code>property <b>MinImageWidth</b>: Cardinal read FMinImageWidth write FMinImageWidth default 0;</code></td>
</tr>
<tr><td colspan="2">
<p>
Auto-size routines (see <a class="normal" href="CastleControls.TCastleButton.html#AutoSize">AutoSize</a>) may treat the image like always having at least these minimal sizes. Even if the <a class="normal" href="CastleControls.TCastleButton.html#Image">Image</a> is empty (<code>Nil</code>). This is useful when you have a row of buttons (typical for toolbar), and you want them to have the same height, and their captions to be displayed at the same level, regardless of their images sizes.</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="MinImageHeight"></a><code>property <b>MinImageHeight</b>: Cardinal read FMinImageHeight write FMinImageHeight 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="Width"></a><code>property <b>Width</b>: Cardinal read FWidth write SetWidth 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="Height"></a><code>property <b>Height</b>: Cardinal read FHeight write SetHeight 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="PaddingHorizontal"></a><code>property <b>PaddingHorizontal</b>: Cardinal
      read FPaddingHorizontal write FPaddingHorizontal default <a  href="CastleControls.TCastleButton.html#DefaultPaddingHorizontal">DefaultPaddingHorizontal</a>;</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="PaddingVertical"></a><code>property <b>PaddingVertical</b>: Cardinal
      read FPaddingVertical write FPaddingVertical default <a  href="CastleControls.TCastleButton.html#DefaultPaddingVertical">DefaultPaddingVertical</a>;</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="AutoSize"></a><code>property <b>AutoSize</b>: boolean read FAutoSize write SetAutoSize default true;</code></td>
</tr>
<tr><td colspan="2">
<p>
When <code>AutoSize</code> is <code>True</code> (the default) then Width/Height are automatically adjusted when you change the Caption and <a class="normal" href="CastleControls.TCastleButton.html#Image">Image</a>. They take into account Caption width/height with current font, <a class="normal" href="CastleControls.TCastleButton.html#Image">Image</a> width/height, and add some margin to make it look good.

<p>To be more precise, Width is adjusted only when <code>AutoSize</code> and <a class="normal" href="CastleControls.TCastleButton.html#AutoSizeWidth">AutoSizeWidth</a>. And Height is adjusted only when <code>AutoSize</code> and <a class="normal" href="CastleControls.TCastleButton.html#AutoSizeHeight">AutoSizeHeight</a>. This way you can turn off auto-sizing in only one dimension if you want (and when you don't need such flexibility, leave <a class="normal" href="CastleControls.TCastleButton.html#AutoSizeWidth">AutoSizeWidth</a> = <a class="normal" href="CastleControls.TCastleButton.html#AutoSizeHeight">AutoSizeHeight</a> = <code>True</code> and control both by simple <code>AutoSize</code>).

<p>Note that this adjustment happens only when OpenGL context is initialized (because only then we actually know the font used). So don't depend on Width/Height values calculated correctly before OpenGL context is ready.</p>
</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="AutoSizeWidth"></a><code>property <b>AutoSizeWidth</b>: boolean read FAutoSizeWidth write SetAutoSizeWidth default true;</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="AutoSizeHeight"></a><code>property <b>AutoSizeHeight</b>: boolean read FAutoSizeHeight write SetAutoSizeHeight default true;</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="MinWidth"></a><code>property <b>MinWidth</b>: Cardinal read FMinWidth write SetMinWidth default 0;</code></td>
</tr>
<tr><td colspan="2">
<p>
When auto-size is in effect, these properties may force a minimal width/height of the button. This is useful if you want to use auto-size (to make sure that the content fits inside), but you want to force filling some space.</p>
</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="MinHeight"></a><code>property <b>MinHeight</b>: Cardinal read FMinHeight write SetMinHeight 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="OnClick"></a><code>property <b>OnClick</b>: TNotifyEvent read FOnClick write FOnClick;</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="Caption"></a><code>property <b>Caption</b>: string read FCaption write SetCaption;</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="Toggle"></a><code>property <b>Toggle</b>: boolean read FToggle write FToggle default false;</code></td>
</tr>
<tr><td colspan="2">
<p>
Can the button be permanently pressed. Good for making a button behave like a checkbox, that is indicate a boolean state. When <a class="normal" href="CastleControls.TCastleButton.html#Toggle">Toggle</a> is <code>True</code>, you can set the <a class="normal" href="CastleControls.TCastleButton.html#Pressed">Pressed</a> property, and the clicks are visualized a little differently.</p>
</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="Pressed"></a><code>property <b>Pressed</b>: boolean read FPressed write SetPressed default false;</code></td>
</tr>
<tr><td colspan="2">
<p>
Is the button pressed down. If <a class="normal" href="CastleControls.TCastleButton.html#Toggle">Toggle</a> is <code>True</code>, you can read and write this property to set the pressed state.

<p>When not <a class="normal" href="CastleControls.TCastleButton.html#Toggle">Toggle</a>, this property isn't really useful to you. The pressed state is automatically managed then to visualize user clicks. In this case, you can read this property, but you cannot reliably set it.</p>
</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="ImageLayout"></a><code>property <b>ImageLayout</b>: <a  href="CastleControls.html#TCastleButtonImageLayout">TCastleButtonImageLayout</a>
      read FImageLayout write SetImageLayout default ilLeft;</code></td>
</tr>
<tr><td colspan="2">
<p>
Where the <a class="normal" href="CastleControls.TCastleButton.html#Image">Image</a> is drawn on a button.</p>
</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="ImageAlphaTest"></a><code>property <b>ImageAlphaTest</b>: boolean
      read FImageAlphaTest write FImageAlphaTest default false;</code></td>
</tr>
<tr><td colspan="2">
<p>
If the image has alpha channel, should we render with alpha test (simple yes/no transparency) or alpha blending (smootly mix with background using full transparency).</p>
</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="ImageMargin"></a><code>property <b>ImageMargin</b>: Cardinal read FImageMargin write SetImageMargin
      default <a  href="CastleControls.TCastleButton.html#DefaultImageMargin">DefaultImageMargin</a>;</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:09</em>
</span>
</td></tr></table></body></html>