← Back to branch summary

~ubuntu-branches/ubuntu/saucy/lazarus/saucy

« back to all changes in this revision

Viewing changes to .pc/spell_errors.diff/docs/xml/lcl/controls.xml

  • Committer: Package Import Robot
  • Author(s): Paul Gevers, Abou Al Montacir, Bart Martens, Paul Gevers
  • Date: 2013-06-08 14:12:17 UTC
  • mfrom: (1.1.9)
  • Revision ID: package-import@ubuntu.com-20130608141217-7k0cy9id8ifcnutc
Tags: 1.0.8+dfsg-1
http://bugs.debian.org/708695
[ Abou Al Montacir ]
* New upstream major release and multiple maintenace release offering many
  fixes and new features marking a new milestone for the Lazarus development
  and its stability level.
  - The detailed list of changes can be found here:
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_release_notes
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_fixes_branch
* LCL changes:
  - LCL is now a normal package.
      + Platform independent parts of the LCL are now in the package LCLBase
      + LCL is automatically recompiled when switching the target platform,
        unless pre-compiled binaries for this target are already installed.
      + No impact on existing projects.
      + Linker options needed by LCL are no more added to projects that do
        not use the LCL package.
  - Minor changes in LCL basic classes behaviour
      + TCustomForm.Create raises an exception if a form resource is not
        found.
      + TNotebook and TPage: a new implementation of these classes was added.
      + TDBNavigator: It is now possible to have focusable buttons by setting
        Options = [navFocusableButtons] and TabStop = True, useful for
        accessibility and for devices with neither mouse nor touch screen.
      + Names of TControlBorderSpacing.GetSideSpace and GetSpace were swapped
        and are now consistent. GetSideSpace = Around + GetSpace.
      + TForm.WindowState=wsFullscreen was added
      + TCanvas.TextFitInfo was added to calculate how many characters will
        fit into a specified Width. Useful for word-wrapping calculations.
      + TControl.GetColorResolvingParent and
        TControl.GetRGBColorResolvingParent were added, simplifying the work
        to obtain the final color of the control while resolving clDefault
        and the ParentColor.
      + LCLIntf.GetTextExtentExPoint now has a good default implementation
        which works in any platform not providing a specific implementation.
        However, Widgetset specific implementation is better, when available.
      + TTabControl was reorganized. Now it has the correct class hierarchy
        and inherits from TCustomTabControl as it should.
  - New unit in the LCL:
      + lazdialogs.pas: adds non-native versions of various native dialogs,
        for example TLazOpenDialog, TLazSaveDialog, TLazSelectDirectoryDialog.
        It is used by widgetsets which either do not have a native dialog, or
        do not wish to use it because it is limited. These dialogs can also be
        used by user applications directly.
      + lazdeviceapis.pas: offers an interface to more hardware devices such
        as the accelerometer, GPS, etc. See LazDeviceAPIs
      + lazcanvas.pas: provides a TFPImageCanvas descendent implementing
        drawing in a LCL-compatible way, but 100% in Pascal.
      + lazregions.pas. LazRegions is a wholly Pascal implementation of
        regions for canvas clipping, event clipping, finding in which control
        of a region tree one an event should reach, for drawing polygons, etc.
      + customdrawncontrols.pas, customdrawndrawers.pas,
        customdrawn_common.pas, customdrawn_android.pas and
        customdrawn_winxp.pas: are the Lazarus Custom Drawn Controls -controls
        which imitate the standard LCL ones, but with the difference that they
        are non-native and support skinning.
  - New APIs added to the LCL to improve support of accessibility software
    such as screen readers.
* IDE changes:
  - Many improvments.
  - The detailed list of changes can be found here:
    http://wiki.lazarus.freepascal.org/New_IDE_features_since#v1.0_.282012-08-29.29
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_release_notes#IDE_Changes
* Debugger / Editor changes:
  - Added pascal sources and breakpoints to the disassembler
  - Added threads dialog.
* Components changes:
  - TAChart: many fixes and new features
  - CodeTool: support Delphi style generics and new syntax extensions.
  - AggPas: removed to honor free licencing. (Closes: Bug#708695)
[Bart Martens]
* New debian/watch file fixing issues with upstream RC release.
[Abou Al Montacir]
* Avoid changing files in .pc hidden directory, these are used by quilt for
  internal purpose and could lead to surprises during build.
[Paul Gevers]
* Updated get-orig-source target and it compinion script orig-tar.sh so that they
  repack the source file, allowing bug 708695 to be fixed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/spell_errors.diff/docs/xml/lcl/controls.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<fpdoc-descriptions>
 
3
  <package name="LCL">
 
4
    <!--
 
5
  ====================================================================
 
6
    Controls
 
7
  ====================================================================
 
8
-->
 
9
    <module name="Controls">
 
10
      <short>This unit contains basic classes for visual controls.</short>
 
11
      <descr/>
 
12
      <!-- unresolved type reference Visibility: default -->
 
13
      <element name="Classes">
 
14
        <short/>
 
15
        <descr/>
 
16
        <seealso/>
 
17
      </element>
 
18
      <!-- unresolved type reference Visibility: default -->
 
19
      <element name="SysUtils">
 
20
        <short/>
 
21
        <descr/>
 
22
        <seealso/>
 
23
      </element>
 
24
      <!-- unresolved type reference Visibility: default -->
 
25
      <element name="TypInfo">
 
26
        <short/>
 
27
        <descr/>
 
28
        <seealso/>
 
29
      </element>
 
30
      <!-- unresolved type reference Visibility: default -->
 
31
      <element name="LCLStrConsts">
 
32
        <short/>
 
33
        <descr/>
 
34
        <seealso/>
 
35
      </element>
 
36
      <!-- unresolved type reference Visibility: default -->
 
37
      <element name="LCLType">
 
38
        <short/>
 
39
        <descr/>
 
40
        <seealso/>
 
41
      </element>
 
42
      <!-- unresolved type reference Visibility: default -->
 
43
      <element name="LCLProc">
 
44
        <short/>
 
45
        <descr/>
 
46
        <seealso/>
 
47
      </element>
 
48
      <!-- unresolved type reference Visibility: default -->
 
49
      <element name="GraphType">
 
50
        <short/>
 
51
        <descr/>
 
52
        <seealso/>
 
53
      </element>
 
54
      <!-- unresolved type reference Visibility: default -->
 
55
      <element name="Graphics">
 
56
        <short/>
 
57
        <descr/>
 
58
        <seealso/>
 
59
      </element>
 
60
      <!-- unresolved type reference Visibility: default -->
 
61
      <element name="LMessages">
 
62
        <short/>
 
63
        <descr/>
 
64
        <seealso/>
 
65
      </element>
 
66
      <!-- unresolved type reference Visibility: default -->
 
67
      <element name="LCLIntf">
 
68
        <short/>
 
69
        <descr/>
 
70
        <seealso/>
 
71
      </element>
 
72
      <!-- unresolved type reference Visibility: default -->
 
73
      <element name="InterfaceBase">
 
74
        <short/>
 
75
        <descr/>
 
76
        <seealso/>
 
77
      </element>
 
78
      <!-- unresolved type reference Visibility: default -->
 
79
      <element name="ImgList">
 
80
        <short/>
 
81
        <descr/>
 
82
        <seealso/>
 
83
      </element>
 
84
      <!-- unresolved type reference Visibility: default -->
 
85
      <element name="PropertyStorage">
 
86
        <short/>
 
87
        <descr/>
 
88
        <seealso/>
 
89
      </element>
 
90
      <!-- unresolved type reference Visibility: default -->
 
91
      <element name="Menus">
 
92
        <short/>
 
93
        <descr/>
 
94
        <seealso/>
 
95
      </element>
 
96
      <!-- unresolved type reference Visibility: default -->
 
97
      <element name="ActnList">
 
98
        <short/>
 
99
        <descr/>
 
100
        <seealso/>
 
101
      </element>
 
102
      <!-- unresolved type reference Visibility: default -->
 
103
      <element name="LCLClasses">
 
104
        <short/>
 
105
        <descr/>
 
106
        <seealso/>
 
107
      </element>
 
108
      <!-- constant Visibility: default -->
 
109
      <element name="mrNone">
 
110
        <short>Modal dialog left with None button.</short>
 
111
      </element>
 
112
      <!-- constant Visibility: default -->
 
113
      <element name="mrOK">
 
114
        <short>Modal dialog left with OK button.</short>
 
115
      </element>
 
116
      <!-- constant Visibility: default -->
 
117
      <element name="mrCancel">
 
118
        <short>Modal dialog left with Cancel button.</short>
 
119
      </element>
 
120
      <!-- constant Visibility: default -->
 
121
      <element name="mrAbort">
 
122
        <short>Modal dialog aborted.</short>
 
123
      </element>
 
124
      <!-- constant Visibility: default -->
 
125
      <element name="mrRetry">
 
126
        <short>Modal dialog left with Retry button.</short>
 
127
      </element>
 
128
      <!-- constant Visibility: default -->
 
129
      <element name="mrIgnore">
 
130
        <short>Modal dialog left with Ignore button.</short>
 
131
      </element>
 
132
      <!-- constant Visibility: default -->
 
133
      <element name="mrYes">
 
134
        <short>Modal dialog left with Yes button.</short>
 
135
      </element>
 
136
      <!-- constant Visibility: default -->
 
137
      <element name="mrNo">
 
138
        <short>Modal dialog left with No button.</short>
 
139
      </element>
 
140
      <!-- constant Visibility: default -->
 
141
      <element name="mrAll">
 
142
        <short>Modal dialog left with All button.</short>
 
143
      </element>
 
144
      <!-- constant Visibility: default -->
 
145
      <element name="mrNoToAll">
 
146
        <short>Modal dialog left with NoToAll button.</short>
 
147
      </element>
 
148
      <!-- constant Visibility: default -->
 
149
      <element name="mrYesToAll">
 
150
        <short>Modal dialog left with YesToAll button.</short>
 
151
      </element>
 
152
      <!-- constant Visibility: default -->
 
153
      <element name="mrClose">
 
154
        <short>Modal dialog left with Close button.</short>
 
155
      </element>
 
156
      <!-- constant Visibility: default -->
 
157
      <element name="mrLast">
 
158
        <short>Last (highest) value of modal results.</short>
 
159
      </element>
 
160
      <!-- "class of" type Visibility: default -->
 
161
      <element name="TWinControlClass">
 
162
        <short>
 
163
          <var>TWinControlClass</var> - class of 
 
164
          
 
165
          <var>TWinControl</var>
 
166
        </short>
 
167
        <descr/>
 
168
        <seealso/>
 
169
      </element>
 
170
      <!-- "class of" type Visibility: default -->
 
171
      <element name="TControlClass">
 
172
        <short>
 
173
          <var>TControlClass</var> - class of 
 
174
          
 
175
          <var>TControl</var>
 
176
        </short>
 
177
        <descr/>
 
178
        <seealso/>
 
179
      </element>
 
180
      <!-- "type" alias type Visibility: default -->
 
181
      <element name="TDate">
 
182
        <short>Date expressed in the encoded <link id="TDateTime"/> type.</short>
 
183
        <descr>Variables of this type contain both date and time, but only one of these should be used.
 
184
        </descr>
 
185
      </element>
 
186
      <!-- "type" alias type Visibility: default -->
 
187
      <element link="TDate" name="TTime">
 
188
        <short>Time of day expressed in the encoded encoded <link id="TDateTime"/> type</short>
 
189
      </element>
 
190
      <!-- record type Visibility: default -->
 
191
      <element name="TCMMouseWheel">
 
192
        <short>Parameters of a CMMouseWheel message.</short>
 
193
        <descr>
 
194
          <pre>Details held include:
 
195
          the Message associated with the wheel;
 
196
          the shift state (ie whether Shift, Alt, Control etc keys have been pressed);
 
197
          mouse position and the message Result.</pre>
 
198
        </descr>
 
199
        <seealso/>
 
200
      </element>
 
201
      <!-- variable Visibility: default -->
 
202
      <element name="TCMMouseWheel.MSg">
 
203
        <short>The exact Message ID (WM_MOUSEWHEEL?).</short>
 
204
        <descr/>
 
205
        <seealso/>
 
206
      </element>
 
207
      <!-- variable Visibility: default -->
 
208
      <element name="TCMMouseWheel.ShiftState">
 
209
        <short>State of modifier keys and mouse buttons.</short>
 
210
        <descr/>
 
211
        <seealso/>
 
212
      </element>
 
213
      <!-- variable Visibility: default -->
 
214
      <element name="TCMMouseWheel.Unused">
 
215
        <short>inserted for alignment only.</short>
 
216
        <descr/>
 
217
        <seealso/>
 
218
      </element>
 
219
      <element name="TCMMouseWheel.WheelData">
 
220
        <short>How many notches the wheel has been turned; negative for turned backwards.</short>
 
221
        <descr/>
 
222
        <seealso/>
 
223
      </element>
 
224
      <element name="TCMMouseWheel.Pos">
 
225
        <short>Mouse position.</short>
 
226
      </element>
 
227
      <element name="TCMMouseWheel.XPos">
 
228
        <short>Mouse X position.</short>
 
229
      </element>
 
230
      <element name="TCMMouseWheel.YPos">
 
231
        <short>Mouse Y position.</short>
 
232
      </element>
 
233
      <element name="TCMMouseWheel.Result">
 
234
        <short>Zero indicates that the message was handled.</short>
 
235
      </element>
 
236
      <!-- alias type Visibility: default -->
 
237
      <element link="TLMNCHitTest" name="TCMHitTest"/>
 
238
      <element link="TLMMouse" name="TCMDesignHitTest"/>
 
239
      <!-- record type Visibility: default -->
 
240
      <element name="TCMControlChange">
 
241
        <short/>
 
242
        <descr/>
 
243
        <seealso/>
 
244
      <notes><note>?</note>
 
245
        </notes>
 
246
      </element>
 
247
      <element name="TCMControlChange.Msg">
 
248
        <short/>
 
249
        <descr/>
 
250
        <seealso/>
 
251
      </element>
 
252
      <element name="TCMControlChange.Control">
 
253
        <short/>
 
254
        <descr/>
 
255
        <seealso/>
 
256
      </element>
 
257
      <element name="TCMControlChange.Inserting">
 
258
        <short/>
 
259
        <descr/>
 
260
        <seealso/>
 
261
      </element>
 
262
      <element name="TCMControlChange.Result">
 
263
        <short/>
 
264
        <descr/>
 
265
        <seealso/>
 
266
      </element>
 
267
      <!-- record type Visibility: default -->
 
268
      <element name="TCMControlListChange">
 
269
        <short/>
 
270
        <descr/>
 
271
        <seealso/>
 
272
      <notes><note>?</note>
 
273
        </notes>
 
274
      </element>
 
275
      <element name="TCMControlListChange.Msg">
 
276
        <short/>
 
277
      </element>
 
278
      <element name="TCMControlListChange.Control">
 
279
        <short/>
 
280
        <descr/>
 
281
        <seealso/>
 
282
      </element>
 
283
      <element name="TCMControlListChange.Inserting">
 
284
        <short/>
 
285
        <descr/>
 
286
        <seealso/>
 
287
      </element>
 
288
      <element name="TCMControlListChange.Result">
 
289
        <short/>
 
290
        <descr/>
 
291
        <seealso/>
 
292
      </element>
 
293
      <!-- alias type Visibility: default -->
 
294
      <element link="TLMKey" name="TCMDialogChar">
 
295
        <short/>
 
296
      <notes><note>?</note>
 
297
        </notes>
 
298
      </element>
 
299
      <!-- alias type Visibility: default -->
 
300
      <element link="TLMKey" name="TCMDialogKey">
 
301
        <short/>
 
302
      <notes><note>?</note>
 
303
        </notes>
 
304
      </element>
 
305
      <!-- alias type Visibility: default -->
 
306
      <element link="TLMEnter" name="TCMEnter">
 
307
        <short/>
 
308
      <notes><note>?</note>
 
309
        </notes>
 
310
      </element>
 
311
      <!-- alias type Visibility: default -->
 
312
      <element link="TLMExit" name="TCMExit">
 
313
        <short/>
 
314
      <notes><note>?</note>
 
315
        </notes>
 
316
      </element>
 
317
      <!-- record type Visibility: default -->
 
318
      <element name="TCMCancelMode">
 
319
        <short/>
 
320
      <notes><note>?</note>
 
321
        </notes>
 
322
      </element>
 
323
      <element name="TCMCancelMode.Msg">
 
324
        <short/>
 
325
      </element>
 
326
      <element name="TCMCancelMode.Unused">
 
327
        <short/>
 
328
      </element>
 
329
      <element name="TCMCancelMode.Sender">
 
330
        <short/>
 
331
      </element>
 
332
      <element name="TCMCancelMode.Result">
 
333
        <short/>
 
334
      </element>
 
335
      <!-- record type Visibility: default -->
 
336
      <element name="TCMChildKey">
 
337
        <short/>
 
338
        <descr/>
 
339
        <seealso/>
 
340
      <notes><note>?</note>
 
341
        </notes>
 
342
      </element>
 
343
      <element name="TCMChildKey.Msg">
 
344
        <short/>
 
345
      </element>
 
346
      <element name="TCMChildKey.Unused"/>
 
347
      <element name="TCMChildKey.CharCode">
 
348
        <short>VK_XXX constants for TLMKeyDown/Up, ASCII for TLMChar.</short>
 
349
      <notes><note>?</note>
 
350
        </notes>
 
351
      </element>
 
352
      <element name="TCMChildKey.Sender">
 
353
        <short/>
 
354
      </element>
 
355
      <element name="TCMChildKey.Result">
 
356
        <short/>
 
357
      </element>
 
358
      <!-- enumeration type Visibility: default -->
 
359
      <element name="TAlign">
 
360
        <short>Alignment options for a control, within its Parent control.</short>
 
361
        <descr>
 
362
          <p>A control can be aligned as:</p>
 
363
          <dl>
 
364
            <dt>alNone</dt>
 
365
            <dd>fixed position and extent</dd>
 
366
            <dt>alTop</dt>
 
367
            <dd>stacked at top, full width</dd>
 
368
            <dt>alBottom</dt>
 
369
            <dd>stacked at bottom, full width</dd>
 
370
            <dt>alLeft</dt>
 
371
            <dd>stacked at left, full height</dd>
 
372
            <dt>alRight</dt>
 
373
            <dd>stacked at right, full height</dd>
 
374
            <dt>alClient</dt>
 
375
            <dd>filling entire remaining client area</dd>
 
376
            <dt>alCustom</dt>
 
377
            <dd>other alignment, in drag-dock: notebook</dd>
 
378
          </dl>
 
379
          <p>At most one control can have alClient alignment.</p>
 
380
          <p>The order of multiple controls of the same (stackable) alignment is determined by their Left or Top coordinate.</p>
 
381
          <p>The precedence of conflicting alignment requests (e.g. one at top, one at right) is resolved</p>
 
382
        </descr>
 
383
      <notes><note>how???</note><note>which provisions exist for alCustom implementation?</note>
 
384
        </notes>
 
385
      </element>
 
386
      <element name="TAlign.alNone">
 
387
        <short>Control has fixed size and position</short>
 
388
      </element>
 
389
      <element name="TAlign.alTop">
 
390
        <short>Control stacked at top, full width.</short>
 
391
      </element>
 
392
      <element name="TAlign.alBottom">
 
393
        <short>Control stacked at bottom, full width.</short>
 
394
      </element>
 
395
      <element name="TAlign.alLeft">
 
396
        <short>Control stacked at left, full height.</short>
 
397
      </element>
 
398
      <element name="TAlign.alRight">
 
399
        <short>Control stacked at right, full height.</short>
 
400
      </element>
 
401
      <element name="TAlign.alClient">
 
402
        <short>Control fills remaining client area.</short>
 
403
      </element>
 
404
      <element name="TAlign.alCustom">
 
405
        <short>Control has special alignment.</short>
 
406
        <descr/>
 
407
      <notes><note>aligned how?</note>
 
408
        </notes>
 
409
      </element>
 
410
      <!-- set type Visibility: default -->
 
411
      <element link="TAlign" name="TAlignSet">
 
412
        <short>Set of alignment options.</short>
 
413
      </element>
 
414
      <!-- enumeration type Visibility: default -->
 
415
      <element name="TAnchorKind">
 
416
        <short>The control side to be anchored.</short>
 
417
        <descr>With asrCenter the sides mean horizontal or vertical alignment, of the control's center.
 
418
        </descr>
 
419
      </element>
 
420
      <element name="TAnchorKind.akTop">
 
421
        <short>Top side (or center vertically).</short>
 
422
      </element>
 
423
      <element name="TAnchorKind.akLeft">
 
424
        <short>Left side (or center horizonally).</short>
 
425
      </element>
 
426
      <element name="TAnchorKind.akRight">
 
427
        <short>Right side (or center horizontally).</short>
 
428
      </element>
 
429
      <element name="TAnchorKind.akBottom">
 
430
        <short>Bottom side (or center vertically).</short>
 
431
      </element>
 
432
      <!-- set type Visibility: default -->
 
433
      <element link="TAnchorKind" name="TAnchors"/>
 
434
      <!-- constant Visibility: default -->
 
435
      <element name="AnchorAlign">
 
436
        <short/>
 
437
        <descr/>
 
438
        <seealso/>
 
439
      <notes><note>?</note>
 
440
        </notes>
 
441
      </element>
 
442
      <!-- constant Visibility: default -->
 
443
      <element link="TAnchorKind" name="MainAlignAnchor">
 
444
        <short/>
 
445
        <descr/>
 
446
        <seealso/>
 
447
      <notes><note>?</note>
 
448
        </notes>
 
449
      </element>
 
450
      <!-- constant Visibility: default -->
 
451
      <element link="TAnchorKind" name="OppositeAnchor">
 
452
        <short/>
 
453
        <descr/>
 
454
        <seealso/>
 
455
      <notes><note>?</note>
 
456
        </notes>
 
457
      </element>
 
458
      <!-- constant Visibility: default -->
 
459
      <element link="TAnchorKind" name="ClockwiseAnchor">
 
460
        <short/>
 
461
        <descr/>
 
462
        <seealso/>
 
463
      <notes><note>?</note>
 
464
        </notes>
 
465
      </element>
 
466
      <!-- constant Visibility: default -->
 
467
      <element name="DefaultSideForAnchorKind">
 
468
        <short/>
 
469
        <descr/>
 
470
        <seealso/>
 
471
      <notes><note>?</note>
 
472
        </notes>
 
473
      </element>
 
474
      <!-- constant Visibility: default -->
 
475
      <element name="AnchorReferenceSide">
 
476
        <short/>
 
477
        <descr/>
 
478
        <seealso/>
 
479
      <notes><note>?</note>
 
480
        </notes>
 
481
      </element>
 
482
      <!-- constant Visibility: default -->
 
483
      <element name="AlignNames">
 
484
        <short>Array of names for the <link id="TAlign"/> elements.</short>
 
485
        <descr>
 
486
          <remark>The names include the 'al' prefix, e.g. alNone.</remark>
 
487
        </descr>
 
488
      </element>
 
489
      <!-- constant Visibility: default -->
 
490
      <element link="TAnchorKind" name="AnchorNames">
 
491
        <short>Names for the TAnchorKind elements.</short>
 
492
        <descr/>
 
493
        <seealso/>
 
494
      </element>
 
495
      <!-- enumeration type Visibility: default -->
 
496
      <element name="TAnchorSideReference">
 
497
        <short>The side of another control, to which this control's side is anchored.</short>
 
498
        <descr/>
 
499
        <seealso/>
 
500
      </element>
 
501
      <element name="TAnchorSideReference.asrTop">
 
502
        <short>Anchor to the top side.</short>
 
503
      </element>
 
504
      <element name="TAnchorSideReference.asrBottom">
 
505
        <short>Anchor to the bottom side.</short>
 
506
      </element>
 
507
      <element name="TAnchorSideReference.asrCenter">
 
508
        <short>Anchor to the center of the other control.</short>
 
509
      </element>
 
510
      <!-- constant Visibility: default -->
 
511
      <element name="asrLeft">
 
512
        <short>Anchor to the left side (=asrTop).</short>
 
513
        <descr/>
 
514
        <seealso/>
 
515
      </element>
 
516
      <!-- constant Visibility: default -->
 
517
      <element name="asrRight">
 
518
        <short>Anchor to the right side (=asrBottom).</short>
 
519
        <descr/>
 
520
        <seealso/>
 
521
      </element>
 
522
      <!-- alias type Visibility: default -->
 
523
      <element name="TCaption">
 
524
        <short>A string type for the caption of a control: may be translated</short>
 
525
      </element>
 
526
      <!-- enumeration type Visibility: default -->
 
527
      <element name="TFormStyle">
 
528
        <short>Defines special form behaviour.</short>
 
529
        <descr/>
 
530
        <seealso/>
 
531
      </element>
 
532
      <element name="TFormStyle.fsNormal">
 
533
        <short>An ordinary (overlapping) form.</short>
 
534
      </element>
 
535
      <element name="TFormStyle.fsMDIChild">
 
536
        <short>The form is an MDI child.</short>
 
537
      </element>
 
538
      <element name="TFormStyle.fsMDIForm">
 
539
        <short>The form is an MDI parent form, containing MDI child forms.</short>
 
540
      </element>
 
541
      <element name="TFormStyle.fsStayOnTop">
 
542
        <short>The form is in the foreground, on top of all other application forms.</short>
 
543
      </element>
 
544
      <element name="TFormStyle.fsSplash">
 
545
        <short>A splash form.</short>
 
546
      <notes><note>meaning what?</note>
 
547
        </notes>
 
548
      </element>
 
549
      <element name="TFormStyle.fsSystemStayOnTop">
 
550
        <short>The form stays system-wide on top.</short>
 
551
      <notes><note>?</note>
 
552
        </notes>
 
553
      </element>
 
554
      <!-- constant Visibility: default -->
 
555
      <element name="fsAllStayOnTop">
 
556
        <short>Set of form styles, which make a form stay on top.</short>
 
557
        <descr/>
 
558
        <seealso>
 
559
          <link id="TFormStyle"/>
 
560
        </seealso>
 
561
      </element>
 
562
      <!-- constant Visibility: default -->
 
563
      <element name="fsAllNonSystemStayOnTop">
 
564
        <short>Set of form styles, except those which make a form stay on top of all other forms of the system</short>
 
565
        <seealso>
 
566
          <link id="TFormStyle"/>
 
567
        </seealso>
 
568
      <notes><note>not system-wide?</note>
 
569
        </notes>
 
570
      </element>
 
571
      <!-- enumeration type Visibility: default -->
 
572
      <element name="TFormBorderStyle">
 
573
        <short>Style of a form's border.</short>
 
574
        <descr/>
 
575
        <seealso/>
 
576
      </element>
 
577
      <element name="TFormBorderStyle.bsNone">
 
578
        <short>No border at all.</short>
 
579
      </element>
 
580
      <element name="TFormBorderStyle.bsSingle">
 
581
        <short>Single line border, the form cannot be resized.</short>
 
582
      </element>
 
583
      <element name="TFormBorderStyle.bsSizeable">
 
584
        <short>The form can be resized (standard).</short>
 
585
      </element>
 
586
      <element name="TFormBorderStyle.bsDialog">
 
587
        <short>The form is a dialog, cannot be resized.</short>
 
588
      <notes><note>legacy?</note>
 
589
        </notes>
 
590
      </element>
 
591
      <element name="TFormBorderStyle.bsToolWindow">
 
592
        <short>Single line border, small caption, not resizeable.</short>
 
593
      </element>
 
594
      <element name="TFormBorderStyle.bsSizeToolWin">
 
595
        <short>Small caption, form can be resized.</short>
 
596
      </element>
 
597
      <!-- range type Visibility: default -->
 
598
      <element link="TFormBorderStyle" name="TBorderStyle">
 
599
        <short>Possible types of borders (with or without border).</short>
 
600
        <seealso/>
 
601
      <notes><note>used where?</note>
 
602
        </notes>
 
603
      </element>
 
604
      <!-- alias type Visibility: default -->
 
605
      <element link="TFormBorderStyle" name="TControlBorderStyle">
 
606
        <short>Possible types of control borders (with or without border).</short>
 
607
        <descr>A subset of TFormBorderStyle, listing only the styles available to a control that is not a form.</descr>
 
608
        <seealso/>
 
609
      <notes><note>used where?</note>
 
610
        </notes>
 
611
      </element>
 
612
      <!-- enumeration type Visibility: default -->
 
613
      <element name="TControlRoleForForm">
 
614
        <short>Possible default actions on special keys.</short>
 
615
        <descr/>
 
616
        <seealso/>
 
617
      </element>
 
618
      <element name="TControlRoleForForm.crffDefault">
 
619
        <short>This control is notified when the user presses Return.</short>
 
620
      </element>
 
621
      <element name="TControlRoleForForm.crffCancel">
 
622
        <short>This control is notified when the user presses Escape.</short>
 
623
      </element>
 
624
      <!-- set type Visibility: default -->
 
625
      <element link="TControlRoleForForm" name="TControlRolesForForm"/>
 
626
      <!-- alias type Visibility: default -->
 
627
      <element link="TGraphicsBevelCut" name="TBevelCut"/>
 
628
      <!-- enumeration type Visibility: default -->
 
629
      <element name="TMouseButton">
 
630
        <short>Enumeration of recognized mouse buttons.</short>
 
631
        <descr>
 
632
          <p>These are <b>logical</b> buttons, left and right physical buttons can be swapped for left handed users.</p>
 
633
        </descr>
 
634
      </element>
 
635
      <element name="TMouseButton.mbLeft">
 
636
        <short>Represents the left mouse button. It might be physically the right button if the system is configured to act like that, for example for a left handled person.</short>
 
637
      </element>
 
638
      <element name="TMouseButton.mbRight">
 
639
        <short>Represents the right mouse button. It might be physically the left button if the system is configured to act like that, for example for a left handled person.</short>
 
640
      </element>
 
641
      <element name="TMouseButton.mbMiddle">
 
642
        <short>Represents the middle mouse button.</short>
 
643
      </element>
 
644
      <element name="TMouseButton.mbExtra1">
 
645
        <short>Represents the first extra mouse button.</short>
 
646
      </element>
 
647
      <element name="TMouseButton.mbExtra2">
 
648
        <short>Represents the second extra mouse button.</short>
 
649
      </element>
 
650
      <!-- range type Visibility: default -->
 
651
      <element name="TCursor">
 
652
        <short>
 
653
          <var>TCursor</var> - integer type defining range of values for cursor shapes.</short>
 
654
        <descr>
 
655
          <p>Allowed values are:</p>
 
656
          <pre>Standard cursors
 
657
  crDefault     = TCursor(0);   //current cursor unchanged
 
658
  crNone        = TCursor(-1);  //hide cursor
 
659
  crArrow       = TCursor(-2);  //normal cursor
 
660
  crCross       = TCursor(-3);  //graphics cursor, for pixel or rectangle selection
 
661
  crIBeam       = TCursor(-4);  //text cursor, for setting insertion point
 
662
Sizing cursors
 
663
  crSize        = TCursor(-22);
 
664
  crSizeAll     = TCursor(-22);
 
665
  crSizeNESW    = TCursor(-6); // diagonal north east - south west
 
666
  crSizeNS      = TCursor(-7);
 
667
  crSizeNWSE    = TCursor(-8);
 
668
  crSizeWE      = TCursor(-9);
 
669
  crSizeNW      = TCursor(-23);
 
670
  crSizeN       = TCursor(-24);
 
671
  crSizeNE      = TCursor(-25);
 
672
  crSizeW       = TCursor(-26);
 
673
  crSizeE       = TCursor(-27);
 
674
  crSizeSW      = TCursor(-28);
 
675
  crSizeS       = TCursor(-29);
 
676
  crSizeSE      = TCursor(-30);
 
677
DragDrop cursors
 
678
  crDrag        = TCursor(-12); //dragging, drop allowed
 
679
  crNoDrop      = TCursor(-13); //dragging, drop disallowed/rejected
 
680
  crMultiDrag   = TCursor(-16); //dragging multiple items
 
681
  crNo          = TCursor(-18);
 
682
Splitter cursors
 
683
  crHSplit      = TCursor(-14);
 
684
  crVSplit      = TCursor(-15);
 
685
More cursors
 
686
  crUpArrow     = TCursor(-10);
 
687
  crHourGlass   = TCursor(-11); //busy
 
688
  crSQLWait     = TCursor(-17);
 
689
  crAppStart    = TCursor(-19);
 
690
  crHelp        = TCursor(-20);
 
691
  crHandPoint   = TCursor(-21);
 
692
</pre>
 
693
        </descr>
 
694
      </element>
 
695
      <element name="crHigh">
 
696
        <short>Highest defined cursor constant (0).</short>
 
697
      </element>
 
698
      <element name="crDefault">
 
699
        <short>Indicates that the default cursor from the system should be utilized</short>
 
700
      </element>
 
701
      <element name="crNone">
 
702
        <short>Indicates that the cursor should be invisible</short>
 
703
      </element>
 
704
      <element name="crArrow">
 
705
        <short>The Arrow cursor, which is the most common and the default one in most cases</short>
 
706
      </element>
 
707
      <element name="crCross">
 
708
        <short>A cursor utilized for graphics, for pixel or rectangle selection, often in the shape of a cross</short>
 
709
      </element>
 
710
      <element name="crIBeam">
 
711
        <short>A text cursor, for setting insertion point. Often used in text editors</short>
 
712
      </element>
 
713
      <element name="crSize">
 
714
        <short>A generic sizing cursor, to indicate that here one may drag to resize something. Is the same as crSizeAll.</short>
 
715
      </element>
 
716
      <element name="crSizeNESW">
 
717
        <short>A cursor for resizing which runs diagonally from NorthEast to SouthWest (-6)</short>
 
718
      </element>
 
719
      <element name="crSizeNS">
 
720
        <short>A cursor for resizing which cursor runs from North to South (-7)</short>
 
721
      </element>
 
722
      <element name="crSizeNWSE">
 
723
        <short>A cursor for resizing which cursor runs from NorthWest to SouthEast</short>
 
724
      </element>
 
725
      <element name="crSizeWE">
 
726
        <short>A cursor for resizing which has an arrow with two points, one to the left and another to the right, to indicate resizing possibility in both directions.</short>
 
727
      </element>
 
728
      <element name="crSizeNW">
 
729
        <short>A cursor for resizing which has an arrow pointing to the left-top corner, to indicate resizing possibility in this direction</short>
 
730
      </element>
 
731
      <element name="crSizeN">
 
732
        <short>A cursor for resizing which has an arrow pointing upwards, to indicate resizing possibility in this direction</short>
 
733
      </element>
 
734
      <element name="crSizeNE">
 
735
        <short>A cursor for resizing which has an arrow pointing to the right-top corner, to indicate resizing possibility in this direction</short>
 
736
      </element>
 
737
      <element name="crSizeW">
 
738
        <short>A cursor for resizing which has an arrow pointing to the left, to indicate resizing possibility in this direction</short>
 
739
      </element>
 
740
      <element name="crSizeE">
 
741
        <short>A cursor for resizing which has an arrow pointing to the right, to indicate resizing possibility in this direction</short>
 
742
      </element>
 
743
      <element name="crSizeSW">
 
744
        <short>A cursor for resizing which has an arrow pointing to the left-bottom corner, to indicate resizing possibility in this direction</short>
 
745
      </element>
 
746
      <element name="crSizeS">
 
747
        <short>A cursor for resizing which has an arrow pointing downwards, to indicate resizing possibility in this direction</short>
 
748
      </element>
 
749
      <element name="crSizeSE">
 
750
        <short>A cursor for resizing which has an arrow pointing to the right-bottom corner, to indicate resizing possibility in this direction</short>
 
751
      </element>
 
752
      <element name="crUpArrow">
 
753
        <short>Up Arrow cursor constant (-10)</short>
 
754
      </element>
 
755
      <element name="crHourGlass">
 
756
        <short>Busy cursor constant, utilized to indicate that one should wait while an action is done</short>
 
757
      </element>
 
758
      <element name="crDrag">
 
759
        <short>A cursor to indicate that one can drop a dragged item in this area</short>
 
760
      </element>
 
761
      <element name="crNoDrop">
 
762
        <short>A cursor to indicate that one cannot drop a dragged item in this area</short>
 
763
      </element>
 
764
      <element name="crHSplit">
 
765
        <short>Horizontal Splitter cursor constant (-14)</short>
 
766
      </element>
 
767
      <element name="crVSplit">
 
768
        <short>Vertical Split cursor constant (-15)</short>
 
769
      </element>
 
770
      <element name="crMultiDrag">
 
771
        <short>Multiple Object dragging cursor constant (-16)</short>
 
772
      </element>
 
773
      <element name="crSQLWait">
 
774
        <short>Waiting for SQL cursor constant (-17)</short>
 
775
      </element>
 
776
      <element name="crNo">
 
777
        <short>Shows a negative sign. See also <link id="crNoDrop"/>.
 
778
        </short>
 
779
      </element>
 
780
      <element name="crAppStart">
 
781
        <short>Application starting cursor.</short>
 
782
      <notes><note>?</note>
 
783
        </notes>
 
784
      </element>
 
785
      <element name="crHelp">
 
786
        <short>"What's This" Help cursor constant (-20)</short>
 
787
      </element>
 
788
      <element name="crHandPoint">
 
789
        <short>Pointing hand cursor constant (-21)</short>
 
790
      </element>
 
791
      <element name="crSizeAll">
 
792
        <short>All Directions sizing cursor constant (-22)</short>
 
793
      </element>
 
794
      <element name="crLow">
 
795
        <short>Lowest defined cursor constant (-30).</short>
 
796
      </element>
 
797
      <!-- procedure type Visibility: default -->
 
798
      <element name="TWndMethod">
 
799
        <short>Method type for WindowProc handlers.</short>
 
800
        <descr/>
 
801
        <seealso/>
 
802
      </element>
 
803
      <element name="TWndMethod.TheMessage">
 
804
        <short/>
 
805
      </element>
 
806
      <!-- enumeration type Visibility: default -->
 
807
      <element name="TControlStyleType">
 
808
        <short>TControlStyleType - enumerated type describing features of the Control</short>
 
809
      </element>
 
810
      <element name="TControlStyleType.csAcceptsControls">
 
811
        <short>Indicates that one can add child controls to this control in the form designer.</short>
 
812
      </element>
 
813
      <element name="TControlStyleType.csCaptureMouse">
 
814
        <short/>
 
815
      <notes><note>?</note>
 
816
        </notes>
 
817
      </element>
 
818
      <element name="TControlStyleType.csDesignInteractive">
 
819
        <short>wants mouse events in design mode</short>
 
820
      </element>
 
821
      <element name="TControlStyleType.csClickEvents">
 
822
        <short/>
 
823
      <notes><note>?</note>
 
824
        </notes>
 
825
      </element>
 
826
      <element name="TControlStyleType.csFramed">
 
827
        <short/>
 
828
      <notes><note>?</note>
 
829
        </notes>
 
830
      </element>
 
831
      <element name="TControlStyleType.csSetCaption">
 
832
        <short>As long as Name=Text, changing the Name will set the Caption.</short>
 
833
        <descr>When for example a button's Name and Caption have the value 'Button1' and the Name is changed to 'Button2' then the Caption is changed as well. When Name and Caption differs this flag has no effect. This flag has no effect during loading.</descr>
 
834
      </element>
 
835
      <element name="TControlStyleType.csOpaque">
 
836
        <short/>
 
837
      <notes><note>?</note>
 
838
        </notes>
 
839
      </element>
 
840
      <element name="TControlStyleType.csDoubleClicks">
 
841
        <short>Indicates that the control understands mouse double clicks</short>
 
842
      </element>
 
843
      <element name="TControlStyleType.csTripleClicks">
 
844
        <short>Indicates that the control understands mouse triple clicks</short>
 
845
      </element>
 
846
      <element name="TControlStyleType.csQuadClicks">
 
847
        <short>Indicates that the control understands mouse quadruple clicks</short>
 
848
      </element>
 
849
      <element name="TControlStyleType.csFixedWidth">
 
850
        <short>Indicates that the control cannot change its width</short>
 
851
      </element>
 
852
      <element name="TControlStyleType.csFixedHeight">
 
853
        <short>Indicates that the control cannot change its height (e.g. combobox)</short>
 
854
      </element>
 
855
      <element name="TControlStyleType.csNoDesignVisible">
 
856
        <short>Indicates that the control is invisible in the form designer</short>
 
857
      </element>
 
858
      <element name="TControlStyleType.csReplicatable">
 
859
        <short/>
 
860
      <notes><note>?</note>
 
861
        </notes>
 
862
      </element>
 
863
      <element name="TControlStyleType.csNoStdEvents">
 
864
        <short/>
 
865
      <notes><note>?</note>
 
866
        </notes>
 
867
      </element>
 
868
      <element name="TControlStyleType.csDisplayDragImage">
 
869
        <short>display images from dragimagelist during drag operation over control</short>
 
870
      </element>
 
871
      <element name="TControlStyleType.csReflector">
 
872
        <short/>
 
873
      <notes><note>?</note>
 
874
        </notes>
 
875
      </element>
 
876
      <element name="TControlStyleType.csActionClient">
 
877
        <short/>
 
878
      <notes><note>?</note>
 
879
        </notes>
 
880
      </element>
 
881
      <element name="TControlStyleType.csMenuEvents">
 
882
        <short/>
 
883
      <notes><note>?</note>
 
884
        </notes>
 
885
      </element>
 
886
      <element name="TControlStyleType.csNoFocus">
 
887
        <short>Indicates that the control cannot receive focus</short>
 
888
      <notes><note>?</note>
 
889
        </notes>
 
890
      </element>
 
891
      <element name="TControlStyleType.csNeedsBorderPaint">
 
892
        <short>[not implemented]</short>
 
893
      </element>
 
894
      <element name="TControlStyleType.csParentBackground">
 
895
        <short>[not implemented]</short>
 
896
      </element>
 
897
      <element name="TControlStyleType.csDesignNoSmoothResize">
 
898
        <short>no WYSIWYG resizing in designer</short>
 
899
      </element>
 
900
      <element name="TControlStyleType.csDesignFixedBounds">
 
901
        <short>control can not be moved nor resized in designer</short>
 
902
      </element>
 
903
      <element name="TControlStyleType.csHasDefaultAction">
 
904
        <short>control implements useful ExecuteDefaultAction</short>
 
905
      </element>
 
906
      <element name="TControlStyleType.csHasCancelAction">
 
907
        <short>control implements useful ExecuteCancelAction</short>
 
908
      </element>
 
909
      <element name="TControlStyleType.csNoDesignSelectable">
 
910
        <short>control can not be selected at design time</short>
 
911
      </element>
 
912
      <element name="TControlStyleType.csOwnedChildrenNotSelectable">
 
913
        <short>child controls owned by this control are NOT selectable in the designer</short>
 
914
      </element>
 
915
      <element name="TControlStyleType.csAutoSize0x0">
 
916
        <short>if the preferred size is 0x0 then control is shrinked to 0x0</short>
 
917
      </element>
 
918
      <element name="TControlStyleType.csAutoSizeKeepChildLeft">
 
919
        <short>when AutoSize=true do not move children horizontally</short>
 
920
      </element>
 
921
      <element name="TControlStyleType.csAutoSizeKeepChildTop">
 
922
        <short>when AutoSize=true do not move children vertically</short>
 
923
      </element>
 
924
      <element name="TControlStyleType.csRequiresKeyboardInput">
 
925
        <short>Indicates that a control requires keyboard input to be utilized by the user. This information is utilized in Android and other platforms so that the virtual keyboard is activated when the control receives focus and the device has no hardware keyboard</short>
 
926
      </element>
 
927
      <!-- set type Visibility: default -->
 
928
      <element link="TControlStyleType" name="TControlStyle">
 
929
        <short>Set of control styles.</short>
 
930
      </element>
 
931
      <!-- constant Visibility: default -->
 
932
      <element name="csMultiClicks">
 
933
        <short>Set of styles which require/provide multiple clicks on a control.</short>
 
934
      </element>
 
935
      <!-- enumeration type Visibility: default -->
 
936
      <element name="TControlStateType">
 
937
        <short>State flags of a Control</short>
 
938
        <descr>
 
939
          <p>Enumerated type comprising</p>
 
940
          <pre>csLButtonDown,
 
941
    csClicked,
 
942
    csPalette,
 
943
    csReadingState,
 
944
    csAlignmentNeeded,
 
945
    csFocusing,
 
946
    csCreating,
 
947
    csPaintCopy,
 
948
    csCustomPaint,
 
949
    csDestroyingHandle,
 
950
    csDocking,
 
951
    csVisibleSetInLoading
 
952
</pre>
 
953
        </descr>
 
954
      </element>
 
955
      <element name="TControlStateType.csLButtonDown">
 
956
        <short/>
 
957
      </element>
 
958
      <element name="TControlStateType.csClicked">
 
959
        <short/>
 
960
      </element>
 
961
      <element name="TControlStateType.csPalette">
 
962
        <short/>
 
963
      </element>
 
964
      <element name="TControlStateType.csReadingState">
 
965
        <short/>
 
966
      </element>
 
967
      <element name="TControlStateType.csFocusing">
 
968
        <short/>
 
969
      </element>
 
970
      <element name="TControlStateType.csCreating">
 
971
        <short/>
 
972
      </element>
 
973
      <element name="TControlStateType.csPaintCopy">
 
974
        <short/>
 
975
      </element>
 
976
      <element name="TControlStateType.csCustomPaint">
 
977
        <short/>
 
978
      </element>
 
979
      <element name="TControlStateType.csDestroyingHandle">
 
980
        <short/>
 
981
      </element>
 
982
      <element name="TControlStateType.csDocking">
 
983
        <short/>
 
984
      </element>
 
985
      <element name="TControlStateType.csVisibleSetInLoading">
 
986
        <short/>
 
987
      </element>
 
988
      <!-- set type Visibility: default -->
 
989
      <element link="TControlStateType" name="TControlState">
 
990
        <short>Set of permissible Control states</short>
 
991
      </element>
 
992
      <!-- object Visibility: default -->
 
993
      <element name="TControlCanvas">
 
994
        <short>The base class for the canvas property of several graphic controls, such as TGraphicControl and TCustomControl</short>
 
995
        <descr>[provide usable links on the methods]</descr>
 
996
        <seealso>
 
997
          <link id="#lcl.Controls.TGraphicControl">TGraphicControl</link>
 
998
          <link id="#lcl.Controls.TCustomControl">TCustomControl</link>
 
999
          <link id="#lcl.Graphics.TCanvas">TCanvas</link>
 
1000
        </seealso>
 
1001
      </element>
 
1002
      <element name="TControlCanvas.FControl"/>
 
1003
      <element name="TControlCanvas.FDeviceContext"/>
 
1004
      <element name="TControlCanvas.FWindowHandle"/>
 
1005
      <!-- procedure Visibility: private -->
 
1006
      <element link="TControlCanvas.Control" name="TControlCanvas.SetControl"/>
 
1007
      <element name="TControlCanvas.SetControl.AControl">
 
1008
        <short/>
 
1009
      </element>
 
1010
      <!-- procedure Visibility: private -->
 
1011
      <element name="TControlCanvas.CreateFont"/>
 
1012
      <!-- procedure Visibility: protected -->
 
1013
      <element link="#LCL.Graphics.TCanvas.CreateHandle" name="TControlCanvas.CreateHandle"/>
 
1014
      <!-- function Visibility: protected -->
 
1015
      <element name="TControlCanvas.GetDefaultColor"/>
 
1016
      <element name="TControlCanvas.GetDefaultColor.Result">
 
1017
        <short/>
 
1018
      </element>
 
1019
      <element name="TControlCanvas.GetDefaultColor.ADefaultColorType">
 
1020
        <short/>
 
1021
      </element>
 
1022
      <!-- constructor Visibility: public -->
 
1023
      <element name="TControlCanvas.Create"/>
 
1024
      <!-- destructor Visibility: public -->
 
1025
      <element name="TControlCanvas.Destroy"/>
 
1026
      <!-- procedure Visibility: public -->
 
1027
      <element link="#LCL.Graphics.TCanvas.FreeHandle" name="TControlCanvas.FreeHandle"/>
 
1028
      <!-- function Visibility: public -->
 
1029
      <element name="TControlCanvas.ControlIsPainting">
 
1030
        <short/>
 
1031
        <descr/>
 
1032
        <errors/>
 
1033
        <seealso/>
 
1034
      <notes><note>?</note>
 
1035
        </notes>
 
1036
      </element>
 
1037
      <element name="TControlCanvas.ControlIsPainting.Result">
 
1038
        <short/>
 
1039
      </element>
 
1040
      <!-- property Visibility: public -->
 
1041
      <element name="TControlCanvas.Control">
 
1042
        <short>The Control object for which this is the Canvas.</short>
 
1043
      </element>
 
1044
      <!-- object Visibility: default -->
 
1045
      <element name="TDragImageList">
 
1046
        <short>A list of Images used in dragging.</short>
 
1047
        <descr>
 
1048
          <p>A drag image is shown when a DragImageList is supplied at all, 
 
1049
            <b>and</b> when no accepting target is under the mouse, or the source control style includes csDisplayDragImage, or AlwaysShowDragImage is set in the DragObject.</p>
 
1050
          <p>In drag-dock operations typically no drag image is shown, since the DockRect frame already gives all required visual feedback.</p>
 
1051
          <pre>This is a vague idea of the usage of this class:
 
1052
 
 
1053
SetDragImage selects an image from the list, and defines the hotspot within this image.
 
1054
  (the hotspot typically is the offset of the mouse position to the origin of the dragged control)
 
1055
 
 
1056
BeginDrag starts dragging, the image is shown at the starting location.
 
1057
 
 
1058
DragMove moves the image.
 
1059
 
 
1060
EndDrag stops dragging, the image is removed from the screen.
 
1061
</pre>
 
1062
        </descr>
 
1063
      </element>
 
1064
      <element link="TDragImageList.DragCursor" name="TDragImageList.FDragCursor"/>
 
1065
      <element link="TDragImageList.Dragging" name="TDragImageList.FDragging"/>
 
1066
      <element link="TDragImageList.DragHotspot" name="TDragImageList.FDragHotspot"/>
 
1067
      <element name="TDragImageList.FImageIndex"/>
 
1068
      <element name="TDragImageList.FLastDragPos">
 
1069
        <short>Remember position where the image was painted.</short>
 
1070
      </element>
 
1071
      <element name="TDragImageList.FLockedWindow">
 
1072
        <short>The window whose updates are locked while dragging.
 
1073
        </short>
 
1074
      </element>
 
1075
      <element name="TDragImageList.FOldCursor"/>
 
1076
      <!-- procedure Visibility: private -->
 
1077
      <element link="TDragImageList.DragCursor" name="TDragImageList.SetDragCursor"/>
 
1078
      <element name="TDragImageList.SetDragCursor.AValue">
 
1079
        <short/>
 
1080
      </element>
 
1081
      <!-- class procedure Visibility: default -->
 
1082
      <element name="TDragImageList.WSRegisterClass"/>
 
1083
      <!-- procedure Visibility: protected -->
 
1084
      <element link="#LCL.ImgList.TCustomImageList.Initialize" name="TDragImageList.Initialize"/>
 
1085
      <!-- function Visibility: public -->
 
1086
      <element name="TDragImageList.BeginDrag">
 
1087
        <short>Start dragging an image; returns True if successful.</short>
 
1088
        <descr>Locks window updates, remembers the current cursor shape and sets the new shape.
 
1089
        </descr>
 
1090
        <errors/>
 
1091
        <seealso/>
 
1092
      <notes><note>?</note>
 
1093
        </notes>
 
1094
      </element>
 
1095
      <element name="TDragImageList.BeginDrag.Result">
 
1096
        <short>True if successful.</short>
 
1097
      </element>
 
1098
      <element name="TDragImageList.BeginDrag.Window">
 
1099
        <short>The associated window.</short>
 
1100
      </element>
 
1101
      <element name="TDragImageList.BeginDrag.X">
 
1102
        <short>The mouse position.</short>
 
1103
      <notes><note>?</note>
 
1104
        </notes>
 
1105
      </element>
 
1106
      <element name="TDragImageList.BeginDrag.Y">
 
1107
        <short>The mouse position.</short>
 
1108
      <notes><note>?</note>
 
1109
        </notes>
 
1110
      </element>
 
1111
      <!-- function Visibility: public -->
 
1112
      <element name="TDragImageList.DragLock">
 
1113
        <short>Show drag image during drag operation.</short>
 
1114
        <descr/>
 
1115
        <errors/>
 
1116
        <seealso/>
 
1117
      <notes><note>and lock updates of Window?</note>
 
1118
        </notes>
 
1119
      </element>
 
1120
      <element name="TDragImageList.DragLock.Result">
 
1121
        <short>True if Dragging and image shown.</short>
 
1122
      </element>
 
1123
      <element name="TDragImageList.DragLock.Window">
 
1124
        <short>The locked window.</short>
 
1125
      </element>
 
1126
      <element name="TDragImageList.DragLock.XPos">
 
1127
        <short>The mouse position.</short>
 
1128
      <notes><note>?</note>
 
1129
        </notes>
 
1130
      </element>
 
1131
      <element name="TDragImageList.DragLock.YPos">
 
1132
        <short>The mouse position.</short>
 
1133
      <notes><note>?</note>
 
1134
        </notes>
 
1135
      </element>
 
1136
      <!-- function Visibility: public -->
 
1137
      <element name="TDragImageList.DragMove">
 
1138
        <short>Show the image at a new location.
 
1139
        </short>
 
1140
        <descr/>
 
1141
        <errors/>
 
1142
        <seealso/>
 
1143
      </element>
 
1144
      <element name="TDragImageList.DragMove.Result">
 
1145
        <short>True if Dragging and image moved.</short>
 
1146
      </element>
 
1147
      <element name="TDragImageList.DragMove.X">
 
1148
        <short>The new mouse position.</short>
 
1149
      </element>
 
1150
      <element name="TDragImageList.DragMove.Y">
 
1151
        <short>The new mouse position.</short>
 
1152
      </element>
 
1153
      <!-- procedure Visibility: public -->
 
1154
      <element name="TDragImageList.DragUnlock">
 
1155
        <short>Hide the drag image.</short>
 
1156
        <descr/>
 
1157
        <errors/>
 
1158
        <seealso/>
 
1159
      <notes><note>and unlock window updates?</note>
 
1160
        </notes>
 
1161
      </element>
 
1162
      <!-- function Visibility: public -->
 
1163
      <element name="TDragImageList.EndDrag">
 
1164
        <short>Finish dragging of the image, restore the old cursor shape.</short>
 
1165
        <descr/>
 
1166
        <errors/>
 
1167
        <seealso/>
 
1168
      </element>
 
1169
      <element name="TDragImageList.EndDrag.Result">
 
1170
        <short>True when dragging was started before.</short>
 
1171
      </element>
 
1172
      <!-- function Visibility: public -->
 
1173
      <element link="#LCL.ImgList.TCustomImageList.GetHotSpot" name="TDragImageList.GetHotSpot"/>
 
1174
      <element name="TDragImageList.GetHotSpot.Result">
 
1175
        <short/>
 
1176
      </element>
 
1177
      <!-- procedure Visibility: public -->
 
1178
      <element name="TDragImageList.HideDragImage">
 
1179
        <short>Hide the dragged image without unlocking the window.</short>
 
1180
        <descr/>
 
1181
        <errors/>
 
1182
        <seealso/>
 
1183
      </element>
 
1184
      <!-- function Visibility: public -->
 
1185
      <element name="TDragImageList.SetDragImage">
 
1186
        <short>Set index of dragged image and hotspot.</short>
 
1187
        <descr/>
 
1188
        <errors/>
 
1189
        <seealso/>
 
1190
      </element>
 
1191
      <element name="TDragImageList.SetDragImage.Result">
 
1192
        <short>Always True</short>
 
1193
      <notes><note>?</note>
 
1194
        </notes>
 
1195
      </element>
 
1196
      <element name="TDragImageList.SetDragImage.Index">
 
1197
        <short>List index of the image to use.</short>
 
1198
      </element>
 
1199
      <element name="TDragImageList.SetDragImage.HotSpotX">
 
1200
        <short>Offset from mouse position to image position.</short>
 
1201
      </element>
 
1202
      <element name="TDragImageList.SetDragImage.HotSpotY">
 
1203
        <short>Offset from mouse position to image position.</short>
 
1204
      </element>
 
1205
      <!-- procedure Visibility: public -->
 
1206
      <element name="TDragImageList.ShowDragImage">
 
1207
        <short>Display the drag image.</short>
 
1208
        <descr/>
 
1209
        <errors/>
 
1210
        <seealso/>
 
1211
      </element>
 
1212
      <!-- property Visibility: public -->
 
1213
      <element name="TDragImageList.DragCursor">
 
1214
        <short>The cursor shape to use while dragging.</short>
 
1215
        <descr/>
 
1216
        <seealso/>
 
1217
      </element>
 
1218
      <!-- property Visibility: public -->
 
1219
      <element name="TDragImageList.DragHotspot">
 
1220
        <short>The position of the image HotSpot, i.e. the offset to the mouse position while dragging.</short>
 
1221
        <descr/>
 
1222
        <seealso/>
 
1223
      </element>
 
1224
      <!-- property Visibility: public -->
 
1225
      <element name="TDragImageList.Dragging">
 
1226
        <short>True if dragging in progress.</short>
 
1227
        <descr/>
 
1228
        <seealso/>
 
1229
      </element>
 
1230
      <!-- procedure type Visibility: default -->
 
1231
      <element name="TKeyEvent">
 
1232
        <short/>
 
1233
        <descr/>
 
1234
        <seealso/>
 
1235
      <notes><note>?</note>
 
1236
        </notes>
 
1237
      </element>
 
1238
      <element name="TKeyEvent.Sender">
 
1239
        <short/>
 
1240
      </element>
 
1241
      <element name="TKeyEvent.Key">
 
1242
        <short/>
 
1243
      </element>
 
1244
      <element name="TKeyEvent.Shift">
 
1245
        <short/>
 
1246
      </element>
 
1247
      <!-- procedure type Visibility: default -->
 
1248
      <element name="TKeyPressEvent">
 
1249
        <short/>
 
1250
        <descr/>
 
1251
        <seealso/>
 
1252
      <notes><note>?</note>
 
1253
        </notes>
 
1254
      </element>
 
1255
      <element name="TKeyPressEvent.Sender">
 
1256
        <short/>
 
1257
      </element>
 
1258
      <element name="TKeyPressEvent.Key">
 
1259
        <short/>
 
1260
      </element>
 
1261
      <!-- procedure type Visibility: default -->
 
1262
      <element name="TUTF8KeyPressEvent"/>
 
1263
      <element name="TUTF8KeyPressEvent.Sender">
 
1264
        <short/>
 
1265
      </element>
 
1266
      <element name="TUTF8KeyPressEvent.UTF8Key">
 
1267
        <short/>
 
1268
      </element>
 
1269
      <!-- procedure type Visibility: default -->
 
1270
      <element name="TMouseEvent">
 
1271
        <short/>
 
1272
        <descr/>
 
1273
        <seealso/>
 
1274
      <notes><note>?</note>
 
1275
        </notes>
 
1276
      </element>
 
1277
      <element name="TMouseEvent.Sender">
 
1278
        <short/>
 
1279
      </element>
 
1280
      <element name="TMouseEvent.Button">
 
1281
        <short/>
 
1282
      </element>
 
1283
      <element name="TMouseEvent.Shift">
 
1284
        <short/>
 
1285
      </element>
 
1286
      <element name="TMouseEvent.X">
 
1287
        <short/>
 
1288
      </element>
 
1289
      <element name="TMouseEvent.Y">
 
1290
        <short/>
 
1291
      </element>
 
1292
      <!-- procedure type Visibility: default -->
 
1293
      <element name="TMouseMoveEvent">
 
1294
        <short/>
 
1295
        <descr/>
 
1296
        <seealso/>
 
1297
      <notes><note>?</note>
 
1298
        </notes>
 
1299
      </element>
 
1300
      <element name="TMouseMoveEvent.Sender">
 
1301
        <short/>
 
1302
      </element>
 
1303
      <element name="TMouseMoveEvent.Shift">
 
1304
        <short/>
 
1305
      </element>
 
1306
      <element name="TMouseMoveEvent.X">
 
1307
        <short/>
 
1308
      </element>
 
1309
      <element name="TMouseMoveEvent.Y">
 
1310
        <short/>
 
1311
      </element>
 
1312
      <!-- procedure type Visibility: default -->
 
1313
      <element name="TMouseWheelEvent">
 
1314
        <short>Type of an OnMouseWheel event handler.</short>
 
1315
        <descr/>
 
1316
        <seealso/>
 
1317
      </element>
 
1318
      <element name="TMouseWheelEvent.Sender">
 
1319
        <short>The control under the mouse.</short>
 
1320
      </element>
 
1321
      <element name="TMouseWheelEvent.Shift">
 
1322
        <short>State of the modifier keys and mouse buttons.</short>
 
1323
      </element>
 
1324
      <element name="TMouseWheelEvent.WheelDelta">
 
1325
        <short>How many notches the wheel has been turned.</short>
 
1326
      </element>
 
1327
      <element name="TMouseWheelEvent.MousePos">
 
1328
        <short>The mouse position, in client coordinates.</short>
 
1329
      <notes><note>?</note>
 
1330
        </notes>
 
1331
      </element>
 
1332
      <element name="TMouseWheelEvent.Handled">
 
1333
        <short>Set Handled to True when the event was handled.</short>
 
1334
      </element>
 
1335
      <!-- procedure type Visibility: default -->
 
1336
      <element name="TMouseWheelUpDownEvent">
 
1337
        <short>Type of OnMouseWheelUp/Down event handlers.</short>
 
1338
        <descr/>
 
1339
        <seealso/>
 
1340
      </element>
 
1341
      <element name="TMouseWheelUpDownEvent.Sender">
 
1342
        <short>The control under the mouse.</short>
 
1343
      </element>
 
1344
      <element name="TMouseWheelUpDownEvent.Shift">
 
1345
        <short>State of the modifier keys and mouse buttons.</short>
 
1346
      </element>
 
1347
      <element name="TMouseWheelUpDownEvent.MousePos">
 
1348
        <short>The mouse position, in client coordinates.</short>
 
1349
      <notes><note>?</note>
 
1350
        </notes>
 
1351
      </element>
 
1352
      <element name="TMouseWheelUpDownEvent.Handled">
 
1353
        <short>Set Handled to True when the event was handled.</short>
 
1354
      </element>
 
1355
      <!-- enumeration type Visibility: default -->
 
1356
      <element name="TDragState">
 
1357
        <short>State changes while dragging - when mouse enters, leaves or moves over a control.</short>
 
1358
        <descr>These values are sent with drag messages, allowing the control to perform special actions while the mouse moves over it.
 
1359
        </descr>
 
1360
        <seealso/>
 
1361
      </element>
 
1362
      <element name="TDragState.dsDragEnter">
 
1363
        <short>Mouse has just entered the control.</short>
 
1364
      </element>
 
1365
      <element name="TDragState.dsDragLeave">
 
1366
        <short>Mouse has just left the control.</short>
 
1367
      </element>
 
1368
      <element name="TDragState.dsDragMove">
 
1369
        <short>Mouse is moving over the control.</short>
 
1370
      </element>
 
1371
      <!-- enumeration type Visibility: default -->
 
1372
      <element name="TDragMode">
 
1373
        <short>Indicates whether dragging can start automatically.</short>
 
1374
        <descr/>
 
1375
        <seealso/>
 
1376
      </element>
 
1377
      <element name="TDragMode.dmManual">
 
1378
        <short>Dragging can start only by explicit code.</short>
 
1379
      </element>
 
1380
      <element name="TDragMode.dmAutomatic">
 
1381
        <short>Dragging starts when the left mouse button is pressed on the control.</short>
 
1382
      </element>
 
1383
      <!-- enumeration type Visibility: default -->
 
1384
      <element name="TDragKind">
 
1385
        <short>Indicates whether the control performs drag-drop or drag-dock.</short>
 
1386
        <descr/>
 
1387
        <seealso/>
 
1388
      </element>
 
1389
      <element name="TDragKind.dkDrag">
 
1390
        <short>Control is dragged for dropping.</short>
 
1391
      </element>
 
1392
      <element name="TDragKind.dkDock">
 
1393
        <short>Control is dragged for docking.</short>
 
1394
      </element>
 
1395
      <!-- enumeration type Visibility: default -->
 
1396
      <element name="TDragOperation">
 
1397
        <short>[Delphi compatible - dropped!]</short>
 
1398
        <descr/>
 
1399
        <seealso/>
 
1400
      <notes><note>Delphi compatible - dropped!</note>
 
1401
        </notes>
 
1402
      </element>
 
1403
      <element name="TDragOperation.dopNone">
 
1404
        <short>Dragging not started.</short>
 
1405
      </element>
 
1406
      <element name="TDragOperation.dopDrag">
 
1407
        <short>Drag-drop started.</short>
 
1408
      </element>
 
1409
      <element name="TDragOperation.dopDock">
 
1410
        <short>Drag-dock started.</short>
 
1411
      </element>
 
1412
      <!-- enumeration type Visibility: default -->
 
1413
      <element name="TDragMessage">
 
1414
        <short>DragManager message types.</short>
 
1415
        <descr>
 
1416
          <p>All messages are sent to the target control, except dmDragDrop and dmDragCancel is sent to the source control.</p>
 
1417
          <pre>dmDragEnter: mouse enters control
 
1418
dmDragLeave: mouse leaves control
 
1419
dmDragMove: mouse moves over control (after dmDragEnter)
 
1420
dmDragDrop: control dropped
 
1421
dmDragCancel: dragging aborted
 
1422
dmFindTarget: find child control under the mouse
 
1423
</pre>
 
1424
        </descr>
 
1425
      </element>
 
1426
      <element name="TDragMessage.dmDragEnter">
 
1427
        <short>mouse enters control</short>
 
1428
      </element>
 
1429
      <element name="TDragMessage.dmDragLeave">
 
1430
        <short>mouse leaves control</short>
 
1431
      </element>
 
1432
      <element name="TDragMessage.dmDragMove">
 
1433
        <short>mouse moves over control (after dmDragEnter)</short>
 
1434
      </element>
 
1435
      <element name="TDragMessage.dmDragDrop">
 
1436
        <short>control dropped</short>
 
1437
      </element>
 
1438
      <element name="TDragMessage.dmDragCancel">
 
1439
        <short>dragging aborted</short>
 
1440
      </element>
 
1441
      <element name="TDragMessage.dmFindTarget">
 
1442
        <short>find possible target control under the mouse</short>
 
1443
      </element>
 
1444
      <!-- procedure type Visibility: default -->
 
1445
      <element name="TDragOverEvent">
 
1446
        <short>The type of an OnDragOver handler.</short>
 
1447
        <descr>
 
1448
          <p>An OnDragOver event is sent by a control, when an object is dragged over it.
 
1449
            The handler can specify whether a drop will be accepted or rejected.</p>
 
1450
          <remark>
 
1451
            <var>Source</var> is polymorphic, can be either the DragObject or the dragged control!
 
1452
            This depends on DragObject.AutoCreated, for no sane reason :-(
 
1453
          </remark>
 
1454
        </descr>
 
1455
        <seealso>
 
1456
          <link id="TDockOverEvent"/>
 
1457
        </seealso>
 
1458
      </element>
 
1459
      <element name="TDragOverEvent.Sender">
 
1460
        <short>The possible drop target (control).</short>
 
1461
      </element>
 
1462
      <element name="TDragOverEvent.Source">
 
1463
        <short>The object (TDragObject or TControl) being dragged.</short>
 
1464
      </element>
 
1465
      <element name="TDragOverEvent.X">
 
1466
        <short>X coordinate of the mouse on screen.</short>
 
1467
      </element>
 
1468
      <element name="TDragOverEvent.Y">
 
1469
        <short>Y coordinate of the mouse on screen.</short>
 
1470
      </element>
 
1471
      <element name="TDragOverEvent.State">
 
1472
        <short>The current DragState (entering, leaving or moving over the target).</short>
 
1473
      </element>
 
1474
      <element name="TDragOverEvent.Accept">
 
1475
        <short>Set Accept to False to reject an drop (default is True).</short>
 
1476
      </element>
 
1477
      <!-- procedure type Visibility: default -->
 
1478
      <element name="TDragDropEvent">
 
1479
        <short>The type of an OnDragDrop notification handler.</short>
 
1480
        <descr>An OnDragDrop event is generated by the target control, on the drop of a dragged object.
 
1481
        </descr>
 
1482
        <seealso>
 
1483
          <link id="TDockDropEvent"/>
 
1484
          <link id="TEndDragEvent"/>
 
1485
          <link id="TControl.OnDragDrop"/>
 
1486
        </seealso>
 
1487
      </element>
 
1488
      <element name="TDragDropEvent.Sender">
 
1489
        <short>The target control of the drop.</short>
 
1490
      </element>
 
1491
      <element link="TDragOverEvent.Source" name="TDragDropEvent.Source">
 
1492
        <short>The dragged control.</short>
 
1493
      </element>
 
1494
      <element name="TDragDropEvent.X">
 
1495
        <short>The <b>client</b> coordinates of the drop.</short>
 
1496
      </element>
 
1497
      <element name="TDragDropEvent.Y">
 
1498
        <short>The <b>client</b> coordinates of the drop.</short>
 
1499
      </element>
 
1500
      <!-- procedure type Visibility: default -->
 
1501
      <element name="TStartDragEvent">
 
1502
        <short>The type of an OnStartDrag handler.</short>
 
1503
        <descr>An OnStartDrag event is generated by a control when it shall be dragged and its DragKind is dkDrag.
 
1504
          The handler can provide a specific DragDrop object, else a standard TDragDropObjectEx is automatically created by the DragManager.
 
1505
        </descr>
 
1506
        <seealso>
 
1507
          <link id="TStartDragEvent"/>
 
1508
        </seealso>
 
1509
      </element>
 
1510
      <element name="TStartDragEvent.Sender">
 
1511
        <short>The control to be dragged.</short>
 
1512
      </element>
 
1513
      <element name="TStartDragEvent.DragObject">
 
1514
        <short>Supply your own DragObject, or leave it Nil for automatic creation.</short>
 
1515
      </element>
 
1516
      <!-- procedure type Visibility: default -->
 
1517
      <element name="TEndDragEvent">
 
1518
        <short>The type of an OnEndDrag handler.</short>
 
1519
        <descr>
 
1520
          <p>An OnEndDrag event is sent by a dragged control, when dragging is finished.
 
1521
            This happens regardless of whether the operation was drag-drop or drag-dock,
 
1522
            and whether the operation ended with a drop or was cancel'd.
 
1523
          </p>
 
1524
          <p>Check Target=Nil to distinguish between a drop and a cancel'd operation (Nil).</p>
 
1525
        </descr>
 
1526
        <seealso>
 
1527
          <link id="TDragDropEvent"/>
 
1528
          <link id="TDockDropEvent"/>
 
1529
        </seealso>
 
1530
      </element>
 
1531
      <element name="TEndDragEvent.Sender">
 
1532
        <short>The dragged control</short>
 
1533
      <notes><note>or DragObject?</note>
 
1534
        </notes>
 
1535
      </element>
 
1536
      <element name="TEndDragEvent.Target">
 
1537
        <short>The drop target (control), or Nil if cancel'd.</short>
 
1538
      </element>
 
1539
      <element link="TDragOverEvent.X" name="TEndDragEvent.X">
 
1540
        <short>The mouse coordinate, in client coordinates if dropped, else in screen coordinates.</short>
 
1541
      </element>
 
1542
      <element link="TDragOverEvent.Y" name="TEndDragEvent.Y">
 
1543
        <short>The mouse coordinate, in client coordinates if dropped, else in screen coordinates.</short>
 
1544
      </element>
 
1545
      <!-- object Visibility: default -->
 
1546
      <element name="TDragObject">
 
1547
        <short>Base class for managing drag operations and user feedback.</short>
 
1548
        <descr>
 
1549
          <p>Every dragging operation has an associated DragObject, holding references to the source and target controls, and other parameters for the customization of the visual user feedback.</p>
 
1550
          <p>A default DragObject is created automatically when a dragging operation starts, and is destroyed when the operation has ended, so that you must not take special care on it.
 
1551
            But an application can provide a customized DragObject in the <link id="TControl.OnStartDrag"/> or <link id="TControl.OnStartDock"/> handlers of the source control (being dragged).</p>
 
1552
          <remark>AutoCreated DragObjects imply different behaviour in the DragOver and DragDrop events, where the Source becomes the dragged control, while else the DragObject itself is passed as Source.
 
1553
          </remark>
 
1554
          <p>TDragObject is the ancestor of an whole tree of dragging objects, with the main branches supporting either drag-drop or drag-dock operations.
 
1555
            The type of the operation is determined from the <link id="TControl.DragKind"/> property of the source control.</p>
 
1556
          <remark>In contrast to the Delphi implementation, Lazarus has moved a couple of methods into the drag performers, so that these are no more available for customization.</remark>
 
1557
          <p>A Lazarus DragObject mainly supplies the cursor and images, used in visual user feedback.
 
1558
            Drag-drop operations typically signal acceptance of an possible drop by variations of the mouse cursor, and optionally can attach to it shapes of the dragged object(s).
 
1559
            Drag-dock operations instead show a docking rectangle, that snaps to possible target locations when the mouse moves over docksites.</p>
 
1560
          <p>[entire review DoDi 2011-09-10]</p>
 
1561
        </descr>
 
1562
        <seealso>
 
1563
          <link id="TDragControlObject"/>
 
1564
          <link id="TDragDockObject"/>
 
1565
        </seealso>
 
1566
      </element>
 
1567
      <element link="TDragObject.DragPos" name="TDragObject.FDragPos"/>
 
1568
      <element link="TDragObject.DragTarget" name="TDragObject.FDragTarget"/>
 
1569
      <element link="TDragObject.DragTargetPos" name="TDragObject.FDragTargetPos"/>
 
1570
      <element link="TDragObject.AutoFree" name="TDragObject.FAutoFree"/>
 
1571
      <element link="TDragObject.AutoCreated" name="TDragObject.FAutoCreated"/>
 
1572
      <element link="TDragObject.Dropped" name="TDragObject.FDropped"/>
 
1573
      <element link="TDragObject.AlwaysShowDragImage" name="TDragObject.FAlwaysShowDragImages"/>
 
1574
      <element link="TDragObject.Control" name="TDragObject.FControl"/>
 
1575
      <element name="TDragObject.MouseDeltaX">
 
1576
        <short>[Delphi compatible - dropped!]</short>
 
1577
      </element>
 
1578
      <element name="TDragObject.MouseDeltaY">
 
1579
        <short>[Delphi compatible - dropped!]</short>
 
1580
      </element>
 
1581
      <!-- function Visibility: private -->
 
1582
      <element name="TDragObject.Capture">
 
1583
        <short>[Delphi compatible - dropped!]</short>
 
1584
      <notes><note>Delphi compatible - dropped!</note>
 
1585
        </notes>
 
1586
      </element>
 
1587
      <element name="TDragObject.Capture.Result">
 
1588
        <short/>
 
1589
      </element>
 
1590
      <!-- procedure Visibility: protected -->
 
1591
      <element name="TDragObject.Finished">
 
1592
        <short>[Delphi compatible - dropped!]</short>
 
1593
        <descr/>
 
1594
        <errors/>
 
1595
        <seealso/>
 
1596
      <notes><note>Delphi compatible - dropped!</note>
 
1597
        </notes>
 
1598
      </element>
 
1599
      <element name="TDragObject.Finished.Target">
 
1600
        <short/>
 
1601
      </element>
 
1602
      <element name="TDragObject.Finished.X">
 
1603
        <short/>
 
1604
      </element>
 
1605
      <element name="TDragObject.Finished.Y">
 
1606
        <short/>
 
1607
      </element>
 
1608
      <element name="TDragObject.Finished.Accepted">
 
1609
        <short/>
 
1610
      </element>
 
1611
      <!-- function Visibility: protected -->
 
1612
      <element name="TDragObject.GetDragCursor">
 
1613
        <short>Returns the dragging cursor type (shape).</short>
 
1614
        <descr>In drag-drop operations the cursor signals acceptance or rejection of an drop, depending on Accepted.</descr>
 
1615
        <errors/>
 
1616
        <seealso/>
 
1617
      </element>
 
1618
      <element name="TDragObject.GetDragCursor.Result">
 
1619
        <short>The cursor to show.</short>
 
1620
      </element>
 
1621
      <element name="TDragObject.GetDragCursor.Accepted">
 
1622
        <short>Which cursor to return (rejected:crNoDrop or accepted:crDrag).</short>
 
1623
      </element>
 
1624
      <element name="TDragObject.GetDragCursor.X">
 
1625
        <short/>
 
1626
      <notes><note>?</note>
 
1627
        </notes>
 
1628
      </element>
 
1629
      <element name="TDragObject.GetDragCursor.Y">
 
1630
        <short/>
 
1631
      <notes><note>?</note>
 
1632
        </notes>
 
1633
      </element>
 
1634
      <!-- function Visibility: protected -->
 
1635
      <element name="TDragObject.GetDragImages">
 
1636
        <short>Returns a list of images for dragging.</short>
 
1637
        <descr>The returned <link id="TDragImageList"/> provides methods for the selection and display of an image, shown while dragging.
 
1638
          This implementation returns Nil, must be overridden (e.g. in TDragControlObject).
 
1639
        </descr>
 
1640
        <errors/>
 
1641
        <seealso>
 
1642
          <link id="TDragControlObject"/>
 
1643
        </seealso>
 
1644
      </element>
 
1645
      <element name="TDragObject.GetDragImages.Result">
 
1646
        <short>The ImageList to use, is Nil by default!</short>
 
1647
      </element>
 
1648
      <!-- procedure Visibility: protected -->
 
1649
      <element name="TDragObject.MouseMove">
 
1650
        <short>[Delphi compatible - dropped!]</short>
 
1651
        <descr/>
 
1652
        <errors/>
 
1653
        <seealso/>
 
1654
      <notes><note>Delphi compatible - dropped!</note>
 
1655
        </notes>
 
1656
      </element>
 
1657
      <element name="TDragObject.MouseMove.Shift">
 
1658
        <short/>
 
1659
      </element>
 
1660
      <element name="TDragObject.MouseMove.X">
 
1661
        <short/>
 
1662
      </element>
 
1663
      <element name="TDragObject.MouseMove.Y">
 
1664
        <short/>
 
1665
      </element>
 
1666
      <!-- procedure Visibility: protected -->
 
1667
      <element name="TDragObject.MouseDown">
 
1668
        <short>[Delphi compatible - dropped!]</short>
 
1669
        <descr/>
 
1670
        <errors/>
 
1671
        <seealso/>
 
1672
      <notes><note>Delphi compatible - dropped!</note>
 
1673
        </notes>
 
1674
      </element>
 
1675
      <element name="TDragObject.MouseDown.Button">
 
1676
        <short/>
 
1677
      </element>
 
1678
      <element name="TDragObject.MouseDown.Shift">
 
1679
        <short/>
 
1680
      </element>
 
1681
      <element name="TDragObject.MouseDown.X">
 
1682
        <short/>
 
1683
      </element>
 
1684
      <element name="TDragObject.MouseDown.Y">
 
1685
        <short/>
 
1686
      </element>
 
1687
      <!-- procedure Visibility: protected -->
 
1688
      <element name="TDragObject.MouseUp">
 
1689
        <short>[Delphi compatible - dropped!]</short>
 
1690
        <descr/>
 
1691
        <errors/>
 
1692
        <seealso/>
 
1693
      <notes><note>Delphi compatible - dropped!</note>
 
1694
        </notes>
 
1695
      </element>
 
1696
      <element name="TDragObject.MouseUp.Button">
 
1697
        <short/>
 
1698
      </element>
 
1699
      <element name="TDragObject.MouseUp.Shift">
 
1700
        <short/>
 
1701
      </element>
 
1702
      <element name="TDragObject.MouseUp.X">
 
1703
        <short/>
 
1704
      </element>
 
1705
      <element name="TDragObject.MouseUp.Y">
 
1706
        <short/>
 
1707
      </element>
 
1708
      <!-- procedure Visibility: protected -->
 
1709
      <element name="TDragObject.CaptureChanged">
 
1710
        <short>[Delphi compatible - dropped!]</short>
 
1711
        <descr/>
 
1712
        <errors/>
 
1713
        <seealso/>
 
1714
      <notes><note>Delphi compatible - dropped!</note>
 
1715
        </notes>
 
1716
      </element>
 
1717
      <element name="TDragObject.CaptureChanged.OldCaptureControl">
 
1718
        <short/>
 
1719
      </element>
 
1720
      <!-- procedure Visibility: protected -->
 
1721
      <element name="TDragObject.KeyDown">
 
1722
        <short>[Delphi compatible - dropped!]</short>
 
1723
        <descr/>
 
1724
        <errors/>
 
1725
        <seealso/>
 
1726
      <notes><note>Delphi compatible - dropped!</note>
 
1727
        </notes>
 
1728
      </element>
 
1729
      <element name="TDragObject.KeyDown.Key">
 
1730
        <short/>
 
1731
      </element>
 
1732
      <element name="TDragObject.KeyDown.Shift">
 
1733
        <short/>
 
1734
      </element>
 
1735
      <!-- procedure Visibility: protected -->
 
1736
      <element name="TDragObject.KeyUp">
 
1737
        <short>[Delphi compatible - dropped!]</short>
 
1738
        <descr/>
 
1739
        <errors/>
 
1740
        <seealso/>
 
1741
      <notes><note>Delphi compatible - dropped!</note>
 
1742
        </notes>
 
1743
      </element>
 
1744
      <element name="TDragObject.KeyUp.Key">
 
1745
        <short/>
 
1746
      </element>
 
1747
      <element name="TDragObject.KeyUp.Shift">
 
1748
        <short/>
 
1749
      </element>
 
1750
      <!-- constructor Visibility: public -->
 
1751
      <element name="TDragObject.Create">
 
1752
        <short>Remembers the dragged control.</short>
 
1753
        <descr/>
 
1754
        <errors/>
 
1755
        <seealso>
 
1756
          <link id="#rtl.System.TObject.Create">TObject.Create</link>
 
1757
        </seealso>
 
1758
      </element>
 
1759
      <element name="TDragObject.Create.AControl">
 
1760
        <short>The control being dragged.</short>
 
1761
      </element>
 
1762
      <element name="TDragObject.AutoCreate">
 
1763
        <short>Special constructor, enforcing the destruction of the object at the end of the dragging operation.</short>
 
1764
        <descr>This constructor sets the AutoCreated and AutoFree flags. AutoFree is tested by the DragManager at the end of the dragging operation.</descr>
 
1765
      </element>
 
1766
      <element name="TDragObject.AutoCreate.AControl">
 
1767
        <short>The control being dragged.</short>
 
1768
      </element>
 
1769
      <element name="TDragObject.AutoFree">
 
1770
        <short>Indicates whether the object shall be destroyed at the end of the dragging operation.</short>
 
1771
        <descr>This is a Lazarus specific property, introduced to get rid of the special Delphi TDrag...Ex classes.</descr>
 
1772
      </element>
 
1773
      <!-- destructor Visibility: public -->
 
1774
      <element name="TDragObject.Destroy"/>
 
1775
      <!-- property Visibility: public -->
 
1776
      <element name="TDragObject.AlwaysShowDragImages">
 
1777
        <short>Should the image of dragged objects always be shown?</short>
 
1778
        <descr>This is another chance for enforcing the display of a drag image, even if a drop is acceptable.</descr>
 
1779
        <seealso/>
 
1780
      <notes><note>where to describe the various conditions?</note>
 
1781
        </notes>
 
1782
      </element>
 
1783
      <!-- property Visibility: public -->
 
1784
      <element name="TDragObject.Control">
 
1785
        <short>The control that is dragged (source).</short>
 
1786
        <descr/>
 
1787
        <seealso/>
 
1788
      </element>
 
1789
      <!-- procedure Visibility: public -->
 
1790
      <element name="TDragObject.Assign">
 
1791
        <short>[Delphi compatible - dropped!] Copy information from another drag object.</short>
 
1792
        <descr>Use <var>Assign</var> to initialize the drag object with your own default values.</descr>
 
1793
      <notes><note>Delphi compatible - dropped!</note>
 
1794
        </notes>
 
1795
      </element>
 
1796
      <element name="TDragObject.Assign.Source"/>
 
1797
      <!-- function Visibility: public -->
 
1798
      <element name="TDragObject.GetName">
 
1799
        <short>[Delphi compatible - dropped!] Returns the Name of the drag object.</short>
 
1800
        <descr>This implementation returns the ClassName of the object.
 
1801
          Override as appropriate for your drag management, this method is not called by LCL code.
 
1802
        </descr>
 
1803
      <notes><note>Delphi compatible - dropped!</note>
 
1804
        </notes>
 
1805
      </element>
 
1806
      <element name="TDragObject.GetName.Result">
 
1807
        <short>The object's name.</short>
 
1808
      </element>
 
1809
      <!-- function Visibility: public -->
 
1810
      <element name="TDragObject.Instance">
 
1811
        <short>[Delphi compatible - dropped!]</short>
 
1812
      <notes><note>Delphi compatible - dropped!</note>
 
1813
        </notes>
 
1814
      </element>
 
1815
      <element name="TDragObject.Instance.Result">
 
1816
        <short>Zero by default.</short>
 
1817
      </element>
 
1818
      <!-- procedure Visibility: public -->
 
1819
      <element name="TDragObject.HideDragImage">
 
1820
        <short>Asks the image list to hide the drag image.</short>
 
1821
        <seealso>
 
1822
          <link id="#lcl.Controls.TDragObject.ShowDragImage">ShowDragImage</link>
 
1823
        </seealso>
 
1824
      </element>
 
1825
      <!-- procedure Visibility: public -->
 
1826
      <element name="TDragObject.ShowDragImage">
 
1827
        <short>Asks the image list to show the drag image.</short>
 
1828
        <descr/>
 
1829
        <seealso>
 
1830
          <link id="#lcl.Controls.TDragObject.HideDragImage">HideDragImage</link>
 
1831
        </seealso>
 
1832
      </element>
 
1833
      <!-- property Visibility: public -->
 
1834
      <element name="TDragObject.Cancelling">
 
1835
        <short>[Delphi compatible - dropped!] Is this drag being cancelled?</short>
 
1836
        <descr>Set while this drag is cancelled. Used to prevent endless loops in further processing.</descr>
 
1837
      <notes><note>Delphi compatible - dropped!</note>
 
1838
        </notes>
 
1839
      </element>
 
1840
      <!-- property Visibility: public -->
 
1841
      <element name="TDragObject.DragHandle">
 
1842
        <short>[Delphi compatible - dropped!] The Handle of the dragged object.</short>
 
1843
        <descr/>
 
1844
      <notes><note>Delphi compatible - dropped!</note>
 
1845
        </notes>
 
1846
      </element>
 
1847
      <!-- property Visibility: public -->
 
1848
      <element name="TDragObject.DragPos">
 
1849
        <short>Current mouse position in screen coordinates.</short>
 
1850
        <seealso>
 
1851
          <link id="TDragObject.DragTargetPos"/>
 
1852
        </seealso>
 
1853
      </element>
 
1854
      <!-- property Visibility: public -->
 
1855
      <element name="TDragObject.DragTargetPos">
 
1856
        <short>Mouse position in client coordinates of the DragTarget.</short>
 
1857
        <seealso>
 
1858
          <link id="TDragObject.DragPos"/>
 
1859
        </seealso>
 
1860
      </element>
 
1861
      <!-- property Visibility: public -->
 
1862
      <element name="TDragObject.DragTarget">
 
1863
        <short>The control over which the object currently is dragged (target).</short>
 
1864
      </element>
 
1865
      <!-- property Visibility: public -->
 
1866
      <element name="TDragObject.Dropped">
 
1867
        <short>Indicates whether the drag object has been dropped yet.</short>
 
1868
        <descr>False while dragging is in progress, or when dragging has been aborted.</descr>
 
1869
      </element>
 
1870
      <!-- property Visibility: public -->
 
1871
      <element name="TDragObject.MouseDeltaX">
 
1872
        <short>[Delphi compatible - dropped!] The x offset of the DragImage or DockRect hotspot.</short>
 
1873
        <descr/>
 
1874
        <seealso/>
 
1875
      <notes><note>Delphi compatible - dropped!</note>
 
1876
        </notes>
 
1877
      </element>
 
1878
      <!-- property Visibility: public -->
 
1879
      <element name="TDragObject.MouseDeltaY">
 
1880
        <short>[Delphi compatible - dropped!] The y offset of the DragImage or DockRect hotspot.</short>
 
1881
        <descr/>
 
1882
        <seealso/>
 
1883
      <notes><note>Delphi compatible - dropped!</note>
 
1884
        </notes>
 
1885
      </element>
 
1886
      <element name="TDragObject.AutoCreated">
 
1887
        <short>Was the drag object created automatically?</short>
 
1888
        <descr>This property is of little use, more important is the AutoFree property.</descr>
 
1889
      </element>
 
1890
      <element name="TDragObject.EndDrag">
 
1891
        <short>Called when a dragging operation ends.</short>
 
1892
        <descr>The default implementation calls Control.DoEndDrag, which in turn invokes an OnEndDrag handler.</descr>
 
1893
      </element>
 
1894
      <element name="TDragObject.EndDrag.Target">
 
1895
        <short>The control onto which the dragged object is dropped (can be Nil).</short>
 
1896
      </element>
 
1897
      <element name="TDragObject.EndDrag.X">
 
1898
        <short/>
 
1899
      </element>
 
1900
      <element name="TDragObject.EndDrag.Y">
 
1901
        <short/>
 
1902
      </element>
 
1903
      <!-- "class of" type Visibility: default -->
 
1904
      <element name="TDragObjectClass">
 
1905
        <short>A <link id="TDragObject"/> class type.</short>
 
1906
      </element>
 
1907
      <element link="#LCL.Controls.TDragObject" name="TDragObjectEx">
 
1908
        <short>A drag object that is automatically destroyed after use.</short>
 
1909
      </element>
 
1910
      <element name="TDragObjectEx.Create">
 
1911
        <short>Creates a drag object that is automatically destroyed after use.</short>
 
1912
      </element>
 
1913
      <element name="TDragObjectEx.Create.AControl">
 
1914
        <short/>
 
1915
      </element>
 
1916
      <!-- object Visibility: default -->
 
1917
      <element name="TDragControlObject">
 
1918
        <short>A drag object for dragging a control.</short>
 
1919
        <descr>While a TDragObject can be used for dragging controls, this class <b>knows</b> that it drags a control, and asks it for an DragCursor and DragImages.
 
1920
        </descr>
 
1921
        <errors/>
 
1922
        <seealso>
 
1923
          <link id="TDragObject"/>
 
1924
        </seealso>
 
1925
      </element>
 
1926
      <!-- function Visibility: protected -->
 
1927
      <element name="TDragControlObject.GetDragCursor">
 
1928
        <short>Asks the Control to provide an cursor.</short>
 
1929
      </element>
 
1930
      <element name="TDragControlObject.GetDragCursor.Result">
 
1931
        <short/>
 
1932
      </element>
 
1933
      <element name="TDragControlObject.GetDragCursor.Accepted">
 
1934
        <short/>
 
1935
      </element>
 
1936
      <element name="TDragControlObject.GetDragCursor.X">
 
1937
        <short/>
 
1938
      </element>
 
1939
      <element name="TDragControlObject.GetDragCursor.Y">
 
1940
        <short/>
 
1941
      </element>
 
1942
      <!-- function Visibility: protected -->
 
1943
      <element name="TDragControlObject.GetDragImages">
 
1944
        <short>Asks the Control to provide an ImageList.</short>
 
1945
      </element>
 
1946
      <element name="TDragControlObject.GetDragImages.Result">
 
1947
        <short>The Image list to be used in dragging this control.</short>
 
1948
      </element>
 
1949
      <element link="#LCL.Controls.TDragControlObject" name="TDragControlObjectEx"/>
 
1950
      <element name="TDragControlObjectEx.Create">
 
1951
        <short>Creates an object to be destroyed after use.</short>
 
1952
      </element>
 
1953
      <element name="TDragControlObjectEx.Create.AControl">
 
1954
        <short>The control to drag.</short>
 
1955
      </element>
 
1956
      <!-- enumeration type Visibility: default -->
 
1957
      <element name="TDockOrientation">
 
1958
        <short>Orientation of DockZones and docked controls, similar to <link id="TAlign"/>.</short>
 
1959
        <descr>
 
1960
          <p>This is a Delphi relict, bound to TDockTree and not very useful in application code.<br/>
 
1961
          All DockZones in an DockTree have a unique orientation, horizontal or vertical, indicating how controls are arranged in this zone.
 
1962
          When a control is docked into a zone, it obtains the orientation of that zone.
 
1963
          </p>
 
1964
          <remark>The control's orientation can be stored as the opposite of the zone, depending on the used DockManager.
 
1965
          </remark>
 
1966
        </descr>
 
1967
        <seealso/>
 
1968
      </element>
 
1969
      <element name="TDockOrientation.doNoOrient">
 
1970
        <short>no orientation applies (like alNone)</short>
 
1971
      </element>
 
1972
      <element name="TDockOrientation.doHorizontal">
 
1973
        <short>siblings are arranged horizontally, children top-to-bottom</short>
 
1974
      </element>
 
1975
      <element name="TDockOrientation.doVertical">
 
1976
        <short>siblings are arranged vertically, children left-to-right</short>
 
1977
      </element>
 
1978
      <element name="TDockOrientation.doPages">
 
1979
        <short>children are pages in a tabbed control</short>
 
1980
      </element>
 
1981
      <!-- procedure type Visibility: default -->
 
1982
      <element name="TDockDropEvent">
 
1983
        <short>The type of an OnDockDrop handler.</short>
 
1984
        <descr>An OnDockDrop event is sent by the drop target (dock site) on the drop of a dragged object.
 
1985
        </descr>
 
1986
        <seealso>
 
1987
          <link id="TDragDropEvent"/>
 
1988
        </seealso>
 
1989
      </element>
 
1990
      <element name="TDockDropEvent.Sender">
 
1991
        <short>The drop target (docksite control).</short>
 
1992
      </element>
 
1993
      <element name="TDockDropEvent.Source">
 
1994
        <short>The DragDock object, containing information about the dragged object.</short>
 
1995
      </element>
 
1996
      <element link="TDragOverEvent.X" name="TDockDropEvent.X">
 
1997
        <short/>
 
1998
      </element>
 
1999
      <element link="TDragOverEvent.Y" name="TDockDropEvent.Y">
 
2000
        <short/>
 
2001
      </element>
 
2002
      <!-- procedure type Visibility: default -->
 
2003
      <element name="TDockOverEvent">
 
2004
        <short>The type of an OnDockOver handler.</short>
 
2005
        <descr>An OnDockOver event is sent by a dock site, when an object is dragged over it.
 
2006
          The handler can specify whether a drop will be accepted or rejected.
 
2007
        </descr>
 
2008
        <seealso>
 
2009
          <link id="TDragOverEvent"/>
 
2010
        </seealso>
 
2011
      </element>
 
2012
      <element name="TDockOverEvent.Sender">
 
2013
        <short>The possible drop target.</short>
 
2014
      </element>
 
2015
      <element link="TDockDropEvent.Source" name="TDockOverEvent.Source">
 
2016
        <short/>
 
2017
      </element>
 
2018
      <element link="TDragOverEvent.X" name="TDockOverEvent.X">
 
2019
        <short/>
 
2020
      </element>
 
2021
      <element link="TDragOverEvent.Y" name="TDockOverEvent.Y">
 
2022
        <short/>
 
2023
      </element>
 
2024
      <element link="TDragOverEvent.State" name="TDockOverEvent.State">
 
2025
        <short/>
 
2026
      </element>
 
2027
      <element link="TDragOverEvent.Accept" name="TDockOverEvent.Accept">
 
2028
        <short/>
 
2029
      </element>
 
2030
      <!-- procedure type Visibility: default -->
 
2031
      <element name="TUnDockEvent">
 
2032
        <short>The type of an OnUnDock handler.</short>
 
2033
        <descr>An UnDock event is sent by a dock site, before a control is undocked from it.
 
2034
          The handler can reject undocking, by setting Allow to False.
 
2035
        </descr>
 
2036
        <seealso/>
 
2037
      </element>
 
2038
      <element name="TUnDockEvent.Sender">
 
2039
        <short>The docksite from which the object is undocked.</short>
 
2040
      </element>
 
2041
      <element name="TUnDockEvent.Client">
 
2042
        <short>The control to be undocked.</short>
 
2043
      </element>
 
2044
      <element name="TUnDockEvent.NewTarget">
 
2045
        <short>The new docksite for Client, Nil when undocked into floating state.</short>
 
2046
      </element>
 
2047
      <element name="TUnDockEvent.Allow">
 
2048
        <short>Set Allow to False to reject undocking.</short>
 
2049
      </element>
 
2050
      <!-- procedure type Visibility: default -->
 
2051
      <element name="TStartDockEvent">
 
2052
        <short>The type of an OnStartDock handler.</short>
 
2053
        <descr>An OnStartDock event is sent by a control when it shall be dragged and its DragKind is dkDock.
 
2054
          The handler can provide a specific DragDock object, else a standard TDragDockObjectEx is automatically created by the DragManager.
 
2055
        </descr>
 
2056
        <seealso>
 
2057
          <link id="TStartDragEvent"/>
 
2058
        </seealso>
 
2059
      </element>
 
2060
      <element name="TStartDockEvent.Sender">
 
2061
        <short>The control being dragged.</short>
 
2062
      </element>
 
2063
      <element name="TStartDockEvent.DragObject">
 
2064
        <short>Supply your own TDragDockObject, or leave it Nil to request automatic creation.</short>
 
2065
      </element>
 
2066
      <!-- procedure type Visibility: default -->
 
2067
      <element name="TGetSiteInfoEvent">
 
2068
        <short>An OnGetSiteInfo handler returns information about a docksite.</short>
 
2069
        <descr>An OnGetSiteInfo event is sent by the DragManager to all docksites.
 
2070
          The handler can adjust the snapping rectangle (InfluenceRect), and can reject an drop.
 
2071
        </descr>
 
2072
        <seealso/>
 
2073
      </element>
 
2074
      <element name="TGetSiteInfoEvent.Sender">
 
2075
        <short>The dock site near the mouse pointer.</short>
 
2076
      </element>
 
2077
      <element name="TGetSiteInfoEvent.DockClient">
 
2078
        <short>The dragged control.</short>
 
2079
      </element>
 
2080
      <element name="TGetSiteInfoEvent.InfluenceRect">
 
2081
        <short>The screen rectangle within which a drop or mouse move will be directed to this docksite.</short>
 
2082
      </element>
 
2083
      <element name="TGetSiteInfoEvent.MousePos">
 
2084
        <short>The current position of the mouse.</short>
 
2085
      <notes><note>screen?</note>
 
2086
        </notes>
 
2087
      </element>
 
2088
      <element name="TGetSiteInfoEvent.CanDock">
 
2089
        <short>Set CanDock to False to reject docking.</short>
 
2090
      </element>
 
2091
      <!-- object Visibility: default -->
 
2092
      <element name="TDragDockObject">
 
2093
        <short>A drag object for drag-dock.</short>
 
2094
        <descr>
 
2095
          <p>This object type serves two main purposes: it allows to distinguish between drag-drop and drag-dock operations, and it implements docking specific information and behaviour.</p>
 
2096
          <p>The primary use is for tree docking, as assumed in the TControl and TWinControl methods.</p>
 
2097
          <p>[entire review DoDi 2011-09-10]</p>
 
2098
        </descr>
 
2099
        <errors/>
 
2100
        <seealso>
 
2101
          <link id="TDragObject"/>
 
2102
        </seealso>
 
2103
      </element>
 
2104
      <!-- variable Visibility: private -->
 
2105
      <element link="TDragDockObject.DockOffset" name="TDragDockObject.FDockOffset"/>
 
2106
      <element link="TDragDockObject.DockRect" name="TDragDockObject.FDockRect"/>
 
2107
      <element link="TDragDockObject.DropAlign" name="TDragDockObject.FDropAlign"/>
 
2108
      <element link="TDragDockObject.DropOnControl" name="TDragDockObject.FDropOnControl"/>
 
2109
      <element link="TDragDockObject.EraseDockRect" name="TDragDockObject.FEraseDockRect"/>
 
2110
      <element link="TDragDockObject.Floating" name="TDragDockObject.FFloating"/>
 
2111
      <element link="TDragDockObject.IncreaseDockArea" name="TDragDockObject.FIncreaseDockArea"/>
 
2112
      <!-- variable Visibility: private -->
 
2113
      <element name="TDragDockObject.FBrush">
 
2114
        <short>[dropped!]</short>
 
2115
        <descr/>
 
2116
        <seealso/>
 
2117
      <notes><note>dropped!</note>
 
2118
        </notes>
 
2119
      </element>
 
2120
      <!-- procedure Visibility: private -->
 
2121
      <element link="TDragDockObject.Brush" name="TDragDockObject.SetBrush"/>
 
2122
      <element name="TDragDockObject.SetBrush.Value">
 
2123
        <short/>
 
2124
      </element>
 
2125
      <!-- procedure Visibility: protected -->
 
2126
      <element name="TDragDockObject.AdjustDockRect">
 
2127
        <short>Adjust the DockRect relative to the dragging hotspot (DockOffset).</short>
 
2128
        <descr>
 
2129
          <remark>The parameter type is bad, should be <b>var</b>. Ignore it please.
 
2130
          </remark>
 
2131
          <p>The default implementation adjusts the stored FDockRect, by DockOffset.
 
2132
            This adjustment will make the DockRect appear right over the control, when dragging starts, regardless of where the user clicked onto the control.
 
2133
          </p>
 
2134
          <p>You'll rarely have to override this method, since the DockRect is adjusted by every target site's DockManager later.
 
2135
          </p>
 
2136
        </descr>
 
2137
        <errors/>
 
2138
        <seealso/>
 
2139
      </element>
 
2140
      <element name="TDragDockObject.AdjustDockRect.ARect">
 
2141
        <short>useless, ignore!</short>
 
2142
      </element>
 
2143
      <!-- procedure Visibility: protected -->
 
2144
      <element name="TDragDockObject.DrawDragDockImage">
 
2145
        <short>[Delphi compatible - dropped!]</short>
 
2146
        <descr/>
 
2147
        <errors/>
 
2148
        <seealso/>
 
2149
      <notes><note>Delphi compatible - dropped!</note>
 
2150
        </notes>
 
2151
      </element>
 
2152
      <!-- procedure Visibility: protected -->
 
2153
      <element name="TDragDockObject.EndDrag">
 
2154
        <short>Finish docking.</short>
 
2155
        <descr>Invokes Control.DoEndDock.</descr>
 
2156
        <errors/>
 
2157
        <seealso>
 
2158
          <link id="TControl.DoEndDock"/>
 
2159
        </seealso>
 
2160
      </element>
 
2161
      <element name="TDragDockObject.EndDrag.Target">
 
2162
        <short>The target docksite, or Nil to make the Control float.</short>
 
2163
      </element>
 
2164
      <element name="TDragDockObject.EndDrag.X">
 
2165
        <short/>
 
2166
      </element>
 
2167
      <element name="TDragDockObject.EndDrag.Y">
 
2168
        <short/>
 
2169
      </element>
 
2170
      <!-- procedure Visibility: protected -->
 
2171
      <element name="TDragDockObject.EraseDragDockImage">
 
2172
        <short>[Delphi compatible - dropped!]</short>
 
2173
        <descr/>
 
2174
        <errors/>
 
2175
        <seealso/>
 
2176
      <notes><note>Delphi compatible - dropped!</note>
 
2177
        </notes>
 
2178
      </element>
 
2179
      <!-- function Visibility: protected -->
 
2180
      <element link="#LCL.Controls.TDragObject.GetDragCursor" name="TDragDockObject.GetDragCursor"/>
 
2181
      <element name="TDragDockObject.GetDragCursor.Result">
 
2182
        <short/>
 
2183
      </element>
 
2184
      <element name="TDragDockObject.GetDragCursor.Accepted">
 
2185
        <short/>
 
2186
      </element>
 
2187
      <element name="TDragDockObject.GetDragCursor.X">
 
2188
        <short/>
 
2189
      </element>
 
2190
      <element name="TDragDockObject.GetDragCursor.Y">
 
2191
        <short/>
 
2192
      </element>
 
2193
      <element name="TDragDockObject.MoveDockImage">
 
2194
        <short>Moves an already visible DockRect.</short>
 
2195
        <descr>
 
2196
          <p>Checks the DockRect for changes against EraseDockRect, to prevent flicker.</p>
 
2197
          <p>Remembers the drawn frame coordinates in EraseDockRect.</p>
 
2198
        </descr>
 
2199
      </element>
 
2200
      <element name="TDragDockObject.InitDock">
 
2201
        <short>Initializes the dragging coordinates.</short>
 
2202
        <descr>
 
2203
          <p>Determines the hotspot offset for adjusting the floating DockRect.</p>
 
2204
          <p>Since the undocked extent of the control doesn't change while dragging, we fix the hotspot offset here.</p>
 
2205
          <p>Usage: OffsetRect(DockRect, FDockOffset);</p>
 
2206
        </descr>
 
2207
      </element>
 
2208
      <element name="TDragDockObject.InitDock.APosition">
 
2209
        <short/>
 
2210
      </element>
 
2211
      <element name="TDragDockObject.ShowDockImage">
 
2212
        <short>Shows the DockRect, remembers the coordinates in EraseDockRect</short>
 
2213
      </element>
 
2214
      <element name="TDragDockObject.HideDockImage">
 
2215
        <short>Hides the DockRect, invalidates EraseDockRect to prevent further erases.</short>
 
2216
      </element>
 
2217
      <!-- function Visibility: protected -->
 
2218
      <element name="TDragDockObject.GetFrameWidth">
 
2219
        <short>[Delphi compatible - dropped!]</short>
 
2220
        <descr/>
 
2221
        <errors/>
 
2222
        <seealso/>
 
2223
      <notes><note>Delphi compatible - dropped!</note>
 
2224
        </notes>
 
2225
      </element>
 
2226
      <element name="TDragDockObject.GetFrameWidth.Result">
 
2227
        <short/>
 
2228
      </element>
 
2229
      <!-- constructor Visibility: public -->
 
2230
      <element name="TDragDockObject.Create"/>
 
2231
      <element name="TDragDockObject.Create.AControl">
 
2232
        <short/>
 
2233
      </element>
 
2234
      <!-- destructor Visibility: public -->
 
2235
      <element name="TDragDockObject.Destroy"/>
 
2236
      <!-- procedure Visibility: public -->
 
2237
      <element name="TDragDockObject.Assign">
 
2238
        <short>[Delphi compatible - dropped!]</short>
 
2239
        <descr/>
 
2240
        <errors/>
 
2241
        <seealso/>
 
2242
      <notes><note>Delphi compatible - dropped!</note>
 
2243
        </notes>
 
2244
      </element>
 
2245
      <element name="TDragDockObject.Assign.Source">
 
2246
        <short/>
 
2247
      </element>
 
2248
      <!-- property Visibility: public -->
 
2249
      <element name="TDragDockObject.Brush">
 
2250
        <short>[Delphi compatible - dropped!]</short>
 
2251
        <descr/>
 
2252
        <seealso/>
 
2253
      <notes><note>Delphi compatible - dropped!</note>
 
2254
        </notes>
 
2255
      </element>
 
2256
      <!-- property Visibility: public -->
 
2257
      <element name="TDragDockObject.DockOffset">
 
2258
        <short>The hotspot offset of the dragged DockRect.</short>
 
2259
      </element>
 
2260
      <!-- property Visibility: public -->
 
2261
      <element name="TDragDockObject.DockRect">
 
2262
        <short>Screen coordinates of a possible drop location.</short>
 
2263
        <descr>The DockRect gives feedback to the user, where the dragged control may be dropped.
 
2264
          When no docksite signals acceptance, the DockRect reflects the floating state of the dragged control.
 
2265
          When a drop will dock the control, the DockRect signifies the approximate position of the docked control.
 
2266
        </descr>
 
2267
        <seealso/>
 
2268
      </element>
 
2269
      <!-- property Visibility: public -->
 
2270
      <element name="TDragDockObject.DropAlign">
 
2271
        <short>How the dragged control will be docked, relative to the target control.</short>
 
2272
        <descr>When the target is a DockTree, DropAlign indicates the placement of the control relative to DropOnControl.
 
2273
          Other docking methods require a specialized (derived) DragDockObject.
 
2274
        </descr>
 
2275
        <seealso/>
 
2276
      </element>
 
2277
      <!-- property Visibility: public -->
 
2278
      <element name="TDragDockObject.DropOnControl">
 
2279
        <short>The already docked control, relative to which the dragged control will be docked. Nil for an empty docksite.</short>
 
2280
        <descr/>
 
2281
        <seealso/>
 
2282
      </element>
 
2283
      <!-- property Visibility: public -->
 
2284
      <element name="TDragDockObject.EraseDockRect">
 
2285
        <short>The currently visible DockRect, to be removed later.</short>
 
2286
        <descr>A special value indicates that the DockRect already has been removed.</descr>
 
2287
        <seealso/>
 
2288
      </element>
 
2289
      <!-- property Visibility: public -->
 
2290
      <element name="TDragDockObject.Floating">
 
2291
        <short>The final state of the dragged control (after drop).</short>
 
2292
        <descr>True when the dragged control becomes or stays floating.</descr>
 
2293
        <seealso/>
 
2294
      </element>
 
2295
      <!-- property Visibility: public -->
 
2296
      <element name="TDragDockObject.FrameWidth">
 
2297
        <short>[Delphi compatible - dropped!]</short>
 
2298
        <descr/>
 
2299
        <seealso/>
 
2300
      <notes><note>Delphi compatible - dropped!</note>
 
2301
        </notes>
 
2302
      </element>
 
2303
      <!-- property Visibility: public -->
 
2304
      <element name="TDragDockObject.IncreaseDockArea">
 
2305
        <short>Determines whether the dock site shall be enlarged.</short>
 
2306
        <descr>Not normally used, perhaps a special AnchorDocking property?</descr>
 
2307
        <seealso/>
 
2308
      </element>
 
2309
      <!-- object Visibility: default -->
 
2310
      <element name="TDragDockObjectEx">
 
2311
        <short>A drag object for docking, that is automatically destroyed after use.</short>
 
2312
      </element>
 
2313
      <element name="TDragDockObjectEx.Create">
 
2314
        <short>Creates an object to be destroyed after use.</short>
 
2315
      </element>
 
2316
      <element name="TDragDockObjectEx.Create.AControl">
 
2317
        <short/>
 
2318
      </element>
 
2319
      <!-- object Visibility: default -->
 
2320
      <element name="TDockManager">
 
2321
        <short>The layout manager for a docksite.</short>
 
2322
        <descr>Every docksite can have an DockManager, which arranges the docked controls.
 
2323
        </descr>
 
2324
        <seealso>
 
2325
          <link id="controls.TDockTree"/>
 
2326
        </seealso>
 
2327
      </element>
 
2328
      <element name="TDockManager.Create">
 
2329
        <short>Creates an DockManager for ADockSite</short>
 
2330
      </element>
 
2331
      <element name="TDockManager.Create.ADockSite">
 
2332
        <short>This is the TWinControl acting as the docksite.</short>
 
2333
      </element>
 
2334
      <element name="TDockManager.MessageHandler">
 
2335
        <short>Handles the messages sent to a docksite.</short>
 
2336
        <descr>
 
2337
          <p>This handler must handle all mouse messages, related to the client area of the docksite that is not covered by docked controls (dock headers...).</p>
 
2338
          <p>Handling mouse messages while dragging is not required. Painting of the docksite has to be implemented in PaintSite.</p>
 
2339
        </descr>
 
2340
        <seealso>
 
2341
          <link id="TDockManager.PaintSite"/>
 
2342
        </seealso>
 
2343
      </element>
 
2344
      <element name="TDockManager.MessageHandler.Sender">
 
2345
        <short/>
 
2346
      </element>
 
2347
      <element name="TDockManager.MessageHandler.Message">
 
2348
        <short>The message to be processed.</short>
 
2349
      </element>
 
2350
      <!-- procedure Visibility: default -->
 
2351
      <element name="TDockManager.BeginUpdate">
 
2352
        <short>Start updating the DockSite layout.</short>
 
2353
        <descr/>
 
2354
        <errors/>
 
2355
        <seealso/>
 
2356
      </element>
 
2357
      <!-- procedure Visibility: default -->
 
2358
      <element name="TDockManager.EndUpdate">
 
2359
        <short>Finish updating the DockSite layout.</short>
 
2360
        <descr/>
 
2361
        <errors/>
 
2362
        <seealso/>
 
2363
      </element>
 
2364
      <!-- procedure Visibility: default -->
 
2365
      <element name="TDockManager.AutoFreeByControl">
 
2366
        <short>Returns True if the DockManager should be destroyed together with the docksite.</short>
 
2367
        <descr>
 
2368
          <p>This is a Lazarus specific extension of the Delphi TDockManager. It allows multiple docksites to share the same DockManager instance.</p>
 
2369
        </descr>
 
2370
      </element>
 
2371
      <element name="TDockManager.AutoFreeByControl.Result">
 
2372
        <short>True if the DockManager should be destroyed together with the docksite.</short>
 
2373
      </element>
 
2374
      <!-- procedure Visibility: default -->
 
2375
      <element name="TDockManager.GetControlBounds">
 
2376
        <short>Returns the zone bounds of a docked control.</short>
 
2377
        <descr>
 
2378
          <p>The TDockTree manager returns the bounds of the dockzone, including the dock header.</p>
 
2379
          <p>When the Control is not docked, an empty Rect(0,0,0,0) is returned.</p>
 
2380
        </descr>
 
2381
        <errors/>
 
2382
        <seealso/>
 
2383
      </element>
 
2384
      <element name="TDockManager.GetControlBounds.Control">
 
2385
        <short>The docked control.</short>
 
2386
      </element>
 
2387
      <element name="TDockManager.GetControlBounds.AControlBounds">
 
2388
        <short>The enclosing rectangle, in client coordinates of the docksite.</short>
 
2389
      </element>
 
2390
      <element name="TDockManager.GetDockEdge">
 
2391
        <short>Determine the DropAlign.</short>
 
2392
        <descr>
 
2393
          <p>ADockObject contains valid DragTarget, DragPos and DragTargetPos relative dock site. DockRect is undetermined.</p>
 
2394
          <p>DropOnControl may be Nil if nothing has been docked yet, or no target control exists at the mouse coordinates.</p>
 
2395
          <p>Returns True if ADockObject.DropAlign has been determined. If False, the DropAlign has to be determined by default procedures.</p>
 
2396
        </descr>
 
2397
      </element>
 
2398
      <element name="TDockManager.GetDockEdge.Result">
 
2399
        <short>True if the DropAlign was determined.</short>
 
2400
      </element>
 
2401
      <element name="TDockManager.GetDockEdge.ADockObject">
 
2402
        <short>The DragDockObject holding all information about the drag-dock operation.</short>
 
2403
      </element>
 
2404
      <!-- procedure Visibility: default -->
 
2405
      <element name="TDockManager.InsertControl">
 
2406
        <short>Position <var>DropCtl</var> relative <var>Control</var>, using the alignment specified by <var>InsertAt</var>.</short>
 
2407
        <descr>
 
2408
          <p>InsertControl determines the placement of the just docked control, forcing a repaint of the container control if necessary.</p>
 
2409
          <remark>When SetReplacingControl has been called with a non-Nil Control before, the dropped control only should replace that control.</remark>
 
2410
          <p>An overloaded version passes the DragDockObject to the dockmanager, allowing to pass more information about the drop. It allows to implement other than tree-style docksites.</p>
 
2411
        </descr>
 
2412
        <errors/>
 
2413
        <seealso>
 
2414
          <link id="TDockManager.RemoveControl"/>
 
2415
        </seealso>
 
2416
      </element>
 
2417
      <element name="TDockManager.InsertControl.Control">
 
2418
        <short>The control relative to which insert.</short>
 
2419
      </element>
 
2420
      <element name="TDockManager.InsertControl.InsertAt">
 
2421
        <short>How to insert relative to Control.</short>
 
2422
      </element>
 
2423
      <element name="TDockManager.InsertControl.DropCtl">
 
2424
        <short>The control to insert.</short>
 
2425
      </element>
 
2426
      <element name="TDockManager.InsertControl.ADockObject">
 
2427
        <short>The DragDockObject holding all information about the drag-dock operation.</short>
 
2428
      </element>
 
2429
      <!-- procedure Visibility: default -->
 
2430
      <element name="TDockManager.LoadFromStream">
 
2431
        <short>Restores the layout of the docksite from Stream.</short>
 
2432
        <descr>The controls to be docked can be retrieved by ReloadDockedControl from the docksite; this method returns only existing controls of the given name, owned by the owner of the docksite, by default.</descr>
 
2433
        <errors/>
 
2434
        <seealso>
 
2435
          <link id="TWinControl.ReloadDockedControl"/>
 
2436
          <link id="TDockManager.SaveToStream"/>
 
2437
        </seealso>
 
2438
      </element>
 
2439
      <element name="TDockManager.LoadFromStream.Stream">
 
2440
        <short>The stream with the layout information.</short>
 
2441
      </element>
 
2442
      <!-- procedure Visibility: default -->
 
2443
      <element name="TDockManager.PaintSite">
 
2444
        <short>Handles special painting of the docksite.</short>
 
2445
        <descr>While the docked controls paint themselves, eventual dockheaders and other decoration have to be painted by the DockManager.</descr>
 
2446
        <errors/>
 
2447
        <seealso/>
 
2448
      </element>
 
2449
      <element name="TDockManager.PaintSite.DC">
 
2450
        <short>The device context, used to paint.</short>
 
2451
      </element>
 
2452
      <!-- procedure Visibility: default -->
 
2453
      <element name="TDockManager.PositionDockRect">
 
2454
        <short>Determines the DockRect while dragging a control over the docksite.</short>
 
2455
        <descr>
 
2456
          <p>This method updates DockRect for the visual feedback, when a control is dragged over the docksite.</p>
 
2457
          <p>The initial DragDockObject.DockRect spans the entire DockSite.</p>
 
2458
          <p>The Delphi compatible version only can use the parameters determined by the default processing in the docksite.</p>
 
2459
          <p>The Lazarus specific version can update the DockObject with better suited parameters.
 
2460
            A DockManager here can implement any algorithm for the placement of a dropped control.
 
2461
            The default implementation calls the Delphi compatible version.<br/>
 
2462
            When you override the Lazarus version, you may have to determine the dock sibling and DropAlign again, when the default determination (in TControl and TWinControl) is inappropriate.
 
2463
          </p>
 
2464
        </descr>
 
2465
        <errors/>
 
2466
        <seealso>
 
2467
          <link id="TDragDockObject"/>
 
2468
        </seealso>
 
2469
      </element>
 
2470
      <element name="TDockManager.PositionDockRect.Client">
 
2471
        <short>The dropped control.</short>
 
2472
      </element>
 
2473
      <element name="TDockManager.PositionDockRect.DropCtl">
 
2474
        <short>The control relative to which Client shall be docked. Nil for docking into the docksite.</short>
 
2475
      </element>
 
2476
      <element name="TDockManager.PositionDockRect.DropAlign">
 
2477
        <short>How to dock, relative to DropCtl.</short>
 
2478
      </element>
 
2479
      <element name="TDockManager.PositionDockRect.DockRect">
 
2480
        <short>The screen rectangle of the docksite, to be adjusted by this method.</short>
 
2481
      </element>
 
2482
      <element name="TDockManager.PositionDockRect.ADockObject">
 
2483
        <short>The DragDockObject holding all information about the drag-dock operation.</short>
 
2484
      </element>
 
2485
      <!-- procedure Visibility: default -->
 
2486
      <element name="TDockManager.RemoveControl">
 
2487
        <short>Removes the undocked control from the docksite layout.</short>
 
2488
        <descr>When SetReplacingControl has been called with a non-Nil argument before, the layout of the docksite should not be changed. Instead the next inserted control should take the place and role of this control.</descr>
 
2489
        <errors/>
 
2490
        <seealso/>
 
2491
      </element>
 
2492
      <element name="TDockManager.RemoveControl.Control">
 
2493
        <short>Control to remove.</short>
 
2494
      </element>
 
2495
      <!-- procedure Visibility: default -->
 
2496
      <element name="TDockManager.ResetBounds">
 
2497
        <short>
 
2498
          <var>ResetBounds</var> refreshes the layout of the docksite.</short>
 
2499
        <descr>
 
2500
          <p>This method typically notifies the DockManager of a Resize of the docksite.</p>
 
2501
          <p>When the extent of the docksite really has changed, the DockManager should reposition and resize all docked controls accordingly.</p>
 
2502
          <p>The layout always should be refreshed when <var>Force</var> is True. This is required when e.g. the visibility of docked controls has changed, but not the size of the docksite.</p>
 
2503
        </descr>
 
2504
        <errors/>
 
2505
        <seealso/>
 
2506
      </element>
 
2507
      <element name="TDockManager.ResetBounds.Force">
 
2508
        <short>When True, always update the layout.</short>
 
2509
      </element>
 
2510
      <!-- procedure Visibility: default -->
 
2511
      <element name="TDockManager.SaveToStream">
 
2512
        <short>Saves the docksite layout to <var>Stream</var>.</short>
 
2513
        <descr/>
 
2514
        <errors/>
 
2515
        <seealso>
 
2516
          <link id="TDockManager.LoadFromStream"/>
 
2517
        </seealso>
 
2518
      </element>
 
2519
      <element name="TDockManager.SaveToStream.Stream">
 
2520
        <short>Write the layout information into this stream.</short>
 
2521
      </element>
 
2522
      <!-- procedure Visibility: default -->
 
2523
      <element name="TDockManager.SetReplacingControl">
 
2524
        <short>Specifies the control to be replaced subsequently.</short>
 
2525
        <descr>
 
2526
          <p>This method is called by ReplaceDockedControl, to announce a pending replacement of <var>Control</var> by another control.
 
2527
          The next RemoveControl should be ignored, and InsertControl should only exchange the controls, without reorganizing the layout of the docksite.
 
2528
          When <var>Control</var> is Nil, this call signals the end of the exchange [obsolete].</p>
 
2529
          <remark>The name "SetReplacingControl" is a misnomer, it should read "SetControlToBeReplaced".</remark>
 
2530
          <p>The intended purpose of this method is the replacement of a docked control by a Notebook, preserving the DockZone.
 
2531
            This operation should be handled by an DockManager internally, and calls to this method should be ignored.
 
2532
          </p>
 
2533
        </descr>
 
2534
        <errors/>
 
2535
        <seealso>
 
2536
          <link id="TDockManager.InsertControl"/>
 
2537
          <link id="TDockManager.RemoveControl"/>
 
2538
        </seealso>
 
2539
      </element>
 
2540
      <element name="TDockManager.SetReplacingControl.Control">
 
2541
        <short>The control to be replaced later.</short>
 
2542
      </element>
 
2543
      <element name="TDockManagerClass">
 
2544
        <short>The DockManager class type, for use when a DockManager is automatically created.</short>
 
2545
        <seealso>
 
2546
          <link id="TWinControl.CreateDockManager"/>
 
2547
          <link id="DefaultDockManagerClass"/>
 
2548
        </seealso>
 
2549
      </element>
 
2550
      <element name="DefaultDockManagerClass">
 
2551
        <short>The default class used to create an DockManager in <link id="TWinControl.CreateDockManager"/>.</short>
 
2552
        <seealso>
 
2553
          <link id="TDockManager"/>
 
2554
        </seealso>
 
2555
      </element>
 
2556
      <!-- range type Visibility: default -->
 
2557
      <element name="TConstraintSize">
 
2558
        <short>Range of the control size constraints.</short>
 
2559
        <descr/>
 
2560
        <seealso/>
 
2561
      </element>
 
2562
      <!-- enumeration type Visibility: default -->
 
2563
      <element name="TSizeConstraintsOption">
 
2564
        <short/>
 
2565
        <descr/>
 
2566
        <seealso/>
 
2567
      <notes><note>?</note>
 
2568
        </notes>
 
2569
      </element>
 
2570
      <element name="TSizeConstraintsOption.scoAdviceWidthAsMin">
 
2571
        <short/>
 
2572
      <notes><note>?</note>
 
2573
        </notes>
 
2574
      </element>
 
2575
      <element name="TSizeConstraintsOption.scoAdviceWidthAsMax">
 
2576
        <short/>
 
2577
      <notes><note>?</note>
 
2578
        </notes>
 
2579
      </element>
 
2580
      <element name="TSizeConstraintsOption.scoAdviceHeightAsMin">
 
2581
        <short/>
 
2582
      <notes><note>?</note>
 
2583
        </notes>
 
2584
      </element>
 
2585
      <element name="TSizeConstraintsOption.scoAdviceHeightAsMax">
 
2586
        <short/>
 
2587
      <notes><note>?</note>
 
2588
        </notes>
 
2589
      </element>
 
2590
      <!-- set type Visibility: default -->
 
2591
      <element link="TSizeConstraintsOption" name="TSizeConstraintsOptions"/>
 
2592
      <!-- object Visibility: default -->
 
2593
      <element name="TSizeConstraints">
 
2594
        <short>Holds maximum and minimum values that can be used in sizing objects.</short>
 
2595
        <descr/>
 
2596
        <errors/>
 
2597
        <seealso/>
 
2598
      </element>
 
2599
      <!-- variable Visibility: private -->
 
2600
      <element name="TSizeConstraints.FControl"/>
 
2601
      <element name="TSizeConstraints.FMaxHeight"/>
 
2602
      <element name="TSizeConstraints.FMaxInterfaceHeight"/>
 
2603
      <element name="TSizeConstraints.FMaxInterfaceWidth"/>
 
2604
      <element name="TSizeConstraints.FMaxWidth"/>
 
2605
      <element name="TSizeConstraints.FMinHeight"/>
 
2606
      <element name="TSizeConstraints.FMinInterfaceHeight"/>
 
2607
      <element name="TSizeConstraints.FMinInterfaceWidth"/>
 
2608
      <element name="TSizeConstraints.FMinWidth"/>
 
2609
      <element name="TSizeConstraints.FOnChange"/>
 
2610
      <element name="TSizeConstraints.FOptions"/>
 
2611
      <!-- procedure Visibility: private -->
 
2612
      <element name="TSizeConstraints.SetOptions"/>
 
2613
      <element name="TSizeConstraints.SetOptions.AValue">
 
2614
        <short/>
 
2615
      </element>
 
2616
      <!-- procedure Visibility: protected -->
 
2617
      <element name="TSizeConstraints.Change">
 
2618
        <short>Calls an OnChange handler if assigned.</short>
 
2619
        <descr/>
 
2620
        <errors/>
 
2621
        <seealso/>
 
2622
      </element>
 
2623
      <!-- procedure Visibility: protected -->
 
2624
      <element link="#rtl.Classes.TPersistent.AssignTo" name="TSizeConstraints.AssignTo"/>
 
2625
      <element name="TSizeConstraints.AssignTo.Dest">
 
2626
        <short/>
 
2627
      </element>
 
2628
      <!-- procedure Visibility: protected -->
 
2629
      <element link="TSizeConstraints.MaxHeight" name="TSizeConstraints.SetMaxHeight"/>
 
2630
      <element name="TSizeConstraints.SetMaxHeight.Value">
 
2631
        <short/>
 
2632
      </element>
 
2633
      <!-- procedure Visibility: protected -->
 
2634
      <element link="TSizeConstraints.MaxWidth" name="TSizeConstraints.SetMaxWidth"/>
 
2635
      <element name="TSizeConstraints.SetMaxWidth.Value">
 
2636
        <short/>
 
2637
      </element>
 
2638
      <!-- procedure Visibility: protected -->
 
2639
      <element link="TSizeConstraints.MinHeight" name="TSizeConstraints.SetMinHeight"/>
 
2640
      <element name="TSizeConstraints.SetMinHeight.Value">
 
2641
        <short/>
 
2642
      </element>
 
2643
      <!-- procedure Visibility: protected -->
 
2644
      <element link="TSizeConstraints.MinWidth" name="TSizeConstraints.SetMinWidth"/>
 
2645
      <element name="TSizeConstraints.SetMinWidth.Value">
 
2646
        <short/>
 
2647
      </element>
 
2648
      <!-- constructor Visibility: public -->
 
2649
      <element name="TSizeConstraints.Create"/>
 
2650
      <element name="TSizeConstraints.Create.AControl">
 
2651
        <short/>
 
2652
      </element>
 
2653
      <!-- procedure Visibility: public -->
 
2654
      <element name="TSizeConstraints.UpdateInterfaceConstraints">
 
2655
        <short>Asks the interface for constraints.</short>
 
2656
        <descr/>
 
2657
        <errors/>
 
2658
        <seealso/>
 
2659
      </element>
 
2660
      <!-- procedure Visibility: public -->
 
2661
      <element name="TSizeConstraints.SetInterfaceConstraints">
 
2662
        <short>Used by the interface to set the interface constraints.</short>
 
2663
        <descr>Should only be used by custom components, not by applications.</descr>
 
2664
        <errors/>
 
2665
        <seealso/>
 
2666
      </element>
 
2667
      <element name="TSizeConstraints.SetInterfaceConstraints.MinW">
 
2668
        <short/>
 
2669
      </element>
 
2670
      <element name="TSizeConstraints.SetInterfaceConstraints.MinH">
 
2671
        <short/>
 
2672
      </element>
 
2673
      <element name="TSizeConstraints.SetInterfaceConstraints.MaxW">
 
2674
        <short/>
 
2675
      </element>
 
2676
      <element name="TSizeConstraints.SetInterfaceConstraints.MaxH">
 
2677
        <short/>
 
2678
      </element>
 
2679
      <!-- function Visibility: public -->
 
2680
      <element name="TSizeConstraints.EffectiveMinWidth">
 
2681
        <short>Determines the minimal applicable width, given the local and interface constraints.</short>
 
2682
        <descr/>
 
2683
        <errors/>
 
2684
        <seealso/>
 
2685
      </element>
 
2686
      <element name="TSizeConstraints.EffectiveMinWidth.Result">
 
2687
        <short>Zero means no constraints.</short>
 
2688
      </element>
 
2689
      <!-- function Visibility: public -->
 
2690
      <element name="TSizeConstraints.EffectiveMinHeight">
 
2691
        <short>Determines the minimal applicable height, given the local and interface constraints.</short>
 
2692
        <descr/>
 
2693
        <errors/>
 
2694
        <seealso/>
 
2695
      </element>
 
2696
      <element name="TSizeConstraints.EffectiveMinHeight.Result">
 
2697
        <short>Zero means no constraints.</short>
 
2698
      </element>
 
2699
      <!-- function Visibility: public -->
 
2700
      <element name="TSizeConstraints.EffectiveMaxWidth">
 
2701
        <short>Determines the maximum applicable width, given the local and interface constraints.</short>
 
2702
        <descr/>
 
2703
        <errors/>
 
2704
        <seealso/>
 
2705
      </element>
 
2706
      <element name="TSizeConstraints.EffectiveMaxWidth.Result">
 
2707
        <short>Zero means no constraints.</short>
 
2708
      </element>
 
2709
      <!-- function Visibility: public -->
 
2710
      <element name="TSizeConstraints.EffectiveMaxHeight">
 
2711
        <short>Determines the maximum applicable height, given the local and interface constraints.</short>
 
2712
        <descr/>
 
2713
        <errors/>
 
2714
        <seealso/>
 
2715
      </element>
 
2716
      <element name="TSizeConstraints.EffectiveMaxHeight.Result">
 
2717
        <short>Zero means no constraints.</short>
 
2718
      </element>
 
2719
      <!-- function Visibility: public -->
 
2720
      <element name="TSizeConstraints.MinMaxWidth">
 
2721
        <short>Determines the constrained Width, and transfers it to the widget.</short>
 
2722
        <descr/>
 
2723
        <errors/>
 
2724
        <seealso/>
 
2725
      </element>
 
2726
      <element name="TSizeConstraints.MinMaxWidth.Result">
 
2727
        <short>The constrained width.</short>
 
2728
      </element>
 
2729
      <element name="TSizeConstraints.MinMaxWidth.Width">
 
2730
        <short>The suggested width.</short>
 
2731
      </element>
 
2732
      <!-- function Visibility: public -->
 
2733
      <element name="TSizeConstraints.MinMaxHeight">
 
2734
        <short>Determines the constrained Height, and transfers it to the widget.</short>
 
2735
        <descr/>
 
2736
        <errors/>
 
2737
        <seealso/>
 
2738
      </element>
 
2739
      <element name="TSizeConstraints.MinMaxHeight.Result">
 
2740
        <short>The constrained height.</short>
 
2741
      </element>
 
2742
      <element name="TSizeConstraints.MinMaxHeight.Height">
 
2743
        <short>The suggested height.</short>
 
2744
      </element>
 
2745
      <!-- property Visibility: public -->
 
2746
      <element name="TSizeConstraints.MaxInterfaceHeight">
 
2747
        <short>The maximum height allowed by the widget.</short>
 
2748
        <descr/>
 
2749
        <seealso/>
 
2750
      </element>
 
2751
      <!-- property Visibility: public -->
 
2752
      <element name="TSizeConstraints.MaxInterfaceWidth">
 
2753
        <short>The maximum width allowed by the widget.</short>
 
2754
        <descr/>
 
2755
        <seealso/>
 
2756
      </element>
 
2757
      <!-- property Visibility: public -->
 
2758
      <element name="TSizeConstraints.MinInterfaceHeight">
 
2759
        <short>The minimum height allowed by the widget.</short>
 
2760
        <descr/>
 
2761
        <seealso/>
 
2762
      </element>
 
2763
      <!-- property Visibility: public -->
 
2764
      <element name="TSizeConstraints.MinInterfaceWidth">
 
2765
        <short>The minimum width allowed by the widget.</short>
 
2766
        <descr/>
 
2767
        <seealso/>
 
2768
      </element>
 
2769
      <!-- property Visibility: public -->
 
2770
      <element name="TSizeConstraints.Control">
 
2771
        <short>The <var>Control</var> to which these constraints apply.</short>
 
2772
        <descr/>
 
2773
        <seealso/>
 
2774
      </element>
 
2775
      <!-- property Visibility: public -->
 
2776
      <element name="TSizeConstraints.Options">
 
2777
        <short>Options for the determination of the constraints.</short>
 
2778
        <descr/>
 
2779
        <seealso/>
 
2780
      <notes><note>application?</note>
 
2781
        </notes>
 
2782
      </element>
 
2783
      <!-- property Visibility: published -->
 
2784
      <element name="TSizeConstraints.OnChange">
 
2785
        <short>Event handler for a change in the constraints.</short>
 
2786
        <descr/>
 
2787
        <seealso/>
 
2788
      </element>
 
2789
      <!-- property Visibility: published -->
 
2790
      <element name="TSizeConstraints.MaxHeight">
 
2791
        <short>The maximum height.</short>
 
2792
        <descr/>
 
2793
        <seealso/>
 
2794
      </element>
 
2795
      <!-- property Visibility: published -->
 
2796
      <element name="TSizeConstraints.MaxWidth">
 
2797
        <short>The maximum width.</short>
 
2798
        <descr/>
 
2799
        <seealso/>
 
2800
      </element>
 
2801
      <!-- property Visibility: published -->
 
2802
      <element name="TSizeConstraints.MinHeight">
 
2803
        <short>The minimum height.</short>
 
2804
        <descr/>
 
2805
        <seealso/>
 
2806
      </element>
 
2807
      <!-- property Visibility: published -->
 
2808
      <element name="TSizeConstraints.MinWidth">
 
2809
        <short>The minimum width.</short>
 
2810
        <descr/>
 
2811
        <seealso/>
 
2812
      </element>
 
2813
      <!-- procedure type Visibility: default -->
 
2814
      <element name="TConstrainedResizeEvent">
 
2815
        <short/>
 
2816
        <descr/>
 
2817
        <seealso/>
 
2818
      <notes><note>?</note>
 
2819
        </notes>
 
2820
      </element>
 
2821
      <element name="TConstrainedResizeEvent.Sender">
 
2822
        <short/>
 
2823
      </element>
 
2824
      <element name="TConstrainedResizeEvent.MinWidth">
 
2825
        <short/>
 
2826
      </element>
 
2827
      <element name="TConstrainedResizeEvent.MinHeight">
 
2828
        <short/>
 
2829
      </element>
 
2830
      <element name="TConstrainedResizeEvent.MaxWidth">
 
2831
        <short/>
 
2832
      </element>
 
2833
      <element name="TConstrainedResizeEvent.MaxHeight">
 
2834
        <short/>
 
2835
      </element>
 
2836
      <!-- range type Visibility: default -->
 
2837
      <element name="TSpacingSize">
 
2838
        <short/>
 
2839
        <descr/>
 
2840
        <seealso/>
 
2841
      <notes><note>?</note>
 
2842
        </notes>
 
2843
      </element>
 
2844
      <!-- record type Visibility: default -->
 
2845
      <element link="TControlBorderSpacing" name="TControlBorderSpacingDefault">
 
2846
        <short>Defines the default values for TControlBorderSpacing.</short>
 
2847
        <descr/>
 
2848
        <seealso/>
 
2849
      </element>
 
2850
      <!-- variable Visibility: default -->
 
2851
      <element link="TControlBorderSpacing.Left" name="TControlBorderSpacingDefault.Left"/>
 
2852
      <element link="TControlBorderSpacing.Top" name="TControlBorderSpacingDefault.Top"/>
 
2853
      <element link="TControlBorderSpacing.Right" name="TControlBorderSpacingDefault.Right"/>
 
2854
      <element link="TControlBorderSpacing.Bottom" name="TControlBorderSpacingDefault.Bottom"/>
 
2855
      <element link="TControlBorderSpacing.Around" name="TControlBorderSpacingDefault.Around"/>
 
2856
      <!-- pointer type Visibility: default -->
 
2857
      <element link="TControlBorderSpacing" name="PControlBorderSpacingDefault"/>
 
2858
      <!-- object Visibility: default -->
 
2859
      <element name="TControlBorderSpacing">
 
2860
        <short>Describes the (minimum) spacing around a control.</short>
 
2861
        <descr>
 
2862
          <p>TControlBorderSpacing defines the spacing around a control.
 
2863
            The spacing around its children and between its children is defined in
 
2864
            <link id="TWinControl.ChildSizing"/>.
 
2865
          </p>
 
2866
          <code>Left, Top, Right, Bottom: integer;
 
2867
        minimum space left to the autosized control.
 
2868
        For example: Control A lies left of control B.
 
2869
        A has borderspacing Right=10 and B has borderspacing Left=5.
 
2870
        Then A and B will have a minimum space of 10 between.
 
2871
 
 
2872
    Around: integer;
 
2873
        same as Left, Top, Right and Bottom all at once. This will be added to
 
2874
        the effective Left, Top, Right and Bottom.
 
2875
        Example: Left=3 and Around=5 results in a minimum spacing to the left
 
2876
        of 8.
 
2877
 
 
2878
    InnerBorder: integer;
 
2879
        This is added to the preferred size.
 
2880
        For example: A buttons widget returns 75x25 on GetPreferredSize.
 
2881
        CalculatePreferredSize adds 2 times the InnerBorder to the width and
 
2882
        height.
 
2883
        
 
2884
    CellAlignHorizontal, CellAlignVertical: TControlCellAlign;
 
2885
        Used for example when the Parents.ChildSizing.Layout defines a table
 
2886
        layout.
 
2887
          </code>
 
2888
        </descr>
 
2889
        <errors/>
 
2890
        <seealso/>
 
2891
      </element>
 
2892
      <!-- variable Visibility: private -->
 
2893
      <element link="TControlBorderSpacing.Around" name="TControlBorderSpacing.FAround"/>
 
2894
      <element link="TControlBorderSpacing.Bottom" name="TControlBorderSpacing.FBottom"/>
 
2895
      <element name="TControlBorderSpacing.FCellAlignHorizontal"/>
 
2896
      <element name="TControlBorderSpacing.FCellAlignVertical"/>
 
2897
      <element name="TControlBorderSpacing.FControl"/>
 
2898
      <element name="TControlBorderSpacing.FInnerBorder"/>
 
2899
      <element name="TControlBorderSpacing.FLeft"/>
 
2900
      <element name="TControlBorderSpacing.FOnChange"/>
 
2901
      <element name="TControlBorderSpacing.FRight"/>
 
2902
      <element name="TControlBorderSpacing.FTop"/>
 
2903
      <element name="TControlBorderSpacing.FDefault"/>
 
2904
      <!-- function Visibility: private -->
 
2905
      <element link="TControlBorderSpacing.Around" name="TControlBorderSpacing.IsAroundStored"/>
 
2906
      <element name="TControlBorderSpacing.IsAroundStored.Result">
 
2907
        <short/>
 
2908
      </element>
 
2909
      <!-- function Visibility: private -->
 
2910
      <element link="TControlBorderSpacing.Bottom" name="TControlBorderSpacing.IsBottomStored"/>
 
2911
      <element name="TControlBorderSpacing.IsBottomStored.Result">
 
2912
        <short/>
 
2913
      </element>
 
2914
      <!-- function Visibility: private -->
 
2915
      <element link="TControlBorderSpacing.InnerBorder" name="TControlBorderSpacing.IsInnerBorderStored"/>
 
2916
      <element name="TControlBorderSpacing.IsInnerBorderStored.Result">
 
2917
        <short/>
 
2918
      </element>
 
2919
      <!-- function Visibility: private -->
 
2920
      <element link="TControlBorderSpacing.Left" name="TControlBorderSpacing.IsLeftStored"/>
 
2921
      <element name="TControlBorderSpacing.IsLeftStored.Result">
 
2922
        <short/>
 
2923
      </element>
 
2924
      <!-- function Visibility: private -->
 
2925
      <element link="TControlBorderSpacing.Right" name="TControlBorderSpacing.IsRightStored"/>
 
2926
      <element name="TControlBorderSpacing.IsRightStored.Result">
 
2927
        <short/>
 
2928
      </element>
 
2929
      <!-- function Visibility: private -->
 
2930
      <element link="TControlBorderSpacing.Top" name="TControlBorderSpacing.IsTopStored"/>
 
2931
      <element name="TControlBorderSpacing.IsTopStored.Result">
 
2932
        <short/>
 
2933
      </element>
 
2934
      <!-- procedure Visibility: private -->
 
2935
      <element name="TControlBorderSpacing.SetAround">
 
2936
        <short/>
 
2937
        <descr/>
 
2938
        <errors/>
 
2939
        <seealso/>
 
2940
      </element>
 
2941
      <element name="TControlBorderSpacing.SetAround.AValue">
 
2942
        <short/>
 
2943
      </element>
 
2944
      <!-- procedure Visibility: private -->
 
2945
      <element name="TControlBorderSpacing.SetBottom">
 
2946
        <short/>
 
2947
        <descr/>
 
2948
        <errors/>
 
2949
        <seealso/>
 
2950
      </element>
 
2951
      <element name="TControlBorderSpacing.SetBottom.AValue">
 
2952
        <short/>
 
2953
      </element>
 
2954
      <!-- procedure Visibility: private -->
 
2955
      <element link="TControlBorderSpacing.CellAlignHorizontal" name="TControlBorderSpacing.SetCellAlignHorizontal"/>
 
2956
      <element name="TControlBorderSpacing.SetCellAlignHorizontal.AValue">
 
2957
        <short/>
 
2958
      </element>
 
2959
      <!-- procedure Visibility: private -->
 
2960
      <element link="TControlBorderSpacing.CellAlignVertical" name="TControlBorderSpacing.SetCellAlignVertical"/>
 
2961
      <element name="TControlBorderSpacing.SetCellAlignVertical.AValue">
 
2962
        <short/>
 
2963
      </element>
 
2964
      <!-- procedure Visibility: private -->
 
2965
      <element link="TControlBorderSpacing.InnerBorder" name="TControlBorderSpacing.SetInnerBorder"/>
 
2966
      <element name="TControlBorderSpacing.SetInnerBorder.AValue">
 
2967
        <short/>
 
2968
      </element>
 
2969
      <!-- procedure Visibility: private -->
 
2970
      <element link="TControlBorderSpacing.Left" name="TControlBorderSpacing.SetLeft"/>
 
2971
      <element name="TControlBorderSpacing.SetLeft.AValue">
 
2972
        <short/>
 
2973
      </element>
 
2974
      <!-- procedure Visibility: private -->
 
2975
      <element link="TControlBorderSpacing.Right" name="TControlBorderSpacing.SetRight"/>
 
2976
      <element name="TControlBorderSpacing.SetRight.AValue">
 
2977
        <short/>
 
2978
      </element>
 
2979
      <!-- procedure Visibility: private -->
 
2980
      <element link="TControlBorderSpacing.Space" name="TControlBorderSpacing.SetSpace"/>
 
2981
      <element name="TControlBorderSpacing.SetSpace.Kind">
 
2982
        <short/>
 
2983
      </element>
 
2984
      <element name="TControlBorderSpacing.SetSpace.AValue">
 
2985
        <short/>
 
2986
      </element>
 
2987
      <!-- procedure Visibility: private -->
 
2988
      <element link="TControlBorderSpacing.Top" name="TControlBorderSpacing.SetTop"/>
 
2989
      <element name="TControlBorderSpacing.SetTop.AValue">
 
2990
        <short/>
 
2991
      </element>
 
2992
      <!-- procedure Visibility: protected -->
 
2993
      <element name="TControlBorderSpacing.Change">
 
2994
        <short>Invalidates the control, and invokes the <var>OnChange</var> handler.</short>
 
2995
        <descr/>
 
2996
        <errors/>
 
2997
        <seealso/>
 
2998
      </element>
 
2999
      <element name="TControlBorderSpacing.Change.InnerSpaceChanged">
 
3000
        <short>currently ignored (distinction no more required).</short>
 
3001
      </element>
 
3002
      <!-- constructor Visibility: public -->
 
3003
      <element name="TControlBorderSpacing.Create"/>
 
3004
      <element name="TControlBorderSpacing.Create.OwnerControl">
 
3005
        <short>The associated control.</short>
 
3006
      </element>
 
3007
      <element name="TControlBorderSpacing.Create.ADefault">
 
3008
        <short>Pointer to an record with default settings; can be Nil for all zero defaults.</short>
 
3009
      </element>
 
3010
      <!-- procedure Visibility: public -->
 
3011
      <element link="#rtl.Classes.TPersistent.Assign" name="TControlBorderSpacing.Assign"/>
 
3012
      <element name="TControlBorderSpacing.Assign.Source">
 
3013
        <short/>
 
3014
      </element>
 
3015
      <!-- procedure Visibility: public -->
 
3016
      <element link="#rtl.Classes.TPersistent.AssignTo" name="TControlBorderSpacing.AssignTo"/>
 
3017
      <element name="TControlBorderSpacing.AssignTo.Dest">
 
3018
        <short/>
 
3019
      </element>
 
3020
      <!-- function Visibility: public -->
 
3021
      <element name="TControlBorderSpacing.IsEqual">
 
3022
        <short>True if the specified spacing equals the current settings.</short>
 
3023
        <descr/>
 
3024
        <errors/>
 
3025
        <seealso/>
 
3026
      </element>
 
3027
      <element name="TControlBorderSpacing.IsEqual.Result">
 
3028
        <short/>
 
3029
      </element>
 
3030
      <element name="TControlBorderSpacing.IsEqual.Spacing">
 
3031
        <short/>
 
3032
      </element>
 
3033
      <!-- procedure Visibility: public -->
 
3034
      <element name="TControlBorderSpacing.GetSpaceAround">
 
3035
        <short>Returns the bounds with added Around space.</short>
 
3036
        <descr/>
 
3037
        <errors/>
 
3038
        <seealso/>
 
3039
      </element>
 
3040
      <element name="TControlBorderSpacing.GetSpaceAround.SpaceAround">
 
3041
        <short>Out parameter, initial contents are ignored!</short>
 
3042
      </element>
 
3043
      <!-- function Visibility: public -->
 
3044
      <element link="TControlBorderSpacing.Space" name="TControlBorderSpacing.GetSpace"/>
 
3045
      <element name="TControlBorderSpacing.GetSpace.Result">
 
3046
        <short/>
 
3047
      </element>
 
3048
      <element name="TControlBorderSpacing.GetSpace.Kind">
 
3049
        <short/>
 
3050
      </element>
 
3051
      <!-- function Visibility: public -->
 
3052
      <element name="TControlBorderSpacing.GetSideSpace">
 
3053
        <short>The space on a control side, including Around space.</short>
 
3054
        <descr/>
 
3055
        <errors/>
 
3056
        <seealso>
 
3057
          <link id="TControlBorderSpacing.GetSpace"/>
 
3058
        </seealso>
 
3059
      </element>
 
3060
      <element name="TControlBorderSpacing.GetSideSpace.Result">
 
3061
        <short>The space value.</short>
 
3062
      </element>
 
3063
      <element name="TControlBorderSpacing.GetSideSpace.Kind">
 
3064
        <short>The requested edge.</short>
 
3065
      </element>
 
3066
      <!-- property Visibility: published -->
 
3067
      <element name="TControlBorderSpacing.Around">
 
3068
        <short>The space to add to every side's individual space.</short>
 
3069
        <descr/>
 
3070
        <seealso/>
 
3071
      </element>
 
3072
      <!-- property Visibility: published -->
 
3073
      <element name="TControlBorderSpacing.Bottom">
 
3074
        <short>The space at the bottom border.</short>
 
3075
        <descr/>
 
3076
        <seealso/>
 
3077
      </element>
 
3078
      <!-- property Visibility: published -->
 
3079
      <element name="TControlBorderSpacing.CellAlignHorizontal">
 
3080
        <short>The horizontal alignment inside a table cell.</short>
 
3081
        <descr/>
 
3082
        <seealso/>
 
3083
      </element>
 
3084
      <!-- property Visibility: published -->
 
3085
      <element name="TControlBorderSpacing.CellAlignVertical">
 
3086
        <short>The vertical alignment inside a table cell.</short>
 
3087
        <descr/>
 
3088
        <seealso/>
 
3089
      </element>
 
3090
      <!-- property Visibility: public -->
 
3091
      <element name="TControlBorderSpacing.Control">
 
3092
        <short>The control to which this border spacing applies.</short>
 
3093
        <descr/>
 
3094
        <seealso/>
 
3095
      </element>
 
3096
      <!-- property Visibility: published -->
 
3097
      <element name="TControlBorderSpacing.InnerBorder">
 
3098
        <short>Space added to the widget's <link id="TControl.GetPreferredSize">preferred size</link>.</short>
 
3099
        <descr>
 
3100
          <p>When <link id="TControl.GetPreferredSize">calculating the preferred size</link> of control,
 
3101
            the LCL asks the widget first.
 
3102
          </p>
 
3103
          <p>When the widget returns a preferred size, e.g. a TButton widget,
 
3104
            then the InnerBorder is added twice to this size - e.g. to the Height for top and bottom space.
 
3105
          </p>
 
3106
          <p>If the widget does not return a preferred size, the InnerBorder has no effect.
 
3107
          </p>
 
3108
        </descr>
 
3109
        <seealso/>
 
3110
      </element>
 
3111
      <!-- property Visibility: published -->
 
3112
      <element name="TControlBorderSpacing.Left">
 
3113
        <short>The space at the left border.</short>
 
3114
        <descr/>
 
3115
        <seealso/>
 
3116
      </element>
 
3117
      <!-- property Visibility: published -->
 
3118
      <element name="TControlBorderSpacing.OnChange">
 
3119
        <short>Event handler for a change in border spacing.</short>
 
3120
        <descr/>
 
3121
        <seealso/>
 
3122
      </element>
 
3123
      <!-- property Visibility: published -->
 
3124
      <element name="TControlBorderSpacing.Right">
 
3125
        <short>The space at the right border.</short>
 
3126
        <descr/>
 
3127
        <seealso/>
 
3128
      </element>
 
3129
      <!-- property Visibility: public -->
 
3130
      <element name="TControlBorderSpacing.Space">
 
3131
        <short>Kind of array access to the space at every side.</short>
 
3132
        <descr/>
 
3133
        <seealso/>
 
3134
      </element>
 
3135
      <element name="TControlBorderSpacing.Space.Kind">
 
3136
        <short>The side for which the space is requested.</short>
 
3137
      </element>
 
3138
      <!-- property Visibility: published -->
 
3139
      <element name="TControlBorderSpacing.Top">
 
3140
        <short>The space at the top border.</short>
 
3141
        <descr/>
 
3142
        <seealso/>
 
3143
      </element>
 
3144
      <!-- object Visibility: default -->
 
3145
      <element name="TAnchorSide">
 
3146
        <short>Specifies how the side of a control is anchored to other controls.</short>
 
3147
        <descr>
 
3148
          <pre>TAnchorSide
 
3149
 
 
3150
    Class holding the reference sides of the anchors of a TControl.
 
3151
    Every TControl has four AnchorSides:
 
3152
    AnchorSide[akLeft], AnchorSide[akRight], AnchorSide[akTop] and
 
3153
    AnchorSide[akBottom].
 
3154
    Normally if Anchors contain akLeft, and the Parent is resized, the LCL
 
3155
    tries to keep the distance between the left side of the control and the
 
3156
    right side of its parent client area.
 
3157
    With AnchorSide[akLeft] you can define a different reference side. The
 
3158
    kept distance is defined by the BorderSpacing.
 
3159
    
 
3160
    Example1:
 
3161
       +-----+  +-----+
 
3162
       |  B  |  |  C  |
 
3163
       |     |  +-----+
 
3164
       +-----+
 
3165
 
 
3166
      If you want to have the top of B the same as the top of C use
 
3167
        B.AnchorSide[akTop].Side:=asrTop;
 
3168
        B.AnchorSide[akTop].Control:=C;
 
3169
      If you want to keep a distance of 10 pixels between B and C use
 
3170
        B.BorderSpacing.Right:=10;
 
3171
        B.AnchorSide[akRight].Side:=asrLeft;
 
3172
        B.AnchorSide[akRight].Control:=C;
 
3173
 
 
3174
      Do not setup in both directions, because this will create a circle, and
 
3175
      circles are not allowed.
 
3176
      
 
3177
    Example2:
 
3178
            +-------+
 
3179
      +---+ |       |
 
3180
      | A | |   B   |
 
3181
      +---+ |       |
 
3182
            +-------+
 
3183
            
 
3184
      Centering A relative to B:
 
3185
        A.AnchorSide[akTop].Side:=asrCenter;
 
3186
        A.AnchorSide[akTop].Control:=B;
 
3187
      Or use this. It's equivalent:
 
3188
        A.AnchorSide[akBottom].Side:=asrCenter;
 
3189
        A.AnchorSide[akBottom].Control:=B;
 
3190
</pre>
 
3191
        </descr>
 
3192
        <errors/>
 
3193
        <seealso/>
 
3194
      <notes><note>Make this an topic, describing *everything* related to anchoring?</note>
 
3195
        </notes>
 
3196
      </element>
 
3197
      <!-- variable Visibility: private -->
 
3198
      <element name="TAnchorSide.FControl"/>
 
3199
      <element name="TAnchorSide.FKind"/>
 
3200
      <element name="TAnchorSide.FOwner"/>
 
3201
      <element name="TAnchorSide.FSide"/>
 
3202
      <!-- function Visibility: private -->
 
3203
      <element name="TAnchorSide.IsSideStored"/>
 
3204
      <element name="TAnchorSide.IsSideStored.Result">
 
3205
        <short/>
 
3206
      </element>
 
3207
      <!-- procedure Visibility: private -->
 
3208
      <element name="TAnchorSide.SetControl"/>
 
3209
      <element name="TAnchorSide.SetControl.AValue">
 
3210
        <short/>
 
3211
      </element>
 
3212
      <!-- procedure Visibility: private -->
 
3213
      <element name="TAnchorSide.SetSide"/>
 
3214
      <element name="TAnchorSide.SetSide.AValue">
 
3215
        <short/>
 
3216
      </element>
 
3217
      <!-- function Visibility: protected -->
 
3218
      <element name="TAnchorSide.GetOwner"/>
 
3219
      <element name="TAnchorSide.GetOwner.Result">
 
3220
        <short/>
 
3221
      </element>
 
3222
      <!-- constructor Visibility: public -->
 
3223
      <element name="TAnchorSide.Create"/>
 
3224
      <element name="TAnchorSide.Create.TheOwner">
 
3225
        <short/>
 
3226
      </element>
 
3227
      <element name="TAnchorSide.Create.TheKind">
 
3228
        <short/>
 
3229
      </element>
 
3230
      <!-- destructor Visibility: public -->
 
3231
      <element name="TAnchorSide.Destroy"/>
 
3232
      <!-- procedure Visibility: public -->
 
3233
      <element name="TAnchorSide.GetSidePosition">
 
3234
        <short>Get information about the target control, side and side position.</short>
 
3235
        <descr/>
 
3236
        <errors/>
 
3237
        <seealso/>
 
3238
      </element>
 
3239
      <element name="TAnchorSide.GetSidePosition.ReferenceControl">
 
3240
        <short>The control we are anchored to.</short>
 
3241
      </element>
 
3242
      <element name="TAnchorSide.GetSidePosition.ReferenceSide">
 
3243
        <short>The side we are anchord to.</short>
 
3244
      </element>
 
3245
      <element name="TAnchorSide.GetSidePosition.Position">
 
3246
        <short>Position of the side to anchor to.</short>
 
3247
      </element>
 
3248
      <!-- function Visibility: public -->
 
3249
      <element name="TAnchorSide.CheckSidePosition">
 
3250
        <short>Check for anchor cycles and invalid targets, and return information about the target side.</short>
 
3251
        <descr/>
 
3252
        <errors/>
 
3253
          Can raise an exception 'TAnchorSide.CheckSidePosition invalid Side'.
 
3254
        
 
3255
        
 
3256
        <seealso/>
 
3257
      </element>
 
3258
      <element name="TAnchorSide.CheckSidePosition.Result">
 
3259
        <short>False when errors have been found.</short>
 
3260
      </element>
 
3261
      <element name="TAnchorSide.CheckSidePosition.NewControl">
 
3262
        <short/>
 
3263
      <notes><note>?</note>
 
3264
        </notes>
 
3265
      </element>
 
3266
      <element name="TAnchorSide.CheckSidePosition.NewSide">
 
3267
        <short/>
 
3268
      <notes><note>?</note>
 
3269
        </notes>
 
3270
      </element>
 
3271
      <element name="TAnchorSide.CheckSidePosition.ReferenceControl">
 
3272
        <short>The control we are anchored to.</short>
 
3273
      </element>
 
3274
      <element name="TAnchorSide.CheckSidePosition.ReferenceSide">
 
3275
        <short>The side we are anchord to.</short>
 
3276
      </element>
 
3277
      <element name="TAnchorSide.CheckSidePosition.Position">
 
3278
        <short>Position of the side to anchor to.</short>
 
3279
      </element>
 
3280
      <!-- procedure Visibility: public -->
 
3281
      <element link="#rtl.Classes.TPersistent.Assign" name="TAnchorSide.Assign"/>
 
3282
      <element name="TAnchorSide.Assign.Source">
 
3283
        <short/>
 
3284
      </element>
 
3285
      <!-- function Visibility: public -->
 
3286
      <element name="TAnchorSide.IsAnchoredToParent">
 
3287
        <short>True when we are anchored to our parent, at least on ParentSide</short>
 
3288
        <descr/>
 
3289
        <errors/>
 
3290
        <seealso/>
 
3291
      <notes><note>?</note>
 
3292
        </notes>
 
3293
      </element>
 
3294
      <element name="TAnchorSide.IsAnchoredToParent.Result">
 
3295
        <short/>
 
3296
      <notes><note>?</note>
 
3297
        </notes>
 
3298
      </element>
 
3299
      <element name="TAnchorSide.IsAnchoredToParent.ParentSide">
 
3300
        <short/>
 
3301
      <notes><note>?</note>
 
3302
        </notes>
 
3303
      </element>
 
3304
      <!-- procedure Visibility: public -->
 
3305
      <element name="TAnchorSide.FixCenterAnchoring">
 
3306
        <short>Remove conflicting anchors.</short>
 
3307
        <descr>With asrCenter, both sides are controlled by one anchor.
 
3308
          Disable opposite anchor and all aligning.
 
3309
        </descr>
 
3310
        <errors/>
 
3311
        <seealso/>
 
3312
      </element>
 
3313
      <!-- property Visibility: public -->
 
3314
      <element name="TAnchorSide.Owner">
 
3315
        <short>The control being anchored.</short>
 
3316
        <descr>For example AButton1.AnchorSide[akBottom].Owner = AButton1.</descr>
 
3317
        <seealso/>
 
3318
      </element>
 
3319
      <!-- property Visibility: public -->
 
3320
      <element name="TAnchorSide.Kind">
 
3321
        <short>The control side being anchored.</short>
 
3322
        <descr>Every control has four AnchorSide, one for each side. For example AButton1.AnchorSide[akLeft].Kind=akLeft.</descr>
 
3323
        <seealso/>
 
3324
      </element>
 
3325
      <!-- property Visibility: published -->
 
3326
      <element name="TAnchorSide.Control">
 
3327
        <short>The target control of the anchor.</short>
 
3328
        <descr>For example if the right side of a Button1 is anchored to the left side of Edit1,
 
3329
          then Button1.AnchorSide[akRight].Control=Edit1 and Button1.AnchorSide[akRight].Side=asrLeft.</descr>
 
3330
        <seealso/>
 
3331
      </element>
 
3332
      <!-- property Visibility: published -->
 
3333
      <element name="TAnchorSide.Side">
 
3334
        <short>The side of the target Control, to which we anchor.</short>
 
3335
        <descr>For example if the right side of a Button1 is anchored to the left side of Edit1,
 
3336
          then Button1.AnchorSide[akRight].Control=Edit1 and Button1.AnchorSide[akRight].Side=asrLeft.</descr>
 
3337
        <seealso/>
 
3338
      </element>
 
3339
      <!-- object Visibility: default -->
 
3340
      <element name="TControlActionLink">
 
3341
        <short>Links an Action to a control.</short>
 
3342
        <descr>
 
3343
          <p>An ActionLink is created by a control, when an Action is assigned to the control.
 
3344
            TControl.Action effectively becomes control.ActionLink.Action.
 
3345
          </p>
 
3346
          <p>The ActionLink propagates changes of Action properties to the client control.
 
3347
            It's assumed that properties of the <b>same value</b> (in the Control and Action) are linked to the Action,
 
3348
            and follow changes to the Action properties.
 
3349
          </p>
 
3350
          <p>Linked control properties are (by default):
 
3351
          </p>
 
3352
          <ul>
 
3353
            <li>Caption</li>
 
3354
            <li>Enabled</li>
 
3355
            <li>Hint</li>
 
3356
            <li>HelpContext, HelpKeyword, HelpType: these are linked only if all three property values match.</li>
 
3357
            <li>Visible</li>
 
3358
            <li>OnClick is linked to Action.Execute</li>
 
3359
          </ul>
 
3360
          <p>The control can update itself, when it receives a Change notification from the ActionLink
 
3361
            <link id="TControl.ActionChange"/>.
 
3362
          </p>
 
3363
        </descr>
 
3364
        <errors/>
 
3365
        <seealso/>
 
3366
      </element>
 
3367
      <!-- variable Visibility: protected -->
 
3368
      <element name="TControlActionLink.FClient">
 
3369
        <short>The client control that is linked to the action.</short>
 
3370
        <descr>It can be assumed that FClient is not Nil.</descr>
 
3371
      </element>
 
3372
      <!-- procedure Visibility: protected -->
 
3373
      <element link="#rtl.Classes.TBasicActionLink.AssignClient" name="TControlActionLink.AssignClient">
 
3374
        <short>Called during construction, sets FClient to the given control.</short>
 
3375
      </element>
 
3376
      <element name="TControlActionLink.AssignClient.AClient">
 
3377
        <short>The control linked to the action.</short>
 
3378
      </element>
 
3379
      <!-- function Visibility: protected -->
 
3380
      <element link="#LCL.ActnList.TActionLink.IsCaptionLinked" name="TControlActionLink.IsCaptionLinked"/>
 
3381
      <element name="TControlActionLink.IsCaptionLinked.Result">
 
3382
        <short/>
 
3383
      </element>
 
3384
      <!-- function Visibility: protected -->
 
3385
      <element link="#LCL.ActnList.TActionLink.IsEnabledLinked" name="TControlActionLink.IsEnabledLinked"/>
 
3386
      <element name="TControlActionLink.IsEnabledLinked.Result">
 
3387
        <short/>
 
3388
      </element>
 
3389
      <!-- function Visibility: protected -->
 
3390
      <element link="#LCL.ActnList.TActionLink.IsHelpLinked" name="TControlActionLink.IsHelpLinked">
 
3391
        <short>Help properties are assumed linked only when all these properties match.</short>
 
3392
        <descr>Compares the HelpContext, HelpKeyword and HelpType properties.</descr>
 
3393
      </element>
 
3394
      <element name="TControlActionLink.IsHelpLinked.Result">
 
3395
        <short>True only if all three Control properties match the Action properties.</short>
 
3396
      </element>
 
3397
      <!-- function Visibility: protected -->
 
3398
      <element link="#LCL.ActnList.TActionLink.IsHintLinked" name="TControlActionLink.IsHintLinked"/>
 
3399
      <element name="TControlActionLink.IsHintLinked.Result">
 
3400
        <short/>
 
3401
      </element>
 
3402
      <!-- function Visibility: protected -->
 
3403
      <element link="#LCL.ActnList.TActionLink.IsVisibleLinked" name="TControlActionLink.IsVisibleLinked"/>
 
3404
      <element name="TControlActionLink.IsVisibleLinked.Result">
 
3405
        <short/>
 
3406
      </element>
 
3407
      <!-- function Visibility: protected -->
 
3408
      <element name="TControlActionLink.IsOnExecuteLinked">
 
3409
        <short>True if the client's OnClick is the action's OnExecute handler.</short>
 
3410
        <descr/>
 
3411
        <errors/>
 
3412
        <seealso/>
 
3413
      </element>
 
3414
      <element name="TControlActionLink.IsOnExecuteLinked.Result">
 
3415
        <short/>
 
3416
      </element>
 
3417
      <!-- function Visibility: protected -->
 
3418
      <element name="TControlActionLink.DoShowHint">
 
3419
        <short>Compose the hint string, depending on HintShortCuts.</short>
 
3420
        <descr/>
 
3421
        <errors/>
 
3422
        <seealso>
 
3423
          <link id="#LCL.Forms.TApplication.HintShortCuts"/>
 
3424
        </seealso>
 
3425
      </element>
 
3426
      <element name="TControlActionLink.DoShowHint.Result">
 
3427
        <short>Always True.</short>
 
3428
      </element>
 
3429
      <element name="TControlActionLink.DoShowHint.HintStr">
 
3430
        <short>The hint to show.</short>
 
3431
      </element>
 
3432
      <!-- procedure Visibility: protected -->
 
3433
      <element name="TControlActionLink.SetCaption">
 
3434
        <short>Sets the client's Caption, if the old values match.
 
3435
        </short>
 
3436
        <descr/>
 
3437
        <errors/>
 
3438
        <seealso>
 
3439
          <link id="#LCL.ActnList.TActionLink.SetCaption">TActionLink.SetCaption</link>
 
3440
        </seealso>
 
3441
      </element>
 
3442
      <element name="TControlActionLink.SetCaption.Value">
 
3443
        <short/>
 
3444
      </element>
 
3445
      <!-- procedure Visibility: protected -->
 
3446
      <element name="TControlActionLink.SetEnabled">
 
3447
        <short>Sets client's Enabled, if the old values match.
 
3448
        </short>
 
3449
        <descr/>
 
3450
        <errors/>
 
3451
        <seealso/>
 
3452
      </element>
 
3453
      <element name="TControlActionLink.SetEnabled.Value">
 
3454
        <short/>
 
3455
      </element>
 
3456
      <!-- procedure Visibility: protected -->
 
3457
      <element name="TControlActionLink.SetHint">
 
3458
        <short>Sets client's Hint, if the old values match.
 
3459
        </short>
 
3460
        <descr/>
 
3461
        <errors/>
 
3462
        <seealso/>
 
3463
      </element>
 
3464
      <element name="TControlActionLink.SetHint.Value">
 
3465
        <short/>
 
3466
      </element>
 
3467
      <!-- procedure Visibility: protected -->
 
3468
      <element name="TControlActionLink.SetHelpContext">
 
3469
        <short>Sets client's HelpContext, if the old Help properties match (IsHelpLinked).
 
3470
        </short>
 
3471
        <descr/>
 
3472
        <errors/>
 
3473
        <seealso/>
 
3474
      </element>
 
3475
      <element name="TControlActionLink.SetHelpContext.Value">
 
3476
        <short/>
 
3477
      </element>
 
3478
      <!-- procedure Visibility: protected -->
 
3479
      <element name="TControlActionLink.SetHelpKeyword">
 
3480
        <short>Sets client's HelpKeyword, if the old Help properties match (IsHelpLinked).
 
3481
        </short>
 
3482
        <descr/>
 
3483
        <errors/>
 
3484
        <seealso/>
 
3485
      </element>
 
3486
      <element name="TControlActionLink.SetHelpKeyword.Value">
 
3487
        <short/>
 
3488
      </element>
 
3489
      <!-- procedure Visibility: protected -->
 
3490
      <element name="TControlActionLink.SetHelpType">
 
3491
        <short>Sets client's HelpType, if the old Help properties match (IsHelpLinked).
 
3492
        </short>
 
3493
        <descr/>
 
3494
        <errors/>
 
3495
        <seealso/>
 
3496
      </element>
 
3497
      <element name="TControlActionLink.SetHelpType.Value">
 
3498
        <short/>
 
3499
      </element>
 
3500
      <!-- procedure Visibility: protected -->
 
3501
      <element name="TControlActionLink.SetVisible">
 
3502
        <short>Sets client's Visible, if the old values match.
 
3503
        </short>
 
3504
        <descr/>
 
3505
        <errors/>
 
3506
        <seealso/>
 
3507
      </element>
 
3508
      <element name="TControlActionLink.SetVisible.Value">
 
3509
        <short/>
 
3510
      </element>
 
3511
      <!-- procedure Visibility: protected -->
 
3512
      <element name="TControlActionLink.SetOnExecute">
 
3513
        <short>Set client's OnClick, if the old values match.
 
3514
        </short>
 
3515
        <descr/>
 
3516
        <errors/>
 
3517
        <seealso/>
 
3518
      </element>
 
3519
      <element name="TControlActionLink.SetOnExecute.Value">
 
3520
        <short/>
 
3521
      </element>
 
3522
      <!-- "class of" type Visibility: default -->
 
3523
      <element link="TControlActionLink" name="TControlActionLinkClass">
 
3524
        <short>Class of <link id="TControlActionLink"/>.
 
3525
        </short>
 
3526
        <descr/>
 
3527
        <seealso/>
 
3528
      </element>
 
3529
      <!-- enumeration type Visibility: default -->
 
3530
      <element name="TControlAutoSizePhase">
 
3531
        <short/>
 
3532
        <descr/>
 
3533
        <seealso/>
 
3534
      <notes><note>?</note>
 
3535
        </notes>
 
3536
      </element>
 
3537
      <!-- enumeration value Visibility: default -->
 
3538
      <element name="TControlAutoSizePhase.caspNone">
 
3539
        <short/>
 
3540
      <notes><note>?</note>
 
3541
        </notes>
 
3542
      </element>
 
3543
      <!-- enumeration value Visibility: default -->
 
3544
      <element name="TControlAutoSizePhase.caspChangingProperties">
 
3545
        <short/>
 
3546
      <notes><note>?</note>
 
3547
        </notes>
 
3548
      </element>
 
3549
      <!-- enumeration value Visibility: default -->
 
3550
      <element name="TControlAutoSizePhase.caspCreatingHandles">
 
3551
        <short>create/destroy handles</short>
 
3552
      </element>
 
3553
      <!-- enumeration value Visibility: default -->
 
3554
      <element name="TControlAutoSizePhase.caspComputingBounds">
 
3555
        <short/>
 
3556
      <notes><note>?</note>
 
3557
        </notes>
 
3558
      </element>
 
3559
      <!-- enumeration value Visibility: default -->
 
3560
      <element name="TControlAutoSizePhase.caspRealizingBounds">
 
3561
        <short/>
 
3562
      <notes><note>?</note>
 
3563
        </notes>
 
3564
      </element>
 
3565
      <!-- enumeration value Visibility: default -->
 
3566
      <element name="TControlAutoSizePhase.caspShowing">
 
3567
        <short>make handles visible</short>
 
3568
      <notes><note>?</note>
 
3569
        </notes>
 
3570
      </element>
 
3571
      <!-- set type Visibility: default -->
 
3572
      <element link="TControlAutoSizePhase" name="TControlAutoSizePhases"/>
 
3573
      <!-- constant Visibility: default -->
 
3574
      <element link="TControlAutoSizePhase" name="AutoSizePhaseNames">
 
3575
        <short>Names for TControlAutoSizePhase.</short>
 
3576
      </element>
 
3577
      <!-- range type Visibility: default -->
 
3578
      <element name="TTabOrder">
 
3579
        <short>Type of <link id="TWinControl.TabOrder"/>.</short>
 
3580
        <descr/>
 
3581
        <seealso/>
 
3582
      </element>
 
3583
      <!-- procedure type Visibility: default -->
 
3584
      <element name="TControlShowHintEvent">
 
3585
        <short>Handler type for OnShowHint.</short>
 
3586
        <descr/>
 
3587
        <seealso/>
 
3588
      </element>
 
3589
      <element name="TControlShowHintEvent.Sender">
 
3590
        <short/>
 
3591
      <notes><note>?</note>
 
3592
        </notes>
 
3593
      </element>
 
3594
      <element name="TControlShowHintEvent.HintInfo">
 
3595
        <short/>
 
3596
      <notes><note>?</note>
 
3597
        </notes>
 
3598
      </element>
 
3599
      <!-- procedure type Visibility: default -->
 
3600
      <element name="TContextPopupEvent">
 
3601
        <short>Handler type for OnContextPopup.</short>
 
3602
        <descr/>
 
3603
        <seealso/>
 
3604
      </element>
 
3605
      <element name="TContextPopupEvent.Sender">
 
3606
        <short>The clicked control.</short>
 
3607
      </element>
 
3608
      <element name="TContextPopupEvent.MousePos">
 
3609
        <short>Mouse position in client coordinates; (-1,-1) if the event was not generated by a click.</short>
 
3610
      </element>
 
3611
      <element name="TContextPopupEvent.Handled">
 
3612
        <short>Set Handled to True when everything was handled; False shows the associated PopupMenu, by default.</short>
 
3613
      </element>
 
3614
      <!-- enumeration type Visibility: default -->
 
3615
      <element name="TControlFlag">
 
3616
        <short>Flags mostly for pending actions.</short>
 
3617
        <descr/>
 
3618
        <seealso/>
 
3619
      </element>
 
3620
      <element name="TControlFlag.cfLoading">
 
3621
        <short>set by TControl.ReadState, unset by TControl.Loaded when all on form finished loading</short>
 
3622
      </element>
 
3623
      <element name="TControlFlag.cfAutoSizeNeeded">
 
3624
        <short>Set when AutoSize was delayed</short>
 
3625
      <notes><note>?</note>
 
3626
        </notes>
 
3627
      </element>
 
3628
      <element name="TControlFlag.cfLeftLoaded">
 
3629
        <short>Set when Left was set during loading.</short>
 
3630
      </element>
 
3631
      <element name="TControlFlag.cfTopLoaded">
 
3632
        <short>Set when Top was set during loading.</short>
 
3633
      </element>
 
3634
      <element name="TControlFlag.cfWidthLoaded">
 
3635
        <short>Set when Width was set during loading.</short>
 
3636
      </element>
 
3637
      <element name="TControlFlag.cfHeightLoaded">
 
3638
        <short>Set when Height was set during loading.</short>
 
3639
      </element>
 
3640
      <element name="TControlFlag.cfClientWidthLoaded">
 
3641
        <short>Set when ClientWidth was set during loading.</short>
 
3642
      </element>
 
3643
      <element name="TControlFlag.cfClientHeightLoaded">
 
3644
        <short>Set when ClientHeight was set during loading.</short>
 
3645
      </element>
 
3646
      <element name="TControlFlag.cfBoundsRectForNewParentValid">
 
3647
        <short>Set when BoundsRectForNewParent has been initialized.</short>
 
3648
      </element>
 
3649
      <element name="TControlFlag.cfBaseBoundsValid">
 
3650
        <short/>
 
3651
      <notes><note>?</note>
 
3652
        </notes>
 
3653
      </element>
 
3654
      <element name="TControlFlag.cfPreferredSizeValid">
 
3655
        <short>Set when PreferredSize has been calculated (CalculatePreferredSize).</short>
 
3656
      </element>
 
3657
      <element name="TControlFlag.cfPreferredMinSizeValid">
 
3658
        <short/>
 
3659
      <notes><note>?</note>
 
3660
        </notes>
 
3661
      </element>
 
3662
      <element name="TControlFlag.cfOnChangeBoundsNeeded">
 
3663
        <short/>
 
3664
      <notes><note>?</note>
 
3665
        </notes>
 
3666
      </element>
 
3667
      <element name="TControlFlag.cfProcessingWMPaint">
 
3668
        <short>Set (in WndProc) while processing an LM_PAINT message.</short>
 
3669
      </element>
 
3670
      <element name="TControlFlag.cfKillChangeBounds">
 
3671
        <short/>
 
3672
      <notes><note>?</note>
 
3673
        </notes>
 
3674
      </element>
 
3675
      <element name="TControlFlag.cfKillInvalidatePreferredSize">
 
3676
        <short/>
 
3677
      <notes><note>?</note>
 
3678
        </notes>
 
3679
      </element>
 
3680
      <element name="TControlFlag.cfKillAdjustSize">
 
3681
        <short/>
 
3682
      <notes><note>?</note>
 
3683
        </notes>
 
3684
      </element>
 
3685
      <!-- set type Visibility: default -->
 
3686
      <element link="TControlFlag" name="TControlFlags"/>
 
3687
      <!-- enumeration type Visibility: default -->
 
3688
      <element name="TControlHandlerType">
 
3689
        <short>Notification handler types.</short>
 
3690
        <descr>Notification handlers only receive an Sender, and must know themselves why they have been invoked.</descr>
 
3691
        <seealso/>
 
3692
      </element>
 
3693
      <element name="TControlHandlerType.chtOnResize">
 
3694
        <short>Notification request for OnResize.</short>
 
3695
      </element>
 
3696
      <element name="TControlHandlerType.chtOnChangeBounds">
 
3697
        <short>Notification request for OnChangeBounds.</short>
 
3698
      </element>
 
3699
      <element name="TControlHandlerType.chtOnVisibleChanging">
 
3700
        <short>Notification request for OnVisibleChanging.</short>
 
3701
      </element>
 
3702
      <element name="TControlHandlerType.chtOnVisibleChanged">
 
3703
        <short>Notification request for OnVisibleChanged.</short>
 
3704
      </element>
 
3705
      <element name="TControlHandlerType.chtOnEnabledChanging">
 
3706
        <short>Notification request for OnEnabledChanging.</short>
 
3707
      </element>
 
3708
      <element name="TControlHandlerType.chtOnEnabledChanged">
 
3709
        <short>Notification request for OnEnabledChanged.</short>
 
3710
      </element>
 
3711
      <element name="TControlHandlerType.chtOnKeyDown">
 
3712
        <short>Notification request for OnKeyDown.</short>
 
3713
      </element>
 
3714
      <!-- enumeration type Visibility: default -->
 
3715
      <element name="TLayoutAdjustmentPolicy">
 
3716
        <short>Indicates the policy for the LCL to execute automatic adjustments in the form layout</short>
 
3717
        <descr/>
 
3718
        <seealso/>
 
3719
      </element>
 
3720
      <!-- enumeration value Visibility: default -->
 
3721
      <element name="TLazAccessibilityRole.lapDefault">
 
3722
        <short>widgetset dependent</short>
 
3723
      </element>
 
3724
      <!-- enumeration value Visibility: default -->
 
3725
      <element name="TLazAccessibilityRole.lapFixedLayout">
 
3726
        <short>A fixed absolute layout in all platforms</short>
 
3727
      </element>
 
3728
      <!-- enumeration value Visibility: default -->
 
3729
      <element name="TLazAccessibilityRole.lapAutoAdjustWithoutHorizontalScrolling">
 
3730
        <short>Smartphone platforms use this one, the x axis is stretched to fill the screen and the y is scaled to fit the DPI</short>
 
3731
      </element>
 
3732
      <!-- enumeration value Visibility: default -->
 
3733
      <element name="TLazAccessibilityRole.lapAutoAdjustForDPI">
 
3734
        <short>For desktops using High DPI, scale x and y to fit the DPI</short>
 
3735
      </element>
 
3736
      <!-- enumeration type Visibility: default -->
 
3737
      <element name="TLazAccessibilityRole">
 
3738
        <short>Indicates the role which a accessible object takes in the user interface</short>
 
3739
        <descr/>
 
3740
        <seealso>
 
3741
          <link id="TLazAccessibleObject"/>
 
3742
        </seealso>
 
3743
      </element>
 
3744
      <!-- enumeration value Visibility: default -->
 
3745
      <element name="TLazAccessibilityRole.larAnimation">
 
3746
        <short>An object that displays an animation</short>
 
3747
      </element>
 
3748
      <!-- enumeration value Visibility: default -->
 
3749
      <element name="TLazAccessibilityRole.larButton">
 
3750
        <short>A button</short>
 
3751
      </element>
 
3752
      <!-- enumeration value Visibility: default -->
 
3753
      <element name="TLazAccessibilityRole.larCell">
 
3754
        <short>A cell in a table</short>
 
3755
      </element>
 
3756
      <!-- enumeration value Visibility: default -->
 
3757
      <element name="TLazAccessibilityRole.larChart">
 
3758
        <short>An object that displays a graphical representation of data</short>
 
3759
      </element>
 
3760
      <!-- enumeration value Visibility: default -->
 
3761
      <element name="TLazAccessibilityRole.larCheckBox">
 
3762
        <short>An object that can be checked or unchecked, or sometimes in an intermediary state</short>
 
3763
      </element>
 
3764
      <!-- enumeration value Visibility: default -->
 
3765
      <element name="TLazAccessibilityRole.larClock">
 
3766
        <short>A clock displaying time</short>
 
3767
      </element>
 
3768
      <!-- enumeration value Visibility: default -->
 
3769
      <element name="TLazAccessibilityRole.larColorPicker">
 
3770
        <short>A control which allows selecting a color</short>
 
3771
      </element>
 
3772
      <!-- enumeration value Visibility: default -->
 
3773
      <element name="TLazAccessibilityRole.larComboBox">
 
3774
        <short>A list of choices that the user can select from</short>
 
3775
      </element>
 
3776
      <!-- enumeration value Visibility: default -->
 
3777
      <element name="TLazAccessibilityRole.larDateField">
 
3778
        <short>A controls which displays and possibly allows to choose a date</short>
 
3779
      </element>
 
3780
      <!-- enumeration value Visibility: default -->
 
3781
      <element name="TLazAccessibilityRole.larGrid">
 
3782
        <short>A grid control which displays cells</short>
 
3783
      </element>
 
3784
      <!-- enumeration value Visibility: default -->
 
3785
      <element name="TLazAccessibilityRole.larGroup">
 
3786
        <short>A control which groups others, such as a TGroupBox</short>
 
3787
      </element>
 
3788
      <!-- enumeration value Visibility: default -->
 
3789
      <element name="TLazAccessibilityRole.larIgnore">
 
3790
        <short>Something to be ignored. For example a blank space between other objects</short>
 
3791
      </element>
 
3792
      <!-- enumeration value Visibility: default -->
 
3793
      <element name="TLazAccessibilityRole.larImage">
 
3794
        <short>A graphic or picture or an icon</short>
 
3795
      </element>
 
3796
      <!-- enumeration value Visibility: default -->
 
3797
      <element name="TLazAccessibilityRole.larLabel">
 
3798
        <short>A text label as usually placed near other widgets</short>
 
3799
      </element>
 
3800
      <!-- enumeration value Visibility: default -->
 
3801
      <element name="TLazAccessibilityRole.larListBox">
 
3802
        <short>A list of items, from which the user can select one or more items</short>
 
3803
      </element>
 
3804
      <!-- enumeration value Visibility: default -->
 
3805
      <element name="TLazAccessibilityRole.larListItem">
 
3806
        <short>An item in a list of items</short>
 
3807
      </element>
 
3808
      <!-- enumeration value Visibility: default -->
 
3809
      <element name="TLazAccessibilityRole.larMenuBar">
 
3810
        <short>A main menu bar</short>
 
3811
      </element>
 
3812
      <!-- enumeration value Visibility: default -->
 
3813
      <element name="TLazAccessibilityRole.larMenuItem">
 
3814
        <short>A item in a menu</short>
 
3815
      </element>
 
3816
      <!-- enumeration value Visibility: default -->
 
3817
      <element name="TLazAccessibilityRole.larProgressIndicator">
 
3818
        <short>A control which shows a progress indication</short>
 
3819
      </element>
 
3820
      <!-- enumeration value Visibility: default -->
 
3821
      <element name="TLazAccessibilityRole.larRadioButton">
 
3822
        <short>A radio button, see for example TRadioButton</short>
 
3823
      </element>
 
3824
      <!-- enumeration value Visibility: default -->
 
3825
      <element name="TLazAccessibilityRole.larResizeGrip">
 
3826
        <short>A grip that the user can drag to change the size of widgets</short>
 
3827
      </element>
 
3828
      <!-- enumeration value Visibility: default -->
 
3829
      <element name="TLazAccessibilityRole.larScrollBar">
 
3830
        <short>A control to scroll another one</short>
 
3831
      </element>
 
3832
      <!-- enumeration value Visibility: default -->
 
3833
      <element name="TLazAccessibilityRole.larSpinner">
 
3834
        <short>A control which allows to increment / decrement a value</short>
 
3835
      </element>
 
3836
      <!-- enumeration value Visibility: default -->
 
3837
      <element name="TLazAccessibilityRole.larTabControl">
 
3838
        <short>A control with tabs, like TPageControl</short>
 
3839
      </element>
 
3840
      <!-- enumeration value Visibility: default -->
 
3841
      <element name="TLazAccessibilityRole.larTextEditorMultiline">
 
3842
        <short>A multi-line text editor (for example: TMemo, SynEdit)</short>
 
3843
      </element>
 
3844
      <!-- enumeration value Visibility: default -->
 
3845
      <element name="TLazAccessibilityRole.larTextEditorSingleline">
 
3846
        <short>A single-line text editor (for example: TEdit)</short>
 
3847
      </element>
 
3848
      <!-- enumeration value Visibility: default -->
 
3849
      <element name="TLazAccessibilityRole.larTrackBar">
 
3850
        <short>A control which allows to drag a slider</short>
 
3851
      </element>
 
3852
      <!-- enumeration value Visibility: default -->
 
3853
      <element name="TLazAccessibilityRole.larTreeView">
 
3854
        <short>A list of items in a tree structure</short>
 
3855
      </element>
 
3856
      <!-- enumeration value Visibility: default -->
 
3857
      <element name="TLazAccessibilityRole.larTreeItem">
 
3858
        <short>An item in a tree structure</short>
 
3859
      </element>
 
3860
      <!-- enumeration value Visibility: default -->
 
3861
      <element name="TLazAccessibilityRole.larWindow">
 
3862
        <short>A top level window</short>
 
3863
      </element>
 
3864
      <!-- class Visibility: default -->
 
3865
      <element name="TLazAccessibleObject">
 
3866
        <short>Represents an accessible object with which the user of a accessibility tool can interact.</short>
 
3867
        <descr>
 
3868
          <p>Every TControl has a TLazAccessibleObject instace associated with it, which means that every TControl is potentially accessible, but to actually be usable the accessible object needs to have its properties set, the most important of which are the role, description and value. Native windowed classes should already receive accessibility properties from the underlying widgetset utilized, while TCustomControl descendents will have their accessibility taken care by the LCL itself. User applications should add accessibility for their own TCustomControl descendent classes and also possibly customize the descriptions of some elements. It is also possible to make an accessible object invisible for user, which is done by setting its AccessibleRole property to larIgnored.</p>
 
3869
          <p>Accessibility support in Lazarus is also documented in the wiki in http://wiki.lazarus.freepascal.org/LCL_Accessibility</p>
 
3870
        </descr>
 
3871
        <seealso>
 
3872
          <link id="TControl"/>
 
3873
          <link id="TControl.AccessibleRole"/>
 
3874
          <link id="TControl.AccessibleDescription"/>
 
3875
          <link id="TControl.AccessibleValue"/>
 
3876
          <link id="TLazAccessibilityRole"/>
 
3877
        </seealso>
 
3878
      </element>
 
3879
      <!-- variable Visibility: public -->
 
3880
      <element name="TLazAccessibleObject.OwnerControl">
 
3881
        <short>The control that this accessible object is attached to. It might be the main accessible object of this control or it might represent a sub-part of a control.</short>
 
3882
        <descr><p>The control that this accessible object is attached to. It might be the main accessible object of this control or it might represent a sub-part of a control which does not have a corresponding TControl, like an item of TTreeView. One can verify if this is the main accessible object of the control by checking if (lAccessibleObject.OwnerControl = lAccessibleObject.OwnerControl.GetAccessibleObject())</p>
 
3883
        </descr>
 
3884
        <seealso>
 
3885
          <link id="TControl.GetAccessibleObject"/>
 
3886
        </seealso>
 
3887
      </element>
 
3888
      <!-- variable Visibility: public -->
 
3889
      <element name="TLazAccessibleObject.Parent">
 
3890
        <short>The parent TLazAccessibleObject of this accessible object</short>
 
3891
      </element>
 
3892
      <!-- variable Visibility: public -->
 
3893
      <element name="TLazAccessibleObject.DataObject">
 
3894
        <short>Available to be used to connect to an object</short>
 
3895
      </element>
 
3896
      <!-- variable Visibility: public -->
 
3897
      <element name="TLazAccessibleObject.SecondaryHandle">
 
3898
        <short>Available for Widgetsets to use</short>
 
3899
      </element>
 
3900
      <element link="#rtl.System.TObject.Create" name="TLazAccessibleObject.Create"/>
 
3901
      <element link="#rtl.System.TObject.Destroy" name="TLazAccessibleObject.Destroy"/>
 
3902
      <!-- function Visibility: public -->
 
3903
      <element name="TLazAccessibleObject.HandleAllocated">
 
3904
        <short>Returns if the handle of this object was already allocated or not</short>
 
3905
      </element>
 
3906
      <!-- function Visibility: public -->
 
3907
      <element name="TLazAccessibleObject.InitializeHandle">
 
3908
        <short>Utilized to set all properties of this property via widgetset routines when creating the handle</short>
 
3909
      </element>
 
3910
      <!-- function Visibility: public -->
 
3911
      <element name="TLazAccessibleObject.SetAccessibleDescription">
 
3912
        <short>Setter for the property AccessibleDescription</short>
 
3913
      </element>
 
3914
      <!-- function Visibility: public -->
 
3915
      <element name="TLazAccessibleObject.SetAccessibleValue">
 
3916
        <short>Setter for the property AccessibleValue</short>
 
3917
      </element>
 
3918
      <!-- function Visibility: public -->
 
3919
      <element name="TLazAccessibleObject.SetAccessibleRole">
 
3920
        <short>Setter for the property AccessibleRole</short>
 
3921
      </element>
 
3922
      <!-- function Visibility: public -->
 
3923
      <element name="TLazAccessibleObject.FindOwnerWinControl">
 
3924
        <short>Inspect the tree of accessible objects upwards until it finds a parent which is attached directly to a windowed control, a TWinControl</short>
 
3925
      </element>
 
3926
      <!-- function Visibility: public -->
 
3927
      <element name="TLazAccessibleObject.AddChildAccessibleObject">
 
3928
        <short>Creates a new child accessible object and returns it</short>
 
3929
      </element>
 
3930
      <!-- function Visibility: public -->
 
3931
      <element name="TLazAccessibleObject.InsertChildAccessibleObject">
 
3932
        <short>Inserts an already created child accessible object as a child of this one</short>
 
3933
      </element>
 
3934
      <!-- function Visibility: public -->
 
3935
      <element name="TLazAccessibleObject.ClearChildAccessibleObjects">
 
3936
        <short>Removes all children of this control. It will free them if they are not attached to a TControl</short>
 
3937
      </element>
 
3938
      <!-- function Visibility: public -->
 
3939
      <element name="TLazAccessibleObject.RemoveChildAccessibleObject">
 
3940
        <short>Removes a child accessible object</short>
 
3941
      </element>
 
3942
      <!-- function Visibility: public -->
 
3943
      <element name="TLazAccessibleObject.GetChildAccessibleObject">
 
3944
        <short>Obtains a child accessible object by its index</short>
 
3945
      </element>
 
3946
      <!-- function Visibility: public -->
 
3947
      <element name="TLazAccessibleObject.GetChildAccessibleObject">
 
3948
        <short>Obtains a child accessible object by its index</short>
 
3949
      </element>
 
3950
      <!-- function Visibility: public -->
 
3951
      <element name="TLazAccessibleObject.GetChildAccessibleObjectWithDataObject">
 
3952
        <short>Obtains a child accessible object by its DataObject property</short>
 
3953
      </element>
 
3954
      <!-- function Visibility: public -->
 
3955
      <element name="TLazAccessibleObject.GetChildAccessibleObjectsCount">
 
3956
        <short>Returns the number of direct children that this accessible object has</short>
 
3957
      </element>
 
3958
      <!-- function Visibility: public -->
 
3959
      <element name="TLazAccessibleObject.GetSelectedChildAccessibleObject">
 
3960
        <short>Returns the currently selected child accessible object or nil if none are selected. Override this method in your sub class.</short>
 
3961
        <seealso>
 
3962
          <link id="TControl.GetSelectedChildAccessibleObject"/>
 
3963
        </seealso>
 
3964
      </element>
 
3965
      <!-- function Visibility: public -->
 
3966
      <element name="TLazAccessibleObject.GetChildAccessibleObjectAtPos">
 
3967
        <short>Returns the child of this control located at a particular position given as a client position of the control</short>
 
3968
        <seealso>
 
3969
          <link id="TControl.GetChildAccessibleObjectAtPos"/>
 
3970
        </seealso>
 
3971
      </element>
 
3972
      <!-- property Visibility: public -->
 
3973
      <element name="TLazAccessibleObject.AccessibleDescription">
 
3974
        <short>The description of this accessible object</short>
 
3975
        <seealso>
 
3976
          <link id="TControl.AccessibleDescription"/>
 
3977
        </seealso>
 
3978
      </element>
 
3979
      <!-- property Visibility: public -->
 
3980
      <element name="TLazAccessibleObject.AccessibleValue">
 
3981
        <short>The value of this accessible object</short>
 
3982
        <seealso>
 
3983
          <link id="TControl.AccessibleValue"/>
 
3984
        </seealso>
 
3985
      </element>
 
3986
      <!-- property Visibility: public -->
 
3987
      <element name="TLazAccessibleObject.AccessibleRole">
 
3988
        <short>The role of this accessible object</short>
 
3989
        <seealso>
 
3990
          <link id="TControl.AccessibleRole"/>
 
3991
        </seealso>
 
3992
      </element>
 
3993
      <!-- property Visibility: public -->
 
3994
      <element name="TLazAccessibleObject.Position">
 
3995
        <short>The position of this accessible object</short>
 
3996
      </element>
 
3997
      <!-- property Visibility: public -->
 
3998
      <element name="TLazAccessibleObject.Size">
 
3999
        <short>The size of this accessible object</short>
 
4000
      </element>
 
4001
      <!-- property Visibility: public -->
 
4002
      <element name="TLazAccessibleObject.Handle">
 
4003
        <short>The widgetset handle of this accessible object</short>
 
4004
      </element>
 
4005
      <!-- object Visibility: default -->
 
4006
      <element name="TControl">
 
4007
        <short>The base class for visible controls.</short>
 
4008
      </element>
 
4009
      <!-- variable Visibility: private -->
 
4010
      <element link="TControl.ActionLink" name="TControl.FActionLink"/>
 
4011
      <element link="TControl.Align" name="TControl.FAlign"/>
 
4012
      <element link="TControl.AnchoredControls" name="TControl.fAnchoredControls"/>
 
4013
      <element link="TControl.Anchors" name="TControl.FAnchors"/>
 
4014
      <element link="TControl.AnchorSides" name="TControl.FAnchorSides"/>
 
4015
      <element link="TControl.AutoSize" name="TControl.FAutoSize"/>
 
4016
      <element link="TControl.AutoSizingAll" name="TControl.FAutoSizingAll"/>
 
4017
      <element link="TControl.AutoSizingLockCount" name="TControl.FAutoSizingLockCount"/>
 
4018
      <element name="TControl.FAutoSizingSelf">
 
4019
        <short/>
 
4020
      <notes><note>?</note>
 
4021
        </notes>
 
4022
      </element>
 
4023
      <element link="TControl.BaseBounds" name="TControl.FBaseBounds"/>
 
4024
      <element name="TControl.FBaseBoundsLock">
 
4025
        <short/>
 
4026
      <notes><note>?</note>
 
4027
        </notes>
 
4028
      </element>
 
4029
      <element link="TControl.BaseParentClientSize" name="TControl.FBaseParentClientSize"/>
 
4030
      <element link="TControl.BiDiMode" name="TControl.FBiDiMode"/>
 
4031
      <element link="TControl.BorderSpacing" name="TControl.FBorderSpacing"/>
 
4032
      <element link="TControl.BoundsRectForNewParent" name="TControl.FBoundsRectForNewParent"/>
 
4033
      <element link="TControl.Caption" name="TControl.FCaption"/>
 
4034
      <element link="TControl.CaptureMouseBottons" name="TControl.FCaptureMouseButtons"/>
 
4035
      <element link="TControl.Color" name="TControl.FColor"/>
 
4036
      <!-- variable Visibility: public -->
 
4037
      <element name="TControl.FCompStyle">
 
4038
        <short>Deprecated, don't use it.</short>
 
4039
      </element>
 
4040
      <element link="TControl.Constraints" name="TControl.FConstraints"/>
 
4041
      <element link="TControlFlag" name="TControl.FControlFlags"/>
 
4042
      <element name="TControl.FControlHandlers">
 
4043
        <short>Array of the installable notification handlers.
 
4044
        </short>
 
4045
      </element>
 
4046
      <element link="TControl.ControlState" name="TControl.FControlState">
 
4047
        <short>State flags.
 
4048
        </short>
 
4049
      </element>
 
4050
      <element link="TControl.ControlStyle" name="TControl.FControlStyle"/>
 
4051
      <element link="TControl.Cursor" name="TControl.FCursor">
 
4052
        <short>The cursor shape for this control.
 
4053
        </short>
 
4054
      </element>
 
4055
      <element link="TControl.DesktopFont" name="TControl.FDesktopFont"/>
 
4056
      <element link="TControl.DockOrientation" name="TControl.FDockOrientation"/>
 
4057
      <element link="TControl.DragCursor" name="TControl.FDragCursor"/>
 
4058
      <element link="TControl.DragKind" name="TControl.FDragKind"/>
 
4059
      <element link="TControl.DragMode" name="TControl.FDragMode"/>
 
4060
      <element link="TControl.Enabled" name="TControl.FEnabled"/>
 
4061
      <element link="TControl.FloatingDockSiteClass" name="TControl.FFloatingDockSiteClass"/>
 
4062
      <element link="TControl.Font" name="TControl.FFont"/>
 
4063
      <element link="TControl.Height" name="TControl.FHeight"/>
 
4064
      <element link="TControl.HelpContext" name="TControl.FHelpContext"/>
 
4065
      <element link="TControl.HelpKeyword" name="TControl.FHelpKeyword"/>
 
4066
      <element link="TControl.HelpType" name="TControl.FHelpType"/>
 
4067
      <element link="TControl.Hint" name="TControl.FHint"/>
 
4068
      <element link="TControl.HostDockSite" name="TControl.FHostDockSite"/>
 
4069
      <element link="TControl.IsControl" name="TControl.FIsControl"/>
 
4070
      <element name="TControl.FLastDoChangeBounds"/>
 
4071
      <element name="TControl.FLastDoChangeClientSize"/>
 
4072
      <element name="TControl.FLastResizeClientHeight"/>
 
4073
      <element name="TControl.FLastResizeClientWidth"/>
 
4074
      <element name="TControl.FLastResizeHeight"/>
 
4075
      <element name="TControl.FLastResizeWidth"/>
 
4076
      <element link="TControl.Left" name="TControl.FLeft"/>
 
4077
      <element name="TControl.FLoadedClientSize">
 
4078
        <short>Intended ClientSize, initialized during loading</short>
 
4079
      <notes><note>?</note>
 
4080
        </notes>
 
4081
      </element>
 
4082
      <element link="TControl.LRDockWidth" name="TControl.FLRDockWidth"/>
 
4083
      <element link="TControl.MouseEntered" name="TControl.FMouseEntered"/>
 
4084
      <element link="TControl.OnChangeBounds" name="TControl.FOnChangeBounds"/>
 
4085
      <element link="TControl.OnClick" name="TControl.FOnClick"/>
 
4086
      <element link="TControl.OnConstrainedResize" name="TControl.FOnConstrainedResize"/>
 
4087
      <element link="TControl.OnContextPopup" name="TControl.FOnContextPopup"/>
 
4088
      <element link="TControl.OnDblClick" name="TControl.FOnDblClick"/>
 
4089
      <element link="TControl.OnDragDrop" name="TControl.FOnDragDrop"/>
 
4090
      <element link="TControl.OnDragOver" name="TControl.FOnDragOver"/>
 
4091
      <element link="TControl.OnEditingDone" name="TControl.FOnEditingDone"/>
 
4092
      <element link="TControl.OnEndDock" name="TControl.FOnEndDock"/>
 
4093
      <element link="TControl.OnEndDrag" name="TControl.FOnEndDrag"/>
 
4094
      <element link="TControl.OnMouseDown" name="TControl.FOnMouseDown"/>
 
4095
      <element link="TControl.OnMouseEnter" name="TControl.FOnMouseEnter"/>
 
4096
      <element link="TControl.OnMouseLeave" name="TControl.FOnMouseLeave"/>
 
4097
      <element link="TControl.OnMouseMove" name="TControl.FOnMouseMove"/>
 
4098
      <element link="TControl.OnMouseUp" name="TControl.FOnMouseUp"/>
 
4099
      <element link="TControl.OnMouseWheel" name="TControl.FOnMouseWheel"/>
 
4100
      <element link="TControl.OnMouseWheelDown" name="TControl.FOnMouseWheelDown"/>
 
4101
      <element link="TControl.OnMouseWheelUp" name="TControl.FOnMouseWheelUp"/>
 
4102
      <element link="TControl.OnQuadClick" name="TControl.FOnQuadClick"/>
 
4103
      <element link="TControl.OnResize" name="TControl.FOnResize"/>
 
4104
      <element link="TControl.OnShowHint" name="TControl.FOnShowHint"/>
 
4105
      <element link="TControl.OnStartDock" name="TControl.FOnStartDock"/>
 
4106
      <element link="TControl.OnStartDrag" name="TControl.FOnStartDrag"/>
 
4107
      <element link="TControl.OnTripleClick" name="TControl.FOnTripleClick"/>
 
4108
      <element link="TControl.Parent" name="TControl.FParent"/>
 
4109
      <element link="TControl.ParentBiDiMode" name="TControl.FParentBiDiMode"/>
 
4110
      <element link="TControl.ParentColor" name="TControl.FParentColor"/>
 
4111
      <element link="TControl.ParentFont" name="TControl.FParentFont"/>
 
4112
      <element link="TControl.ShowHint" name="TControl.FParentShowHint"/>
 
4113
      <element link="TControl.PopupMenu" name="TControl.FPopupMenu"/>
 
4114
      <element name="TControl.FPreferredHeight"/>
 
4115
      <element name="TControl.FPreferredMinHeight"/>
 
4116
      <element name="TControl.FPreferredMinWidth"/>
 
4117
      <element name="TControl.FPreferredWidth"/>
 
4118
      <element link="TControl.ReadBounds" name="TControl.FReadBounds"/>
 
4119
      <element link="TControl.SessionProperties" name="TControl.FSessionProperties"/>
 
4120
      <element link="TControl.ShowHint" name="TControl.FShowHint"/>
 
4121
      <element name="TControl.FSizeLock">
 
4122
        <short/>
 
4123
      <notes><note>?</note>
 
4124
        </notes>
 
4125
      </element>
 
4126
      <element link="TControl.TBDockHeight" name="TControl.FTBDockHeight"/>
 
4127
      <element link="TControl.Top" name="TControl.FTop"/>
 
4128
      <element link="TControl.UndockHeight" name="TControl.FUndockHeight"/>
 
4129
      <element link="TControl.UndockWidth" name="TControl.FUndockWidth"/>
 
4130
      <element link="TControl.Visible" name="TControl.FVisible"/>
 
4131
      <element link="TControl.Width" name="TControl.FWidth"/>
 
4132
      <element link="TControl.WindowProc" name="TControl.FWindowProc"/>
 
4133
      <!-- function Visibility: private -->
 
4134
      <element link="TControl.CaptureMouseBottons" name="TControl.CaptureMouseButtonsIsStored"/>
 
4135
      <element name="TControl.CaptureMouseButtonsIsStored.Result">
 
4136
        <short/>
 
4137
      </element>
 
4138
      <!-- procedure Visibility: private -->
 
4139
      <element name="TControl.DoActionChange">
 
4140
        <short>Internal handler for a changed Action, invoked from the ActionLink.</short>
 
4141
        <descr>When the action is assigned to this control, updates related properties using <link id="TControl.ActionChange">ActionChange</link>.</descr>
 
4142
      </element>
 
4143
      <element name="TControl.DoActionChange.Sender">
 
4144
        <short>The changed Action.</short>
 
4145
      </element>
 
4146
      <!-- function Visibility: private -->
 
4147
      <element link="TControl.AutoSizingAll" name="TControl.GetAutoSizingAll"/>
 
4148
      <element name="TControl.GetAutoSizingAll.Result">
 
4149
        <short/>
 
4150
      </element>
 
4151
      <!-- function Visibility: private -->
 
4152
      <element link="TControl.AnchorSide" name="TControl.GetAnchorSide"/>
 
4153
      <element name="TControl.GetAnchorSide.Result">
 
4154
        <short/>
 
4155
      </element>
 
4156
      <element name="TControl.GetAnchorSide.Kind">
 
4157
        <short/>
 
4158
      </element>
 
4159
      <!-- function Visibility: private -->
 
4160
      <element link="TControl.AnchoredControls" name="TControl.GetAnchoredControls"/>
 
4161
      <element name="TControl.GetAnchoredControls.Result">
 
4162
        <short/>
 
4163
      </element>
 
4164
      <element name="TControl.GetAnchoredControls.Index">
 
4165
        <short/>
 
4166
      </element>
 
4167
      <!-- function Visibility: private -->
 
4168
      <element link="TControl.BoundsRect" name="TControl.GetBoundsRect"/>
 
4169
      <element name="TControl.GetBoundsRect.Result">
 
4170
        <short/>
 
4171
      </element>
 
4172
      <!-- function Visibility: private -->
 
4173
      <element link="TControl.ClientHeight" name="TControl.GetClientHeight"/>
 
4174
      <element name="TControl.GetClientHeight.Result">
 
4175
        <short/>
 
4176
      </element>
 
4177
      <!-- function Visibility: private -->
 
4178
      <element link="TControl.ClientWidth" name="TControl.GetClientWidth"/>
 
4179
      <element name="TControl.GetClientWidth.Result">
 
4180
        <short/>
 
4181
      </element>
 
4182
      <!-- function Visibility: private -->
 
4183
      <element link="TControl.LRDockWidth" name="TControl.GetLRDockWidth"/>
 
4184
      <element name="TControl.GetLRDockWidth.Result">
 
4185
        <short/>
 
4186
      </element>
 
4187
      <!-- function Visibility: private -->
 
4188
      <element link="TControl.MouseCapture" name="TControl.GetMouseCapture"/>
 
4189
      <element name="TControl.GetMouseCapture.Result">
 
4190
        <short/>
 
4191
      </element>
 
4192
      <!-- function Visibility: private -->
 
4193
      <element link="TControl.TBDockHeight" name="TControl.GetTBDockHeight"/>
 
4194
      <element name="TControl.GetTBDockHeight.Result">
 
4195
        <short/>
 
4196
      </element>
 
4197
      <!-- function Visibility: private -->
 
4198
      <element name="TControl.GetText">
 
4199
        <short>Returns the Text property.</short>
 
4200
        <descr>Uses RealGetText (FCaption), instead of GetTextBuf (WM_GETTEXT), if possible.</descr>
 
4201
        <seealso>
 
4202
          <link id="#lcl.Controls.TControl.GetTextBuf">GetTextBuf</link>
 
4203
          <link id="#lcl.Controls.TControl.RealGetText"/>
 
4204
        </seealso>
 
4205
      </element>
 
4206
      <element name="TControl.GetText.Result">
 
4207
        <short>The Text property.</short>
 
4208
      </element>
 
4209
      <!-- function Visibility: private -->
 
4210
      <element link="TControl.UndockHeight" name="TControl.GetUndockHeight"/>
 
4211
      <element name="TControl.GetUndockHeight.Result">
 
4212
        <short/>
 
4213
      </element>
 
4214
      <!-- function Visibility: private -->
 
4215
      <element link="TControl.UndockWidth" name="TControl.GetUndockWidth"/>
 
4216
      <element name="TControl.GetUndockWidth.Result">
 
4217
        <short/>
 
4218
      </element>
 
4219
      <!-- function Visibility: private -->
 
4220
      <element link="TControl.Anchors" name="TControl.IsAnchorsStored"/>
 
4221
      <element name="TControl.IsAnchorsStored.Result">
 
4222
        <short/>
 
4223
      </element>
 
4224
      <!-- function Visibility: private -->
 
4225
      <element link="TControl.BiDiMode" name="TControl.IsBiDiModeStored"/>
 
4226
      <element name="TControl.IsBiDiModeStored.Result">
 
4227
        <short/>
 
4228
      </element>
 
4229
      <!-- function Visibility: private -->
 
4230
      <element link="TControl.Caption" name="TControl.IsCaptionStored"/>
 
4231
      <element name="TControl.IsCaptionStored.Result">
 
4232
        <short/>
 
4233
      </element>
 
4234
      <!-- function Visibility: private -->
 
4235
      <element link="TControl.Enabled" name="TControl.IsEnabledStored"/>
 
4236
      <element name="TControl.IsEnabledStored.Result">
 
4237
        <short/>
 
4238
      </element>
 
4239
      <!-- function Visibility: private -->
 
4240
      <element link="TControl.Font" name="TControl.IsFontStored"/>
 
4241
      <element name="TControl.IsFontStored.Result">
 
4242
        <short/>
 
4243
      </element>
 
4244
      <!-- function Visibility: private -->
 
4245
      <element link="TControl.Hint" name="TControl.IsHintStored"/>
 
4246
      <element name="TControl.IsHintStored.Result">
 
4247
        <short/>
 
4248
      </element>
 
4249
      <!-- function Visibility: private -->
 
4250
      <element link="TControl.HelpContext" name="TControl.IsHelpContextStored"/>
 
4251
      <element name="TControl.IsHelpContextStored.Result">
 
4252
        <short/>
 
4253
      </element>
 
4254
      <!-- function Visibility: private -->
 
4255
      <element link="TControl.HelpKeyword" name="TControl.IsHelpKeyWordStored"/>
 
4256
      <element name="TControl.IsHelpKeyWordStored.Result">
 
4257
        <short/>
 
4258
      </element>
 
4259
      <!-- function Visibility: private -->
 
4260
      <element link="TControl.OnClick" name="TControl.IsOnClickStored"/>
 
4261
      <element name="TControl.IsOnClickStored.Result">
 
4262
        <short/>
 
4263
      </element>
 
4264
      <!-- function Visibility: private -->
 
4265
      <element link="TControl.ShowHint" name="TControl.IsShowHintStored"/>
 
4266
      <element name="TControl.IsShowHintStored.Result">
 
4267
        <short/>
 
4268
      </element>
 
4269
      <!-- function Visibility: private -->
 
4270
      <element link="TControl.Visible" name="TControl.IsVisibleStored"/>
 
4271
      <element name="TControl.IsVisibleStored.Result">
 
4272
        <short/>
 
4273
      </element>
 
4274
      <!-- procedure Visibility: private -->
 
4275
      <element name="TControl.DoBeforeMouseMessage">
 
4276
        <short>Generate MouseEnter and MouseLeave events</short>
 
4277
        <descr/>
 
4278
        <errors/>
 
4279
        <seealso/>
 
4280
      <notes><note>?</note>
 
4281
        </notes>
 
4282
      </element>
 
4283
      <!-- procedure Visibility: private -->
 
4284
      <element name="TControl.DoConstrainedResize">
 
4285
        <short>Adjust the intended (given) Bounds, according to Constraints.</short>
 
4286
        <descr/>
 
4287
        <errors/>
 
4288
        <seealso>
 
4289
          <link id="TControl.Constraints"/>
 
4290
          <link id="TControl.ConstrainedResize"/>
 
4291
        </seealso>
 
4292
      </element>
 
4293
      <element name="TControl.DoConstrainedResize.NewLeft">
 
4294
        <short/>
 
4295
      </element>
 
4296
      <element name="TControl.DoConstrainedResize.NewTop">
 
4297
        <short/>
 
4298
      </element>
 
4299
      <element name="TControl.DoConstrainedResize.NewWidth">
 
4300
        <short/>
 
4301
      </element>
 
4302
      <element name="TControl.DoConstrainedResize.NewHeight">
 
4303
        <short/>
 
4304
      </element>
 
4305
      <!-- procedure Visibility: private -->
 
4306
      <element name="TControl.DoMouseDown">
 
4307
        <short>Message handler for mouse button going down. Calls MouseDown handler.</short>
 
4308
        <descr/>
 
4309
        <errors/>
 
4310
        <seealso>
 
4311
          <link id="TControl.DoMouseUp"/>
 
4312
          <link id="TControl.MouseDown"/>
 
4313
          <link id="TControl.OnMouseDown"/>
 
4314
        </seealso>
 
4315
      </element>
 
4316
      <element name="TControl.DoMouseDown.Message">
 
4317
        <short/>
 
4318
      </element>
 
4319
      <element name="TControl.DoMouseDown.Button">
 
4320
        <short/>
 
4321
      </element>
 
4322
      <element name="TControl.DoMouseDown.Shift">
 
4323
        <short/>
 
4324
      </element>
 
4325
      <!-- procedure Visibility: private -->
 
4326
      <element name="TControl.DoMouseUp">
 
4327
        <short>Message handler for mouse button going up. Calls MouseUp handler.</short>
 
4328
        <descr/>
 
4329
        <errors/>
 
4330
        <seealso>
 
4331
          <link id="TControl.DoMouseDown"/>
 
4332
          <link id="TControl.MouseUp"/>
 
4333
          <link id="TControl.OnMouseUp"/>
 
4334
        </seealso>
 
4335
      </element>
 
4336
      <element name="TControl.DoMouseUp.Message">
 
4337
        <short/>
 
4338
      </element>
 
4339
      <element name="TControl.DoMouseUp.Button">
 
4340
        <short/>
 
4341
      </element>
 
4342
      <!-- procedure Visibility: private -->
 
4343
      <element name="TControl.SetAnchorSide">
 
4344
        <short>Setter for AnchorSideLeft...</short>
 
4345
        <descr/>
 
4346
        <errors/>
 
4347
        <seealso/>
 
4348
      </element>
 
4349
      <element name="TControl.SetAnchorSide.Kind">
 
4350
        <short/>
 
4351
      </element>
 
4352
      <element name="TControl.SetAnchorSide.AValue">
 
4353
        <short/>
 
4354
      </element>
 
4355
      <!-- procedure Visibility: private -->
 
4356
      <element link="TControl.BorderSpacing" name="TControl.SetBorderSpacing"/>
 
4357
      <element name="TControl.SetBorderSpacing.AValue">
 
4358
        <short/>
 
4359
      </element>
 
4360
      <!-- procedure Visibility: private -->
 
4361
      <element link="TControl.BoundsRect" name="TControl.SetBoundsRect"/>
 
4362
      <element name="TControl.SetBoundsRect.ARect">
 
4363
        <short/>
 
4364
      </element>
 
4365
      <!-- procedure Visibility: private -->
 
4366
      <element link="TControl.BoundsRectForNewParent" name="TControl.SetBoundsRectForNewParent"/>
 
4367
      <element name="TControl.SetBoundsRectForNewParent.AValue">
 
4368
        <short/>
 
4369
      </element>
 
4370
      <!-- procedure Visibility: private -->
 
4371
      <element link="TControl.ClientHeight" name="TControl.SetClientHeight"/>
 
4372
      <element name="TControl.SetClientHeight.Value">
 
4373
        <short/>
 
4374
      </element>
 
4375
      <!-- procedure Visibility: private -->
 
4376
      <element link="TControl.ClientRect" name="TControl.SetClientSize"/>
 
4377
      <element name="TControl.SetClientSize.Value">
 
4378
        <short/>
 
4379
      </element>
 
4380
      <!-- procedure Visibility: private -->
 
4381
      <element link="TControl.ClientWidth" name="TControl.SetClientWidth"/>
 
4382
      <element name="TControl.SetClientWidth.Value">
 
4383
        <short/>
 
4384
      </element>
 
4385
      <!-- procedure Visibility: private -->
 
4386
      <element link="TControl.Constraints" name="TControl.SetConstraints"/>
 
4387
      <element name="TControl.SetConstraints.Value">
 
4388
        <short/>
 
4389
      </element>
 
4390
      <!-- procedure Visibility: private -->
 
4391
      <element link="TControl.DesktopFont" name="TControl.SetDesktopFont"/>
 
4392
      <element name="TControl.SetDesktopFont.AValue">
 
4393
        <short/>
 
4394
      </element>
 
4395
      <!-- procedure Visibility: private -->
 
4396
      <element link="TControl.DragCursor" name="TControl.SetDragCursor"/>
 
4397
      <element name="TControl.SetDragCursor.AValue">
 
4398
        <short/>
 
4399
      </element>
 
4400
      <!-- procedure Visibility: private -->
 
4401
      <element link="TControl.Font" name="TControl.SetFont"/>
 
4402
      <element name="TControl.SetFont.Value">
 
4403
        <short/>
 
4404
      </element>
 
4405
      <!-- procedure Visibility: private -->
 
4406
      <element link="TControl.Height" name="TControl.SetHeight"/>
 
4407
      <element name="TControl.SetHeight.Value">
 
4408
        <short/>
 
4409
      </element>
 
4410
      <!-- procedure Visibility: private -->
 
4411
      <element link="TControl.HelpContext" name="TControl.SetHelpContext"/>
 
4412
      <element name="TControl.SetHelpContext.AValue">
 
4413
        <short/>
 
4414
      </element>
 
4415
      <!-- procedure Visibility: private -->
 
4416
      <element link="TControl.HelpKeyword" name="TControl.SetHelpKeyword"/>
 
4417
      <element name="TControl.SetHelpKeyword.AValue">
 
4418
        <short/>
 
4419
      </element>
 
4420
      <!-- procedure Visibility: private -->
 
4421
      <element link="TControl.HostDockSite" name="TControl.SetHostDockSite"/>
 
4422
      <element name="TControl.SetHostDockSite.AValue">
 
4423
        <short/>
 
4424
      </element>
 
4425
      <!-- procedure Visibility: private -->
 
4426
      <element link="TControl.Left" name="TControl.SetLeft"/>
 
4427
      <element name="TControl.SetLeft.Value">
 
4428
        <short/>
 
4429
      </element>
 
4430
      <!-- procedure Visibility: private -->
 
4431
      <element link="TControl.MouseCapture" name="TControl.SetMouseCapture"/>
 
4432
      <element name="TControl.SetMouseCapture.Value">
 
4433
        <short/>
 
4434
      </element>
 
4435
      <!-- procedure Visibility: private -->
 
4436
      <element link="TControl.ParentShowHint" name="TControl.SetParentShowHint"/>
 
4437
      <element name="TControl.SetParentShowHint.Value">
 
4438
        <short/>
 
4439
      </element>
 
4440
      <!-- procedure Visibility: private -->
 
4441
      <element link="TControl.ParentColor" name="TControl.SetParentColor"/>
 
4442
      <element name="TControl.SetParentColor.Value">
 
4443
        <short/>
 
4444
      </element>
 
4445
      <!-- procedure Visibility: private -->
 
4446
      <element link="TControl.ParentFont" name="TControl.SetParentFont"/>
 
4447
      <element name="TControl.SetParentFont.Value">
 
4448
        <short/>
 
4449
      </element>
 
4450
      <!-- procedure Visibility: private -->
 
4451
      <element link="TControl.PopupMenu" name="TControl.SetPopupMenu"/>
 
4452
      <element name="TControl.SetPopupMenu.Value">
 
4453
        <short/>
 
4454
      </element>
 
4455
      <!-- procedure Visibility: private -->
 
4456
      <element link="TControl.ShowHint" name="TControl.SetShowHint"/>
 
4457
      <element name="TControl.SetShowHint.Value">
 
4458
        <short/>
 
4459
      </element>
 
4460
      <!-- procedure Visibility: private -->
 
4461
      <element name="TControl.SetText">
 
4462
        <short>Sets the Text property.</short>
 
4463
        <descr>Uses RealSetText instead of SetTextBuf, if possible.</descr>
 
4464
        <seealso>
 
4465
          <link id="TControl.Text">Text</link>
 
4466
          <link id="#lcl.Controls.TControl.RealSetText">RealSetText</link>
 
4467
          <link id="#lcl.Controls.TControl.SetTextBuf">SetTextBuf</link>
 
4468
        </seealso>
 
4469
      </element>
 
4470
      <element name="TControl.SetText.Value">
 
4471
        <short>The new Text.</short>
 
4472
      </element>
 
4473
      <!-- procedure Visibility: private -->
 
4474
      <element link="TControl.Top" name="TControl.SetTop"/>
 
4475
      <element name="TControl.SetTop.Value">
 
4476
        <short/>
 
4477
      </element>
 
4478
      <!-- procedure Visibility: private -->
 
4479
      <element link="TControl.Width" name="TControl.SetWidth"/>
 
4480
      <element name="TControl.SetWidth.Value">
 
4481
        <short/>
 
4482
      </element>
 
4483
      <element link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass" name="TControl.WSRegisterClass"/>
 
4484
      <!-- function Visibility: protected -->
 
4485
      <element link="TControl.Cursor" name="TControl.GetCursor"/>
 
4486
      <element name="TControl.GetCursor.Result">
 
4487
        <short/>
 
4488
      </element>
 
4489
      <!-- procedure Visibility: private -->
 
4490
      <element link="TControl.Cursor" name="TControl.SetCursor"/>
 
4491
      <element name="TControl.SetCursor.Value">
 
4492
        <short/>
 
4493
      </element>
 
4494
      <!-- procedure Visibility: private -->
 
4495
      <element link="TControl.Visible" name="TControl.SetVisible"/>
 
4496
      <element name="TControl.SetVisible.Value">
 
4497
        <short/>
 
4498
      </element>
 
4499
      <!-- procedure Visibility: protected -->
 
4500
      <element name="TControl.DoOnParentHandleDestruction">
 
4501
        <short/>
 
4502
        <descr>implement in descendants
 
4503
        </descr>
 
4504
        <errors/>
 
4505
        <seealso/>
 
4506
      <notes><note>?</note><note>what?</note>
 
4507
        </notes>
 
4508
      </element>
 
4509
      <!-- procedure Visibility: protected -->
 
4510
      <element name="TControl.DoAutoSize">
 
4511
        <short>For internal use only - call AdjustSize instead!
 
4512
        </short>
 
4513
        <descr>
 
4514
          <p>IMPORTANT: Many Delphi controls override this method and many call this method directly after setting some properties.</p>
 
4515
          <p>During handle creation not all interfaces can create complete Device Contexts which are needed to calculate things like text size.</p>
 
4516
          <p>That's why you should always call <link id="#lcl.Controls.TControl.AdjustSize">AdjustSize</link> instead of <var>DoAutoSize</var>.</p>
 
4517
        </descr>
 
4518
        <seealso>
 
4519
          <link id="#lcl.Controls.AutoSize">AutoSize topic</link>
 
4520
          <link id="#lcl.Controls.TControl.AdjustSize">TControl.AdjustSize</link>
 
4521
        </seealso>
 
4522
      </element>
 
4523
      <!-- procedure Visibility: protected -->
 
4524
      <element name="TControl.DoAllAutoSize">
 
4525
        <short>Run DoAutoSize until done.</short>
 
4526
        <descr/>
 
4527
        <errors/>
 
4528
        <seealso/>
 
4529
      </element>
 
4530
      <!-- procedure Visibility: protected -->
 
4531
      <element name="TControl.BeginAutoSizing">
 
4532
        <short>Sets AutoSizing=true, used to prevent loops.</short>
 
4533
      </element>
 
4534
      <!-- procedure Visibility: protected -->
 
4535
      <element name="TControl.EndAutoSizing">
 
4536
        <short>End of the autosizing process, resets AutoSizing to False.</short>
 
4537
      </element>
 
4538
      <!-- procedure Visibility: protected -->
 
4539
      <element name="TControl.AnchorSideChanged">
 
4540
        <short>Request further processing after an anchor side was changed.</short>
 
4541
      </element>
 
4542
      <element name="TControl.AnchorSideChanged.TheAnchorSide">
 
4543
        <short>Ignored.</short>
 
4544
      </element>
 
4545
      <!-- procedure Visibility: protected -->
 
4546
      <element name="TControl.ForeignAnchorSideChanged">
 
4547
        <short>Request further processing after an anchor side has changed, that anchors another control to this one.</short>
 
4548
      </element>
 
4549
      <element name="TControl.ForeignAnchorSideChanged.TheAnchorSide">
 
4550
        <short/>
 
4551
      </element>
 
4552
      <element name="TControl.ForeignAnchorSideChanged.Operation">
 
4553
        <short/>
 
4554
      </element>
 
4555
      <!-- procedure Visibility: protected -->
 
4556
      <element link="TControl.Align" name="TControl.SetAlign"/>
 
4557
      <element name="TControl.SetAlign.Value">
 
4558
        <short/>
 
4559
      </element>
 
4560
      <!-- procedure Visibility: protected -->
 
4561
      <element link="TControl.Anchors" name="TControl.SetAnchors"/>
 
4562
      <element name="TControl.SetAnchors.AValue">
 
4563
        <short/>
 
4564
      </element>
 
4565
      <!-- procedure Visibility: protected -->
 
4566
      <element link="TControl.AutoSize" name="TControl.SetAutoSize"/>
 
4567
      <element name="TControl.SetAutoSize.Value">
 
4568
        <short/>
 
4569
      </element>
 
4570
      <!-- procedure Visibility: protected -->
 
4571
      <element name="TControl.BoundsChanged">
 
4572
        <short>Invoked when the Bounds of the control have been changed. Override as required.</short>
 
4573
      </element>
 
4574
      <element name="TControl.CreateControlBorderSpacing">
 
4575
        <short>Creates the default ControlBorderSpacing object.
 
4576
          Allow descendant controls to override this default.</short>
 
4577
        <seealso>
 
4578
          <link id="TControlBorderSpacing"/>
 
4579
        </seealso>
 
4580
      </element>
 
4581
      <element name="TControl.CreateControlBorderSpacing.Result">
 
4582
        <short>The created ControlBorderSpacing instance.</short>
 
4583
      </element>
 
4584
      <!-- procedure Visibility: protected -->
 
4585
      <element name="TControl.DoConstraintsChange">
 
4586
        <short>Reacts on a change in the control's constraints.
 
4587
          Calls AdjustSize by default.
 
4588
        </short>
 
4589
      </element>
 
4590
      <element name="TControl.DoConstraintsChange.Sender">
 
4591
        <short/>
 
4592
      </element>
 
4593
      <!-- procedure Visibility: protected -->
 
4594
      <element name="TControl.DoBorderSpacingChange">
 
4595
        <short>Reacts on a change in the control's border spacing.</short>
 
4596
      </element>
 
4597
      <element name="TControl.DoBorderSpacingChange.Sender">
 
4598
        <short/>
 
4599
      </element>
 
4600
      <element name="TControl.DoBorderSpacingChange.InnerSpaceChanged">
 
4601
        <short/>
 
4602
      </element>
 
4603
      <!-- function Visibility: protected -->
 
4604
      <element name="TControl.IsBorderSpacingInnerBorderStored">
 
4605
        <short>Checks for a defined (non-zero) BorderSpacing.InnerBorder.</short>
 
4606
      </element>
 
4607
      <element name="TControl.IsBorderSpacingInnerBorderStored.Result">
 
4608
        <short>True when InnerBorder has to be taken into account.</short>
 
4609
      </element>
 
4610
      <!-- procedure Visibility: protected -->
 
4611
      <element name="TControl.SendMoveSizeMessages">
 
4612
        <short>Sends Move and Size messages through the LCL message paths.
 
4613
        </short>
 
4614
        <descr>
 
4615
          <p>Overridden in TWinControl, in TControl it's a NOP.
 
4616
          </p>
 
4617
          <p>This method simulates the VCL behaviour and has no real effect.
 
4618
          </p>
 
4619
        </descr>
 
4620
      <notes><note>?</note>
 
4621
        </notes>
 
4622
      </element>
 
4623
      <element name="TControl.SendMoveSizeMessages.SizeChanged">
 
4624
        <short/>
 
4625
      </element>
 
4626
      <element name="TControl.SendMoveSizeMessages.PosChanged">
 
4627
        <short/>
 
4628
      </element>
 
4629
      <element name="TControl.ConstrainedResize">
 
4630
        <short>Invokes the <link id="#lcl.Controls.TControl.OnConstrainedResize"/> handler, allowing to modify the suggested Constraints.
 
4631
        </short>
 
4632
      </element>
 
4633
      <element name="TControl.ConstrainedResize.MinWidth">
 
4634
        <short/>
 
4635
      </element>
 
4636
      <element name="TControl.ConstrainedResize.MinHeight">
 
4637
        <short/>
 
4638
      </element>
 
4639
      <element name="TControl.ConstrainedResize.MaxWidth">
 
4640
        <short/>
 
4641
      </element>
 
4642
      <element name="TControl.ConstrainedResize.MaxHeight">
 
4643
        <short/>
 
4644
      </element>
 
4645
      <!-- procedure Visibility: protected -->
 
4646
      <element name="TControl.CalculatePreferredSize">
 
4647
        <short>Override this method to return the preferred height and width.
 
4648
        </short>
 
4649
        <descr>
 
4650
          <p>Calculates the preferred width and height for a control,
 
4651
            which is used by the LCL autosizing algorithms as the default size.
 
4652
            Negative or 0 are treated as undefined and the LCL uses other sizes instead.
 
4653
          </p>
 
4654
          <p>
 
4655
            <var>TWinControl</var> overrides this and asks the interface for theme dependent values.
 
4656
            See 
 
4657
            
 
4658
            <link id="TWinControl.CalculatePreferredSize"/> for more information.
 
4659
          </p>
 
4660
          <p>WithThemeSpace: If true, adds space for stacking.
 
4661
          </p>
 
4662
          <p>For example: <var>TRadioButton</var> has a minimum size.
 
4663
            But for stacking multiple TRadioButtons there should be some space around.
 
4664
            This space is theme dependent, so the parameter is passed to the widgetset.
 
4665
          </p>
 
4666
        </descr>
 
4667
      </element>
 
4668
      <element name="TControl.CalculatePreferredSize.PreferredWidth">
 
4669
        <short>Set this argument to the preferred width.</short>
 
4670
      </element>
 
4671
      <element name="TControl.CalculatePreferredSize.PreferredHeight">
 
4672
        <short>Set this argument to the preferred height.</short>
 
4673
      </element>
 
4674
      <element name="TControl.CalculatePreferredSize.WithThemeSpace">
 
4675
        <short>True when space around stacked controls should be added.</short>
 
4676
      </element>
 
4677
      <!-- procedure Visibility: protected -->
 
4678
      <element name="TControl.DoOnResize">
 
4679
        <short>Invokes the <link id="#lcl.Controls.TControl.OnResize">OnResize</link> notification handler.
 
4680
        </short>
 
4681
      </element>
 
4682
      <!-- procedure Visibility: protected -->
 
4683
      <element name="TControl.DoOnChangeBounds">
 
4684
        <short>Invokes the <link id="#lcl.Controls.TControl.OnChangeBounds">OnChangeBounds</link> event handler</short>
 
4685
      </element>
 
4686
      <!-- procedure Visibility: protected -->
 
4687
      <element name="TControl.CheckOnChangeBounds">
 
4688
        <short>Checks for changes and calls <link id="#lcl.Controls.TControl.DoOnChangeBounds">DoOnChangeBounds</link> if needed.
 
4689
        </short>
 
4690
      </element>
 
4691
      <!-- procedure Visibility: protected -->
 
4692
      <element name="TControl.Resize">
 
4693
        <short>Checks for changes and calls <link id="#lcl.Controls.TControl.DoOnResize">DoOnResize</link> if needed.
 
4694
        </short>
 
4695
      </element>
 
4696
      <!-- procedure Visibility: protected -->
 
4697
      <element name="TControl.RequestAlign">
 
4698
        <short>Smart calling of <var>Parent.AlignControls</var> (very indirectly).
 
4699
        </short>
 
4700
        <seealso>
 
4701
          <link id="TWinControl.AlignControls"/>
 
4702
        </seealso>
 
4703
      </element>
 
4704
      <!-- procedure Visibility: protected -->
 
4705
      <element name="TControl.UpdateAnchorRules">
 
4706
        <short>Update the rules for anchoring the control</short>
 
4707
      <notes><note>or of anchored controls?</note>
 
4708
        </notes>
 
4709
      </element>
 
4710
      <!-- procedure Visibility: protected -->
 
4711
      <element name="TControl.ChangeBounds">
 
4712
        <short>Sets the bounds (left, top, height, width) optionally the BaseBounds of the control.</short>
 
4713
        <descr>
 
4714
          <p>ChangeBounds is called whenever the position or size of the control is set,
 
4715
            either via the properties or by the layouter of the LCL.
 
4716
          </p>
 
4717
          <p>SetBounds calls internally ChangeBounds with KeepBase=false,
 
4718
            while the LCL layouter calls it with KeepBase=true.
 
4719
          </p>
 
4720
          <p>Override this for code that might change the preferred size or resizes other controls.
 
4721
          </p>
 
4722
          <p>You can call this function in your custom controls.
 
4723
            Keep in mind that the given aLeft, aTop, aWidth, aHeight might not be valid and will be changed by the LCL before applied.
 
4724
          </p>
 
4725
        </descr>
 
4726
      </element>
 
4727
      <element name="TControl.ChangeBounds.ALeft">
 
4728
        <short/>
 
4729
      </element>
 
4730
      <element name="TControl.ChangeBounds.ATop">
 
4731
        <short/>
 
4732
      </element>
 
4733
      <element name="TControl.ChangeBounds.AWidth">
 
4734
        <short/>
 
4735
      </element>
 
4736
      <element name="TControl.ChangeBounds.AHeight">
 
4737
        <short/>
 
4738
      </element>
 
4739
      <element name="TControl.ChangeBounds.KeepBase">
 
4740
        <short>True when the BaseBounds should not be modified.</short>
 
4741
      </element>
 
4742
      <!-- procedure Visibility: protected -->
 
4743
      <element name="TControl.DoSetBounds">
 
4744
        <short>Internal function to set the control's bounds (Left, Top, Height, Width).</short>
 
4745
        <descr>
 
4746
          <p>DoSetBounds is a low level function to set the private variables FLeft, FTop, FWidth, FHeight.
 
4747
            Do not call this function, only the LCL calls it.
 
4748
          </p>
 
4749
          <p>It also updates FClientWidth and FClientHeight accordingly.
 
4750
          </p>
 
4751
          <p>Override this to update the content layout of the control, for example scroll bars.
 
4752
            As always: do not paint here, but call Invalidate and paint in OnPaint or override Paint.
 
4753
          </p>
 
4754
        </descr>
 
4755
      <notes><note>The following doesn't look correct?</note>
 
4756
        </notes>
 
4757
      </element>
 
4758
      <element name="TControl.DoSetBounds.ALeft">
 
4759
        <short/>
 
4760
      </element>
 
4761
      <element name="TControl.DoSetBounds.ATop">
 
4762
        <short/>
 
4763
      </element>
 
4764
      <element name="TControl.DoSetBounds.AWidth">
 
4765
        <short/>
 
4766
      </element>
 
4767
      <element name="TControl.DoSetBounds.AHeight">
 
4768
        <short/>
 
4769
      </element>
 
4770
      <!-- procedure Visibility: protected -->
 
4771
      <element name="TControl.ScaleConstraints">
 
4772
        <short>Scale the minimum and maximum Width and Height.</short>
 
4773
        <descr>ScaleConstraints is called during ChangeScale, you never will call it directly.
 
4774
        </descr>
 
4775
        <errors/>
 
4776
        <seealso/>
 
4777
      </element>
 
4778
      <element name="TControl.ScaleConstraints.Multiplier">
 
4779
        <short/>
 
4780
      </element>
 
4781
      <element name="TControl.ScaleConstraints.Divider">
 
4782
        <short/>
 
4783
      </element>
 
4784
      <!-- procedure Visibility: protected -->
 
4785
      <element name="TControl.ChangeScale">
 
4786
        <short>Apply scaling (multiplier and divider) to the control's coordinates and Font.</short>
 
4787
        <descr/>
 
4788
      </element>
 
4789
      <element name="TControl.ChangeScale.Multiplier">
 
4790
        <short/>
 
4791
      </element>
 
4792
      <element name="TControl.ChangeScale.Divider">
 
4793
        <short/>
 
4794
      </element>
 
4795
      <!-- function Visibility: protected -->
 
4796
      <element name="TControl.CanAutoSize">
 
4797
        <short>Function to determine if autosizing is possible, and if so,
 
4798
          gets the new width and height</short>
 
4799
        <descr>Override this to return different values.
 
4800
        </descr>
 
4801
      </element>
 
4802
      <element name="TControl.CanAutoSize.Result">
 
4803
        <short>TControl returns True.</short>
 
4804
      </element>
 
4805
      <element name="TControl.CanAutoSize.NewWidth">
 
4806
        <short>Suggested width, can be adjusted in an overridden version.</short>
 
4807
      </element>
 
4808
      <element name="TControl.CanAutoSize.NewHeight">
 
4809
        <short>Suggested height, can be adjusted in an overridden version.</short>
 
4810
      </element>
 
4811
      <!-- procedure Visibility: protected -->
 
4812
      <element name="TControl.UpdateAlignIndex">
 
4813
        <short>Move this control to position 0 of Parent.FAlignOrder.</short>
 
4814
        <descr>Affects the order in which client controls with the same alignment are positioned
 
4815
        </descr>
 
4816
        <errors/>
 
4817
        <seealso/>
 
4818
      <notes><note>?</note>
 
4819
        </notes>
 
4820
      </element>
 
4821
      <!-- procedure Visibility: private -->
 
4822
      <element link="TControl.BiDiMode" name="TControl.SetBiDiMode"/>
 
4823
      <element name="TControl.SetBiDiMode.AValue">
 
4824
        <short/>
 
4825
      </element>
 
4826
      <!-- procedure Visibility: private -->
 
4827
      <element link="TControl.ParentBiDiMode" name="TControl.SetParentBiDiMode"/>
 
4828
      <element name="TControl.SetParentBiDiMode.AValue">
 
4829
        <short/>
 
4830
      </element>
 
4831
      <!-- function Visibility: protected -->
 
4832
      <element name="TControl.IsAParentAligning">
 
4833
        <short>Determine if a parent control is involved in the alignment process</short>
 
4834
      </element>
 
4835
      <element name="TControl.IsAParentAligning.Result">
 
4836
        <short/>
 
4837
      </element>
 
4838
      <!-- function Visibility: protected -->
 
4839
      <element link="TControl.ClientOrigin" name="TControl.GetClientOrigin"/>
 
4840
      <element name="TControl.GetClientOrigin.Result">
 
4841
        <short/>
 
4842
      </element>
 
4843
      <!-- function Visibility: protected -->
 
4844
      <element link="TControl.ClientRect" name="TControl.GetClientRect"/>
 
4845
      <element name="TControl.GetClientRect.Result">
 
4846
        <short/>
 
4847
      </element>
 
4848
      <!-- function Visibility: protected -->
 
4849
      <element name="TControl.GetLogicalClientRect">
 
4850
        <short>Logical client area, can be bigger than the visible client area.</short>
 
4851
        <descr>A <link id="Forms.TScrollingWinControl"/> has a logical client area, of which only a portion can be visible.
 
4852
          The origin always is (0,0), regardless of an ScrollOffset.</descr>
 
4853
        <seealso>
 
4854
          <link id="TControl.BoundsRect"/>
 
4855
          <link id="TControl.ClientRect"/>
 
4856
          <link id="TControl.GetScrolledClientRect"/>
 
4857
        </seealso>
 
4858
      </element>
 
4859
      <element name="TControl.GetLogicalClientRect.Result">
 
4860
        <short>TControl returns the ClientRect.</short>
 
4861
      </element>
 
4862
      <!-- function Visibility: protected -->
 
4863
      <element name="TControl.GetScrolledClientRect">
 
4864
        <short>Get the visible part of the logical client area.</short>
 
4865
        <descr>
 
4866
          <p>Includes the ScrollOffset in a TScrollingWinControl Parent.</p>
 
4867
          <p>TControl: When the Parent is a TScrollingWinControl, the ClientRect is offset by its ScrollOffset.
 
4868
            This Rect can be intersected with the visible ClientArea of the Parent, to get the really visible part of the control.
 
4869
          </p>
 
4870
          <p>TWinControl: The visible ClientRect is offset by ScrollOffset, to reflect the visible part of the logical ClientRect.
 
4871
          </p>
 
4872
        </descr>
 
4873
        <seealso>
 
4874
          <link id="TControl.ClientRect"/>
 
4875
          <link id="TControl.GetScrolledClientRect"/>
 
4876
        </seealso>
 
4877
      </element>
 
4878
      <element name="TControl.GetScrolledClientRect.Result">
 
4879
        <short>The scrolled ClientRect (TopLeft, BottomRight).
 
4880
        </short>
 
4881
      </element>
 
4882
      <!-- function Visibility: protected -->
 
4883
      <element name="TControl.GetClientScrollOffset">
 
4884
        <short>Returns the offset of the scrolled client area (in a scrolling TWinControl).</short>
 
4885
        <descr>The overridden method may fail when the TScrollingWinControl has only one scrollbar
 
4886
        </descr>
 
4887
        <seealso>
 
4888
          <link id="TControl.GetScrolledClientRect"/>
 
4889
          <link id="#lcl.Forms.TScrollingWinControl.GetClientScrollOffset"/>
 
4890
        </seealso>
 
4891
      <notes><note>!?</note>
 
4892
        </notes>
 
4893
      </element>
 
4894
      <element name="TControl.GetClientScrollOffset.Result">
 
4895
        <short>The X and Y offsets of the visible client area, equal to the scrollbar positions.</short>
 
4896
      </element>
 
4897
      <!-- function Visibility: protected -->
 
4898
      <element link="TControl.ControlOrigin" name="TControl.GetControlOrigin">
 
4899
        <short>Returns the origin (top left pixel) of the control, in screen coordinates.</short>
 
4900
      </element>
 
4901
      <element name="TControl.GetControlOrigin.Result">
 
4902
        <short/>
 
4903
      </element>
 
4904
      <!-- function Visibility: protected -->
 
4905
      <element link="TControl.ClientHeight" name="TControl.IsClientHeightStored"/>
 
4906
      <element name="TControl.IsClientHeightStored.Result">
 
4907
        <short/>
 
4908
      </element>
 
4909
      <!-- function Visibility: protected -->
 
4910
      <element link="TControl.ClientWidth" name="TControl.IsClientWidthStored"/>
 
4911
      <element name="TControl.IsClientWidthStored.Result">
 
4912
        <short/>
 
4913
      </element>
 
4914
      <!-- function Visibility: protected -->
 
4915
      <element name="TControl.WidthIsAnchored">
 
4916
        <short>True when both the control's left and right side are anchored.</short>
 
4917
        <descr/>
 
4918
        <errors/>
 
4919
        <seealso/>
 
4920
      </element>
 
4921
      <element name="TControl.WidthIsAnchored.Result">
 
4922
        <short>True if the Width varies with the Parent.Width.</short>
 
4923
      </element>
 
4924
      <!-- function Visibility: protected -->
 
4925
      <element name="TControl.HeightIsAnchored">
 
4926
        <short>True when both the control's top and bottom side are anchored.</short>
 
4927
        <descr/>
 
4928
        <errors/>
 
4929
        <seealso/>
 
4930
      </element>
 
4931
      <element name="TControl.HeightIsAnchored.Result">
 
4932
        <short>True if the Height varies with the Parent.Height.</short>
 
4933
      </element>
 
4934
      <element name="TControl.WMCancelMode">
 
4935
        <short>Message handler for
 
4936
          cancel mode request.
 
4937
        </short>
 
4938
      </element>
 
4939
      <element name="TControl.WMCancelMode.Message">
 
4940
        <short/>
 
4941
      </element>
 
4942
      <!-- procedure Visibility: protected -->
 
4943
      <element name="TControl.WMContextMenu">
 
4944
        <short>Message handler for
 
4945
          context menu popup request.
 
4946
        </short>
 
4947
      </element>
 
4948
      <element name="TControl.WMContextMenu.Message">
 
4949
        <short/>
 
4950
      </element>
 
4951
      <!-- procedure Visibility: protected -->
 
4952
      <element name="TControl.WMLButtonDown">
 
4953
        <short>Message handler for
 
4954
          left mouse button going down.
 
4955
        </short>
 
4956
        <descr/>
 
4957
        <errors/>
 
4958
        <seealso/>
 
4959
      </element>
 
4960
      <element name="TControl.WMLButtonDown.Message">
 
4961
        <short/>
 
4962
      </element>
 
4963
      <element name="TControl.WMRButtonDown">
 
4964
        <short>Message handler for
 
4965
          right mouse button going down.
 
4966
        </short>
 
4967
        <descr/>
 
4968
        <errors/>
 
4969
        <seealso/>
 
4970
      </element>
 
4971
      <element name="TControl.WMRButtonDown.Message">
 
4972
        <short/>
 
4973
      </element>
 
4974
      <!-- procedure Visibility: protected -->
 
4975
      <element name="TControl.WMMButtonDown">
 
4976
        <short>Message handler for
 
4977
          middle mouse button going down.
 
4978
        </short>
 
4979
        <descr/>
 
4980
        <errors/>
 
4981
        <seealso/>
 
4982
      </element>
 
4983
      <element name="TControl.WMMButtonDown.Message">
 
4984
        <short/>
 
4985
      </element>
 
4986
      <!-- procedure Visibility: protected -->
 
4987
      <element name="TControl.WMLButtonDBLCLK">
 
4988
        <short>Message handler for
 
4989
          left mouse button double click.
 
4990
        </short>
 
4991
        <descr/>
 
4992
        <errors/>
 
4993
        <seealso/>
 
4994
      </element>
 
4995
      <element name="TControl.WMLButtonDBLCLK.Message">
 
4996
        <short/>
 
4997
      </element>
 
4998
      <!-- procedure Visibility: protected -->
 
4999
      <element name="TControl.WMRButtonDBLCLK">
 
5000
        <short>Message handler for
 
5001
          right mouse button double click.
 
5002
        </short>
 
5003
        <descr/>
 
5004
        <errors/>
 
5005
        <seealso/>
 
5006
      </element>
 
5007
      <element name="TControl.WMRButtonDBLCLK.Message">
 
5008
        <short/>
 
5009
      </element>
 
5010
      <!-- procedure Visibility: protected -->
 
5011
      <element name="TControl.WMMButtonDBLCLK">
 
5012
        <short>Message handler for
 
5013
          middle mouse button double click.
 
5014
        </short>
 
5015
        <descr/>
 
5016
        <errors/>
 
5017
        <seealso/>
 
5018
      </element>
 
5019
      <element name="TControl.WMMButtonDBLCLK.Message">
 
5020
        <short/>
 
5021
      </element>
 
5022
      <!-- procedure Visibility: protected -->
 
5023
      <element name="TControl.WMLButtonTripleCLK">
 
5024
        <short>Message handler for
 
5025
          left mouse button triple click.
 
5026
        </short>
 
5027
        <descr/>
 
5028
        <errors/>
 
5029
        <seealso/>
 
5030
      </element>
 
5031
      <element name="TControl.WMLButtonTripleCLK.Message">
 
5032
        <short/>
 
5033
      </element>
 
5034
      <!-- procedure Visibility: protected -->
 
5035
      <element name="TControl.WMRButtonTripleCLK">
 
5036
        <short>Message handler for
 
5037
          right mouse button triple click.
 
5038
        </short>
 
5039
        <descr/>
 
5040
        <errors/>
 
5041
        <seealso/>
 
5042
      </element>
 
5043
      <element name="TControl.WMRButtonTripleCLK.Message">
 
5044
        <short/>
 
5045
      </element>
 
5046
      <!-- procedure Visibility: protected -->
 
5047
      <element name="TControl.WMMButtonTripleCLK">
 
5048
        <short>Message handler for
 
5049
          middle mouse button triple click.
 
5050
        </short>
 
5051
        <descr/>
 
5052
        <errors/>
 
5053
        <seealso/>
 
5054
      </element>
 
5055
      <element name="TControl.WMMButtonTripleCLK.Message">
 
5056
        <short/>
 
5057
      </element>
 
5058
      <!-- procedure Visibility: protected -->
 
5059
      <element name="TControl.WMLButtonQuadCLK">
 
5060
        <short>Message handler for
 
5061
          left mouse button quadruple click.
 
5062
        </short>
 
5063
        <descr/>
 
5064
        <errors/>
 
5065
        <seealso/>
 
5066
      </element>
 
5067
      <element name="TControl.WMLButtonQuadCLK.Message">
 
5068
        <short/>
 
5069
      </element>
 
5070
      <!-- procedure Visibility: protected -->
 
5071
      <element name="TControl.WMRButtonQuadCLK">
 
5072
        <short>Message handler for
 
5073
          right mouse button quadruple click.
 
5074
        </short>
 
5075
        <descr/>
 
5076
        <errors/>
 
5077
        <seealso/>
 
5078
      </element>
 
5079
      <element name="TControl.WMRButtonQuadCLK.Message">
 
5080
        <short/>
 
5081
      </element>
 
5082
      <!-- procedure Visibility: protected -->
 
5083
      <element name="TControl.WMMButtonQuadCLK">
 
5084
        <short>Message handler for
 
5085
          middle mouse button quadruple click.
 
5086
        </short>
 
5087
        <descr/>
 
5088
        <errors/>
 
5089
        <seealso/>
 
5090
      </element>
 
5091
      <element name="TControl.WMMButtonQuadCLK.Message">
 
5092
        <short/>
 
5093
      </element>
 
5094
      <!-- procedure Visibility: protected -->
 
5095
      <element name="TControl.WMXButtonDown">
 
5096
        <short>Message handler for
 
5097
          extra mouse button going down.
 
5098
        </short>
 
5099
        <descr/>
 
5100
        <errors/>
 
5101
        <seealso/>
 
5102
      </element>
 
5103
      <element name="TControl.WMXButtonDown.Message">
 
5104
        <short/>
 
5105
      </element>
 
5106
      <!-- procedure Visibility: protected -->
 
5107
      <element name="TControl.WMXButtonDBLCLK">
 
5108
        <short>Message handler for
 
5109
          extra mouse button double click.
 
5110
        </short>
 
5111
        <descr/>
 
5112
        <errors/>
 
5113
        <seealso/>
 
5114
      </element>
 
5115
      <element name="TControl.WMXButtonDBLCLK.Message">
 
5116
        <short/>
 
5117
      </element>
 
5118
      <!-- procedure Visibility: protected -->
 
5119
      <element name="TControl.WMXButtonTripleCLK">
 
5120
        <short>Message handler for
 
5121
          extra mouse button triple click.
 
5122
        </short>
 
5123
        <descr/>
 
5124
        <errors/>
 
5125
        <seealso/>
 
5126
      </element>
 
5127
      <element name="TControl.WMXButtonTripleCLK.Message">
 
5128
        <short/>
 
5129
      </element>
 
5130
      <!-- procedure Visibility: protected -->
 
5131
      <element name="TControl.WMXButtonQuadCLK">
 
5132
        <short>Message handler for
 
5133
          extra mouse button quadruple click.
 
5134
        </short>
 
5135
        <descr/>
 
5136
        <errors/>
 
5137
        <seealso/>
 
5138
      </element>
 
5139
      <element name="TControl.WMXButtonQuadCLK.Message">
 
5140
        <short/>
 
5141
      </element>
 
5142
      <!-- procedure Visibility: protected -->
 
5143
      <element name="TControl.WMXButtonUp">
 
5144
        <short>Message handler for
 
5145
          extra mouse button going up.
 
5146
        </short>
 
5147
        <descr/>
 
5148
        <errors/>
 
5149
        <seealso/>
 
5150
      </element>
 
5151
      <element name="TControl.WMXButtonUp.Message">
 
5152
        <short/>
 
5153
      </element>
 
5154
      <!-- procedure Visibility: protected -->
 
5155
      <element name="TControl.WMMouseMove">
 
5156
        <short>Message handler for
 
5157
          mouse moved.
 
5158
        </short>
 
5159
        <descr/>
 
5160
        <errors/>
 
5161
        <seealso/>
 
5162
      </element>
 
5163
      <element name="TControl.WMMouseMove.Message">
 
5164
        <short/>
 
5165
      </element>
 
5166
      <!-- procedure Visibility: protected -->
 
5167
      <element name="TControl.WMLButtonUp">
 
5168
        <short>Message handler for
 
5169
          left mouse button going up.
 
5170
        </short>
 
5171
        <descr/>
 
5172
        <errors/>
 
5173
        <seealso/>
 
5174
      </element>
 
5175
      <element name="TControl.WMLButtonUp.Message">
 
5176
        <short/>
 
5177
      </element>
 
5178
      <!-- procedure Visibility: protected -->
 
5179
      <element name="TControl.WMRButtonUp">
 
5180
        <short>Message handler for
 
5181
          right mouse button going up.
 
5182
        </short>
 
5183
        <descr/>
 
5184
        <errors/>
 
5185
        <seealso/>
 
5186
      </element>
 
5187
      <element name="TControl.WMRButtonUp.Message">
 
5188
        <short/>
 
5189
      </element>
 
5190
      <!-- procedure Visibility: protected -->
 
5191
      <element name="TControl.WMMButtonUp">
 
5192
        <short>Message handler for
 
5193
          middle mouse button going up.
 
5194
        </short>
 
5195
        <descr/>
 
5196
        <errors/>
 
5197
        <seealso/>
 
5198
      </element>
 
5199
      <element name="TControl.WMMButtonUp.Message">
 
5200
        <short/>
 
5201
      </element>
 
5202
      <element name="TControl.WMMouseWheel">
 
5203
        <short/>
 
5204
      <notes><note>?</note>
 
5205
        </notes>
 
5206
      </element>
 
5207
      <element name="TControl.WMMouseWheel.Message">
 
5208
        <short/>
 
5209
      </element>
 
5210
      <!-- procedure Visibility: protected -->
 
5211
      <element name="TControl.WMMove">
 
5212
        <short>Message handler for
 
5213
          control moved.
 
5214
        </short>
 
5215
        <descr/>
 
5216
        <errors/>
 
5217
        <seealso/>
 
5218
      </element>
 
5219
      <element name="TControl.WMMove.Message">
 
5220
        <short/>
 
5221
      </element>
 
5222
      <!-- procedure Visibility: protected -->
 
5223
      <element name="TControl.WMSize">
 
5224
        <short>Message handler for
 
5225
          changed control size.
 
5226
        </short>
 
5227
        <descr/>
 
5228
        <errors/>
 
5229
        <seealso/>
 
5230
      </element>
 
5231
      <element name="TControl.WMSize.Message">
 
5232
        <short/>
 
5233
      </element>
 
5234
      <!-- procedure Visibility: protected -->
 
5235
      <element name="TControl.WMWindowPosChanged">
 
5236
        <short>Message handler for
 
5237
          changed control position.
 
5238
        </short>
 
5239
        <descr/>
 
5240
        <errors/>
 
5241
        <seealso/>
 
5242
      </element>
 
5243
      <element name="TControl.WMWindowPosChanged.Message">
 
5244
        <short/>
 
5245
      </element>
 
5246
      <!-- procedure Visibility: protected -->
 
5247
      <element name="TControl.LMCaptureChanged">
 
5248
        <short>Message handler for
 
5249
          changed capture.
 
5250
        </short>
 
5251
        <descr/>
 
5252
        <errors/>
 
5253
        <seealso/>
 
5254
      </element>
 
5255
      <element name="TControl.LMCaptureChanged.Message">
 
5256
        <short/>
 
5257
      </element>
 
5258
      <!-- procedure Visibility: private -->
 
5259
      <element name="TControl.CMBiDiModeChanged">
 
5260
        <short>Message handler for BiDi mode changed.</short>
 
5261
      </element>
 
5262
      <element name="TControl.CMBiDiModeChanged.Message">
 
5263
        <short/>
 
5264
      </element>
 
5265
      <!-- procedure Visibility: protected -->
 
5266
      <element name="TControl.CMSysFontChanged">
 
5267
        <short>Message handler for
 
5268
          changed system Font.
 
5269
        </short>
 
5270
        <descr/>
 
5271
        <errors/>
 
5272
        <seealso/>
 
5273
      </element>
 
5274
      <element name="TControl.CMSysFontChanged.Message">
 
5275
        <short/>
 
5276
      </element>
 
5277
      <!-- procedure Visibility: protected -->
 
5278
      <element name="TControl.CMEnabledChanged">
 
5279
        <short>Message handler for
 
5280
          changed Enabled state.
 
5281
        </short>
 
5282
        <descr/>
 
5283
        <errors/>
 
5284
        <seealso/>
 
5285
      </element>
 
5286
      <element name="TControl.CMEnabledChanged.Message">
 
5287
        <short/>
 
5288
      </element>
 
5289
      <!-- procedure Visibility: protected -->
 
5290
      <element name="TControl.CMHitTest">
 
5291
        <short>Message handler for
 
5292
          hit test.
 
5293
        </short>
 
5294
        <descr>The hit test handler determines the specific part of a control (caption, border...) at the given mouse position.
 
5295
        </descr>
 
5296
        <errors/>
 
5297
        <seealso/>
 
5298
      </element>
 
5299
      <element name="TControl.CMHitTest.Message">
 
5300
        <short/>
 
5301
      </element>
 
5302
      <!-- procedure Visibility: protected -->
 
5303
      <element name="TControl.CMMouseEnter">
 
5304
        <short>Message handler for
 
5305
          mouse entering the control.
 
5306
        </short>
 
5307
        <errors/>
 
5308
        <seealso/>
 
5309
      </element>
 
5310
      <element name="TControl.CMMouseEnter.Message">
 
5311
        <short/>
 
5312
      </element>
 
5313
      <!-- procedure Visibility: protected -->
 
5314
      <element name="TControl.CMMouseLeave">
 
5315
        <short>Message handler for
 
5316
          mouse leaving the control.
 
5317
        </short>
 
5318
        <descr/>
 
5319
        <errors/>
 
5320
        <seealso/>
 
5321
      </element>
 
5322
      <element name="TControl.CMMouseLeave.Message">
 
5323
        <short/>
 
5324
      </element>
 
5325
      <!-- procedure Visibility: protected -->
 
5326
      <element name="TControl.CMHintShow">
 
5327
        <short>Message handler for
 
5328
          hint display.
 
5329
        </short>
 
5330
        <descr/>
 
5331
        <errors/>
 
5332
        <seealso/>
 
5333
      </element>
 
5334
      <element name="TControl.CMHintShow.Message">
 
5335
        <short/>
 
5336
      </element>
 
5337
      <!-- procedure Visibility: private -->
 
5338
      <element name="TControl.CMParentBiDiModeChanged">
 
5339
        <short>Message handler for parent control's BiDi mode changed.</short>
 
5340
      </element>
 
5341
      <element name="TControl.CMParentBiDiModeChanged.Message">
 
5342
        <short/>
 
5343
      </element>
 
5344
      <!-- procedure Visibility: protected -->
 
5345
      <element name="TControl.CMParentFontChanged">
 
5346
        <short>Message handler for
 
5347
          changed parent Font.
 
5348
        </short>
 
5349
        <descr/>
 
5350
        <errors/>
 
5351
        <seealso/>
 
5352
      </element>
 
5353
      <element name="TControl.CMParentFontChanged.Message">
 
5354
        <short/>
 
5355
      </element>
 
5356
      <!-- procedure Visibility: protected -->
 
5357
      <element name="TControl.CMParentColorChanged">
 
5358
        <short>Message handler for
 
5359
          changed parent Color.
 
5360
        </short>
 
5361
        <descr/>
 
5362
        <errors/>
 
5363
        <seealso/>
 
5364
      </element>
 
5365
      <element name="TControl.CMParentColorChanged.Message">
 
5366
        <short/>
 
5367
      </element>
 
5368
      <!-- procedure Visibility: protected -->
 
5369
      <element name="TControl.CMParentShowHintChanged">
 
5370
        <short>Message handler for
 
5371
          changed parent ShowHint.
 
5372
        </short>
 
5373
        <descr/>
 
5374
        <errors/>
 
5375
        <seealso/>
 
5376
      </element>
 
5377
      <element name="TControl.CMParentShowHintChanged.Message">
 
5378
        <short/>
 
5379
      </element>
 
5380
      <!-- procedure Visibility: protected -->
 
5381
      <element name="TControl.CMVisibleChanged">
 
5382
        <short>Message handler for
 
5383
          changed visibility.
 
5384
        </short>
 
5385
        <descr/>
 
5386
        <errors/>
 
5387
        <seealso/>
 
5388
      </element>
 
5389
      <element name="TControl.CMVisibleChanged.Message">
 
5390
        <short/>
 
5391
      </element>
 
5392
      <!-- procedure Visibility: protected -->
 
5393
      <element name="TControl.CMTextChanged">
 
5394
        <short>Message handler for control's Text changed.</short>
 
5395
      </element>
 
5396
      <element name="TControl.CMTextChanged.Message">
 
5397
        <short/>
 
5398
      </element>
 
5399
      <element name="TControl.CMWantSpecialKey">
 
5400
        <short>Message handler for
 
5401
          special character (TAB...).
 
5402
        </short>
 
5403
      </element>
 
5404
      <element name="TControl.CMWantSpecialKey.Message">
 
5405
        <short/>
 
5406
      </element>
 
5407
      <!-- procedure Visibility: protected -->
 
5408
      <element name="TControl.CMCursorChanged">
 
5409
        <short>Message handler for
 
5410
          changed cursor.
 
5411
        </short>
 
5412
        <descr/>
 
5413
        <errors/>
 
5414
        <seealso/>
 
5415
      <notes><note>?</note>
 
5416
        </notes>
 
5417
      </element>
 
5418
      <element name="TControl.CMCursorChanged.Message">
 
5419
        <short/>
 
5420
      </element>
 
5421
      <!-- procedure Visibility: protected -->
 
5422
      <element name="TControl.CalculateDockSizes">
 
5423
        <short>Saves the docked and undocked extent of the control.</short>
 
5424
        <descr>
 
5425
          <p>In floating state sets UndockWidth/Height to the current Width/Height.</p>
 
5426
          <p>In docked state sets LRDockWidth/TBDockHeight to the current Width/Height.</p>
 
5427
          <remark>[Note: should save both in any case, independent from DockOrientation or host Align.
 
5428
            <br/>Rationale: a DockManager will either ignore these values, or use them according to the *new* alignment.
 
5429
            <br/>Without a DockManager both extents are required, because no (valid) alignment information applies.]
 
5430
          </remark>
 
5431
        </descr>
 
5432
      </element>
 
5433
      <!-- function Visibility: protected -->
 
5434
      <element name="TControl.CreateFloatingDockSite">
 
5435
        <short>Create a floating dock site with a client area equal to the given screen coordinates.
 
5436
        </short>
 
5437
        <descr>The new dock site is owned by the control
 
5438
        </descr>
 
5439
      <notes><note>Delphi: by Application!?</note>
 
5440
        </notes>
 
5441
      </element>
 
5442
      <element name="TControl.CreateFloatingDockSite.Result">
 
5443
        <short>The dock site, can be Nil for a TWinControl that can float by itself.</short>
 
5444
      </element>
 
5445
      <element name="TControl.CreateFloatingDockSite.Bounds">
 
5446
        <short>The bounds of the client area of the floating window.</short>
 
5447
      </element>
 
5448
      <!-- function Visibility: protected -->
 
5449
      <element name="TControl.GetDockEdge">
 
5450
        <short>Determine the side to which the dragged control shall be docked.</short>
 
5451
      </element>
 
5452
      <element name="TControl.GetDockEdge.Result">
 
5453
        <short/>
 
5454
      </element>
 
5455
      <element name="TControl.GetDockEdge.MousePos">
 
5456
        <short>Mouse position in client coordinates.</short>
 
5457
      </element>
 
5458
      <!-- function Visibility: protected -->
 
5459
      <element name="TControl.GetDragImages">
 
5460
        <short>Get the list of images usable during dragging.</short>
 
5461
      </element>
 
5462
      <element name="TControl.GetDragImages.Result">
 
5463
        <short/>
 
5464
      </element>
 
5465
      <!-- function Visibility: protected -->
 
5466
      <element name="TControl.GetFloating">
 
5467
        <short>Guess whether the control is floating.</short>
 
5468
        <descr>Floating state is assumed when the control has a HostDockSite of FloatingDockSiteClass, and is the only docked client.</descr>
 
5469
      </element>
 
5470
      <element name="TControl.GetFloating.Result">
 
5471
        <short/>
 
5472
      </element>
 
5473
      <!-- function Visibility: protected -->
 
5474
      <element name="TControl.GetFloatingDockSiteClass">
 
5475
        <short>Returns the class for a floating host dock site.</short>
 
5476
        <descr>
 
5477
          <p>An instance of this class is created whenever a control shall float,
 
5478
            but can not (or shall not) float by itself.
 
5479
          </p>
 
5480
          <p>Only TWinControls can float on the screen (with Parent=Nil), but not ordinary TControls.
 
5481
          </p>
 
5482
          <p>Since dockable forms are not supported by every platform,
 
5483
            also a dockable TWinControl may need an floating host,
 
5484
            which presents a docking handle to the user (e.g. a dock caption).
 
5485
          </p>
 
5486
        </descr>
 
5487
        <errors/>
 
5488
        <seealso>
 
5489
          <link id="TControl.CreateFloatingDockSite"/>
 
5490
        </seealso>
 
5491
      </element>
 
5492
      <element name="TControl.GetFloatingDockSiteClass.Result">
 
5493
        <short>The class of a floating host dock site for this control.</short>
 
5494
      </element>
 
5495
      <!-- procedure Visibility: protected -->
 
5496
      <element name="TControl.BeginAutoDrag">
 
5497
        <short>For internal use: user has started dragging the control.</short>
 
5498
      </element>
 
5499
      <!-- procedure Visibility: protected -->
 
5500
      <element name="TControl.DoFloatMsg">
 
5501
        <short>Handler called when the control starts floating.</short>
 
5502
        <descr>
 
5503
          <p>Since TControls cannot float for themselves,
 
5504
            a FloatHost site is created and the control is docked into it.</p>
 
5505
          <p>When the control already has a Parent (FloatHost site),
 
5506
            the Parent's position and extent is adjusted to fit the DockRect as its ClientRect.</p>
 
5507
        </descr>
 
5508
      </element>
 
5509
      <element name="TControl.DoFloatMsg.ADockSource">
 
5510
        <short>The DockObject of the current drag-dock operation.</short>
 
5511
      </element>
 
5512
      <!-- procedure Visibility: protected -->
 
5513
      <element name="TControl.DockTrackNoTarget">
 
5514
        <short>Adjust the DockRect for floating state (no drop target under the mouse).</short>
 
5515
        <descr/>
 
5516
        <errors/>
 
5517
        <seealso/>
 
5518
      </element>
 
5519
      <element name="TControl.DockTrackNoTarget.Source">
 
5520
        <short>The dragged DockObject, containing the DockRect to adjust.</short>
 
5521
      </element>
 
5522
      <element name="TControl.DockTrackNoTarget.X">
 
5523
        <short>The mouse position, in screen coordinates.</short>
 
5524
      </element>
 
5525
      <element name="TControl.DockTrackNoTarget.Y">
 
5526
        <short/>
 
5527
      </element>
 
5528
      <!-- procedure Visibility: protected -->
 
5529
      <element name="TControl.DoDock">
 
5530
        <short>Internal method, called by Dock. Adjusts the control's position and extent for the new docksite.</short>
 
5531
        <descr>
 
5532
          <p>If NewDockSite=Nil, Parent is set to Nil (in preparation of floating the control).
 
5533
          </p>
 
5534
          <p>Otherwise ARect is ignored (bug?), and recomputed to fit approximately into the ClientRect of the NewDockSite.
 
5535
          </p>
 
5536
          <p>Finally the computed coordinates are stored, in BoundsRectForNewParent when the NewDockSite differs from Parent, else in BoundsRect.
 
5537
          </p>
 
5538
        </descr>
 
5539
        <errors>A correct implementation should allow for computations in a derived class,
 
5540
          and accept and handle the changed bounds without any further adjustments.
 
5541
        </errors>
 
5542
        <seealso/>
 
5543
      </element>
 
5544
      <element name="TControl.DoDock.NewDockSite">
 
5545
        <short>The site where the control will be docked, or Nil when it becomes floating.</short>
 
5546
      </element>
 
5547
      <element name="TControl.DoDock.ARect">
 
5548
        <short>The control's new Bounds, in screen coordinates when NewDockSite is Nil, else in client coordinates of NewDockSite.
 
5549
        </short>
 
5550
      </element>
 
5551
      <!-- procedure Visibility: protected -->
 
5552
      <element name="TControl.DoDragMsg">
 
5553
        <short>Handler for a drag message, sent by the DragManager to the current target control.</short>
 
5554
        <descr>
 
5555
          <p>These messages can be sent while dragging:
 
5556
          </p>
 
5557
          <ul>
 
5558
            <li>On dmFindTarget: Request to determine the possible target control for an drop.
 
5559
              <br/>A TControl returns itself, a TWinControl finds the child control closest to the mouse position.
 
5560
            </li>
 
5561
            <li>On dmDragEnter/Leave/Move: Notification of mouse moves.
 
5562
              <br/>Invokes DragOver, or DockOver if docking.
 
5563
              Result indicates acceptance of an drop.</li>
 
5564
            <li>On dmDragDrop: The dragged object has been dropped onto this control.
 
5565
              <br/>Invokes DragDrop, or DockDrop if docking.</li>
 
5566
          </ul>
 
5567
          <p>The <var>Source</var> argument of the invoked methods is the DragDockObject when docking.
 
5568
            Else if the DragObject has been AutoCreated, the dragged control is passed as the Source;
 
5569
            otherwise the DragObject itself is passed as Source.
 
5570
          </p>
 
5571
        </descr>
 
5572
        <errors/>
 
5573
        <seealso/>
 
5574
      </element>
 
5575
      <element name="TControl.DoDragMsg.Result">
 
5576
        <short>Result is polymorphic:
 
5577
          On dmFindTarget the result is the target control reference,
 
5578
          on dmDragDrop it's zero,
 
5579
          else it indicates acceptance of an drop.
 
5580
        </short>
 
5581
      </element>
 
5582
      <element name="TControl.DoDragMsg.ADragMessage">
 
5583
        <short>The task to perform.</short>
 
5584
      </element>
 
5585
      <element name="TControl.DoDragMsg.APosition">
 
5586
        <short>The mouse position in <b>screen</b> coordinates.</short>
 
5587
      </element>
 
5588
      <element name="TControl.DoDragMsg.ADragObject">
 
5589
        <short>The drag object.</short>
 
5590
      </element>
 
5591
      <element name="TControl.DoDragMsg.ATarget">
 
5592
        <short>The drop target, Nil if none.</short>
 
5593
      </element>
 
5594
      <element name="TControl.DoDragMsg.ADocking">
 
5595
        <short>Distinguishes between a drag-drop and drag-dock operation.</short>
 
5596
      </element>
 
5597
      <!-- procedure Visibility: protected -->
 
5598
      <element name="TControl.DoEndDock">
 
5599
        <short>Invokes the <link id="#lcl.Controls.TControl.OnEndDock">OnEndDock</link> handler.</short>
 
5600
      </element>
 
5601
      <element name="TControl.DoEndDock.Target">
 
5602
        <short/>
 
5603
      </element>
 
5604
      <element name="TControl.DoEndDock.X">
 
5605
        <short/>
 
5606
      </element>
 
5607
      <element name="TControl.DoEndDock.Y">
 
5608
        <short/>
 
5609
      </element>
 
5610
      <!-- procedure Visibility: protected -->
 
5611
      <element name="TControl.DoEndDrag">
 
5612
        <short>Invokes the <link id="#lcl.Controls.TControl.OnEndDrag">OnEndDrag</link> handler.</short>
 
5613
      </element>
 
5614
      <element name="TControl.DoEndDrag.Target">
 
5615
        <short/>
 
5616
      </element>
 
5617
      <element name="TControl.DoEndDrag.X">
 
5618
        <short/>
 
5619
      </element>
 
5620
      <element name="TControl.DoEndDrag.Y">
 
5621
        <short/>
 
5622
      </element>
 
5623
      <!-- procedure Visibility: protected -->
 
5624
      <element name="TControl.DoStartDock">
 
5625
        <short>Invokes the <link id="#lcl.Controls.TControl.OnStartDock">OnStartDock</link> handler</short>
 
5626
      </element>
 
5627
      <element name="TControl.DoStartDock.DragObject">
 
5628
        <short/>
 
5629
      </element>
 
5630
      <!-- procedure Visibility: protected -->
 
5631
      <element name="TControl.DoStartDrag">
 
5632
        <short>Invokes the <link id="#lcl.Controls.TControl.OnStartDrag">OnStartDrag</link> handler</short>
 
5633
      </element>
 
5634
      <element name="TControl.DoStartDrag.DragObject">
 
5635
        <short/>
 
5636
      </element>
 
5637
      <!-- procedure Visibility: protected -->
 
5638
      <element name="TControl.DragCanceled">
 
5639
        <short>Notifies the control of a canceld drag.</short>
 
5640
        <descr/>
 
5641
        <errors/>
 
5642
        <seealso/>
 
5643
      </element>
 
5644
      <!-- procedure Visibility: protected -->
 
5645
      <element name="TControl.DragOver">
 
5646
        <short>Called when an object is dragged over this control.
 
5647
          Determines whether a drop is acceptable, using the OnDragOver handler.
 
5648
        </short>
 
5649
        <descr>
 
5650
          <p>An OnDragOver handler is required, or any drop will be rejected (Accept becomes False).</p>
 
5651
          <p>When an OnDragOver handler is installed, Accept is set to True and can be changed by the handler.</p>
 
5652
          <remark>Caution: Source can be either a TDragObject, or the dragged control.</remark>
 
5653
        </descr>
 
5654
        <seealso>
 
5655
          <link id="TControl.OnDragOver"/>
 
5656
          <link id="TControl.DockOver"/>
 
5657
        </seealso>
 
5658
      </element>
 
5659
      <element name="TControl.DragOver.Source">
 
5660
        <short>The dragged object, a control or a DragObject.</short>
 
5661
      </element>
 
5662
      <element name="TControl.DragOver.X">
 
5663
        <short>The mouse position in client coordinates.</short>
 
5664
      </element>
 
5665
      <element name="TControl.DragOver.Y">
 
5666
        <short/>
 
5667
      </element>
 
5668
      <element name="TControl.DragOver.State">
 
5669
        <short>State change flag (dsDragEnter, dsDragMove, dsDragLeave).</short>
 
5670
      </element>
 
5671
      <element name="TControl.DragOver.Accept">
 
5672
        <short>Set to True when a drop is allowed.</short>
 
5673
      </element>
 
5674
      <!-- procedure Visibility: protected -->
 
5675
      <element name="TControl.PositionDockRect">
 
5676
        <short>Get the DockRect for an possible drop.</short>
 
5677
        <descr>Either calls the DockManager.PositionDockRect of the target site,
 
5678
          or DragDockObject.AdjustDockRect after moving the undocked control rectangle to the DragPos.
 
5679
          AdjustDockRect takes the hotspot of the DockRect into account.
 
5680
        </descr>
 
5681
        <errors/>
 
5682
        <seealso>
 
5683
          <link id="TDragDockObject.AdjustDockRect"/>
 
5684
        </seealso>
 
5685
      </element>
 
5686
      <element name="TControl.PositionDockRect.DragDockObject">
 
5687
        <short/>
 
5688
      </element>
 
5689
      <!-- procedure Visibility: protected -->
 
5690
      <element link="TControl.DragMode" name="TControl.SetDragMode"/>
 
5691
      <element name="TControl.SetDragMode.Value">
 
5692
        <short/>
 
5693
      </element>
 
5694
      <!-- function Visibility: protected -->
 
5695
      <element name="TControl.GetDefaultDockCaption">
 
5696
        <short>Returns the string for the dock caption, by default the control's Name.</short>
 
5697
        <descr/>
 
5698
        <errors/>
 
5699
        <seealso/>
 
5700
      </element>
 
5701
      <element name="TControl.GetDefaultDockCaption.Result">
 
5702
        <short/>
 
5703
      </element>
 
5704
      <!-- procedure Visibility: protected -->
 
5705
      <element name="TControl.Click">
 
5706
        <short>Invokes the
 
5707
          <link id="#lcl.Controls.TControl.OnClick">OnClick</link>
 
5708
          and ActionLink.Execute
 
5709
          handlers.</short>
 
5710
      </element>
 
5711
      <!-- procedure Visibility: protected -->
 
5712
      <element name="TControl.DblClick">
 
5713
        <short>Invokes the
 
5714
          <link id="#lcl.Controls.TControl.OnDblClick">OnDblClick</link>
 
5715
          handler.</short>
 
5716
      </element>
 
5717
      <!-- procedure Visibility: protected -->
 
5718
      <element name="TControl.TripleClick">
 
5719
        <short>Invokes the
 
5720
          <link id="#lcl.Controls.TControl.OnTripleClick">OnTripleClick</link>
 
5721
          handler.</short>
 
5722
      </element>
 
5723
      <!-- procedure Visibility: protected -->
 
5724
      <element name="TControl.QuadClick">
 
5725
        <short>Invokes the
 
5726
          <link id="#lcl.Controls.TControl.OnQuadClick">OnQuadClick</link>
 
5727
          handler.</short>
 
5728
      </element>
 
5729
      <!-- procedure Visibility: protected -->
 
5730
      <element name="TControl.MouseDown">
 
5731
        <short>Handler for MouseDown events.</short>
 
5732
        <descr>
 
5733
          <p>Called by the MouseDown message handler.
 
5734
            Handles Focus changes,
 
5735
            notifies the DragManager while dragging.
 
5736
            Finally calls the <link id="TControl.OnMouseDown"/> handler.</p>
 
5737
        </descr>
 
5738
      </element>
 
5739
      <element name="TControl.MouseDown.Button">
 
5740
        <short>which buttons are down</short>
 
5741
      </element>
 
5742
      <element name="TControl.MouseDown.Shift">
 
5743
        <short>which of Ctrl, Shift or Alt keys are also pressed</short>
 
5744
      </element>
 
5745
      <element name="TControl.MouseDown.X">
 
5746
        <short>Mouse position in <b>client</b> coordinates.</short>
 
5747
      </element>
 
5748
      <element name="TControl.MouseDown.Y">
 
5749
        <short/>
 
5750
      </element>
 
5751
      <!-- procedure Visibility: protected -->
 
5752
      <element name="TControl.MouseMove">
 
5753
        <short>Handler for MouseMove events.</short>
 
5754
        <descr>
 
5755
          <p>Called by the MouseMove message handler.
 
5756
            The DragManager is notified while the control is being dragged.
 
5757
            Finally the <link id="#lcl.Controls.TControl.OnMouseMove">OnMouseMove</link> handler is invoked.</p>
 
5758
        </descr>
 
5759
      </element>
 
5760
      <element name="TControl.MouseMove.Shift">
 
5761
        <short>The currently pressed mouse buttons and modifier keys.
 
5762
        </short>
 
5763
      </element>
 
5764
      <element name="TControl.MouseMove.X">
 
5765
        <short>Mouse position in <b>client</b> coordinates.</short>
 
5766
      </element>
 
5767
      <element name="TControl.MouseMove.Y">
 
5768
        <short/>
 
5769
      </element>
 
5770
      <!-- procedure Visibility: protected -->
 
5771
      <element name="TControl.MouseUp">
 
5772
        <short>Invokes the
 
5773
          <link id="#lcl.Controls.TControl.OnMouseUp">OnMouseUp</link> handler.</short>
 
5774
        <descr/>
 
5775
        <errors/>
 
5776
        <seealso/>
 
5777
      </element>
 
5778
      <element name="TControl.MouseUp.Button">
 
5779
        <short>The currently pressed modifier keys.
 
5780
        </short>
 
5781
      </element>
 
5782
      <element name="TControl.MouseUp.Shift">
 
5783
        <short>The currently pressed mouse buttons.
 
5784
        </short>
 
5785
      </element>
 
5786
      <element name="TControl.MouseUp.X">
 
5787
        <short>Mouse position in <b>client</b> coordinates.</short>
 
5788
      </element>
 
5789
      <element name="TControl.MouseUp.Y">
 
5790
        <short/>
 
5791
      </element>
 
5792
      <!-- procedure Visibility: protected -->
 
5793
      <element name="TControl.MouseEnter">
 
5794
        <short>Invokes the
 
5795
          <link id="#lcl.Controls.TControl.OnMouseEnter">OnMouseEnter</link> handler.</short>
 
5796
        <descr/>
 
5797
        <errors/>
 
5798
        <seealso/>
 
5799
      </element>
 
5800
      <!-- procedure Visibility: protected -->
 
5801
      <element name="TControl.MouseLeave">
 
5802
        <short>Invokes the
 
5803
          <link id="#lcl.Controls.TControl.OnMouseLeave">OnMouseLeave</link> handler.</short>
 
5804
        <descr/>
 
5805
        <errors/>
 
5806
        <seealso/>
 
5807
      </element>
 
5808
      <!-- function Visibility: protected -->
 
5809
      <element name="TControl.DialogChar">
 
5810
        <short>Do something useful with accelerators etc.</short>
 
5811
        <descr/>
 
5812
        <errors/>
 
5813
        <seealso/>
 
5814
      </element>
 
5815
      <element name="TControl.DialogChar.Result">
 
5816
        <short/>
 
5817
      <notes><note>?</note>
 
5818
        </notes>
 
5819
      </element>
 
5820
      <element name="TControl.DialogChar.Message">
 
5821
        <short/>
 
5822
      </element>
 
5823
      <!-- procedure Visibility: protected -->
 
5824
      <element name="TControl.UpdateMouseCursor">
 
5825
        <short>Show the Cursor shape, unless it's crDefault.</short>
 
5826
        <descr/>
 
5827
        <errors/>
 
5828
        <seealso/>
 
5829
      </element>
 
5830
      <element name="TControl.UpdateMouseCursor.X">
 
5831
        <short/>
 
5832
      <notes><note>?</note>
 
5833
        </notes>
 
5834
      </element>
 
5835
      <element name="TControl.UpdateMouseCursor.Y">
 
5836
        <short/>
 
5837
      </element>
 
5838
      <!-- procedure Visibility: protected -->
 
5839
      <element name="TControl.Changed">
 
5840
        <short>Call this method whenever a change has occured, to trigger further processing.</short>
 
5841
        <descr/>
 
5842
        <errors/>
 
5843
        <seealso/>
 
5844
      </element>
 
5845
      <!-- function Visibility: protected -->
 
5846
      <element name="TControl.GetPalette">
 
5847
        <short>Override
 
5848
          <var>GetPalette</var> to return the handle of a color palette.</short>
 
5849
        <descr/>
 
5850
        <errors/>
 
5851
        <seealso/>
 
5852
      </element>
 
5853
      <element name="TControl.GetPalette.Result">
 
5854
        <short>The Palette handle, zero (no Palette) by default.</short>
 
5855
      </element>
 
5856
      <!-- function Visibility: protected -->
 
5857
      <element name="TControl.ChildClassAllowed">
 
5858
        <short>Returns True if the specified class is allowed for children of this control.</short>
 
5859
        <descr/>
 
5860
        <errors/>
 
5861
        <seealso/>
 
5862
      </element>
 
5863
      <element name="TControl.ChildClassAllowed.Result">
 
5864
        <short>True when the class is acceptable.</short>
 
5865
      </element>
 
5866
      <element name="TControl.ChildClassAllowed.ChildClass">
 
5867
        <short>The class type of the child control.</short>
 
5868
      </element>
 
5869
      <!-- procedure Visibility: protected -->
 
5870
      <element link="#rtl.Classes.TComponent.ReadState" name="TControl.ReadState"/>
 
5871
      <element name="TControl.ReadState.Reader">
 
5872
        <short/>
 
5873
      </element>
 
5874
      <!-- procedure Visibility: protected -->
 
5875
      <element link="#rtl.Classes.TComponent.Loaded" name="TControl.Loaded"/>
 
5876
      <!-- procedure Visibility: protected -->
 
5877
      <element name="TControl.LoadedAll">
 
5878
        <short/>
 
5879
        <descr/>
 
5880
        <errors/>
 
5881
        <seealso/>
 
5882
      <notes><note>?</note>
 
5883
        </notes>
 
5884
      </element>
 
5885
      <!-- procedure Visibility: protected -->
 
5886
      <element name="TControl.DefineProperties">
 
5887
        <short>Defines which non-published properties should be streamed (none here).</short>
 
5888
        <seealso>
 
5889
          <link id="#rtl.Classes.TComponent.DefineProperties">TComponent.DefineProperties</link>
 
5890
          <link id="#rtl.Classes.TPersistent.DefineProperties">TPersistent.DefineProperties</link>
 
5891
        </seealso>
 
5892
      </element>
 
5893
      <element name="TControl.DefineProperties.Filer">
 
5894
        <short/>
 
5895
      </element>
 
5896
      <!-- procedure Visibility: protected -->
 
5897
      <element name="TControl.AssignTo">
 
5898
        <short>Implements the assignment to an Action object, otherwise calls the inherited method.
 
5899
        </short>
 
5900
        <descr>
 
5901
          <p>The copied properties are:</p>
 
5902
          <ul>
 
5903
            <li>Enabled</li>
 
5904
            <li>Hint</li>
 
5905
            <li>Caption</li>
 
5906
            <li>Visible</li>
 
5907
            <li>OnExecute (copied to OnClick)</li>
 
5908
            <li>HelpContext</li>
 
5909
            <li>HelpKeyword</li>
 
5910
            <li>HelpType</li>
 
5911
          </ul>
 
5912
        </descr>
 
5913
        <seealso>
 
5914
          <link id="#rtl.Classes.TPersistent.AssignTo"/>
 
5915
        </seealso>
 
5916
      </element>
 
5917
      <element name="TControl.AssignTo.Dest">
 
5918
        <short/>
 
5919
      </element>
 
5920
      <!-- procedure Visibility: protected -->
 
5921
      <element name="TControl.FormEndUpdated">
 
5922
        <short>Called when the update of the containing Form has ended.</short>
 
5923
        <descr/>
 
5924
        <errors/>
 
5925
        <seealso/>
 
5926
      </element>
 
5927
      <!-- procedure Visibility: protected -->
 
5928
      <element name="TControl.InvalidateControl">
 
5929
        <short>Request a repaint of the control.</short>
 
5930
        <descr/>
 
5931
        <errors/>
 
5932
        <seealso/>
 
5933
      </element>
 
5934
      <element name="TControl.InvalidateControl.CtrlIsVisible">
 
5935
        <short/>
 
5936
      </element>
 
5937
      <element name="TControl.InvalidateControl.CtrlIsOpaque">
 
5938
        <short/>
 
5939
      </element>
 
5940
      <element name="TControl.InvalidateControl.IgnoreWinControls">
 
5941
        <short/>
 
5942
      </element>
 
5943
      <!-- procedure Visibility: protected -->
 
5944
      <element name="TControl.FontChanged">
 
5945
        <short>Handles changes of the Font property.</short>
 
5946
        <descr/>
 
5947
        <errors/>
 
5948
        <seealso/>
 
5949
      </element>
 
5950
      <element name="TControl.FontChanged.Sender">
 
5951
        <short/>
 
5952
      </element>
 
5953
      <!-- procedure Visibility: protected -->
 
5954
      <element name="TControl.ParentFontChanged">
 
5955
        <short>[Delphi compatible] Does nothing here, all work is done in CMParentFontChanged.
 
5956
        </short>
 
5957
        <descr/>
 
5958
        <errors/>
 
5959
        <seealso/>
 
5960
      </element>
 
5961
      <!-- function Visibility: protected -->
 
5962
      <element link="TControl.Action" name="TControl.GetAction"/>
 
5963
      <element name="TControl.GetAction.Result">
 
5964
        <short/>
 
5965
      </element>
 
5966
      <!-- function Visibility: protected -->
 
5967
      <element name="TControl.RealGetText">
 
5968
        <short>Returns the Caption property.</short>
 
5969
        <descr>This method is called by <var>GetText</var>, when GetTextBuf is not overridden.</descr>
 
5970
        <seealso>
 
5971
          <link id="#lcl.Controls.TControl.GetTextBuf">GetTextBuf</link>
 
5972
          <link id="#lcl.Controls.TControl.RealSetText">RealSetText</link>
 
5973
          <link id="#lcl.Controls.TControl.SetTextBuf">SetTextBuf</link>
 
5974
        </seealso>
 
5975
      </element>
 
5976
      <element name="TControl.RealGetText.Result">
 
5977
        <short>The Caption property.</short>
 
5978
      </element>
 
5979
      <!-- procedure Visibility: protected -->
 
5980
      <element name="TControl.RealSetText">
 
5981
        <short>Sets the Caption property.</short>
 
5982
        <descr>This method is called by <var>SetText</var>, when SetTextBuf is not overridden.</descr>
 
5983
        <seealso>
 
5984
          <link id="#lcl.Controls.TControl.SetTextBuf">SetTextBuf</link>
 
5985
          <link id="#lcl.Controls.TControl.RealGetText">RealGetText</link>
 
5986
          <link id="#lcl.Controls.TControl.GetTextBuf">GetTextBuf</link>
 
5987
        </seealso>
 
5988
      </element>
 
5989
      <element name="TControl.RealSetText.Value">
 
5990
        <short>The string to store.</short>
 
5991
      </element>
 
5992
      <!-- procedure Visibility: protected -->
 
5993
      <element name="TControl.TextChanged">
 
5994
        <short>Handles changes of the Text property.</short>
 
5995
        <descr/>
 
5996
        <errors/>
 
5997
        <seealso/>
 
5998
      </element>
 
5999
      <!-- function Visibility: protected -->
 
6000
      <element name="TControl.GetCachedText">
 
6001
        <short>Returns the cached Text property (FCaption).</short>
 
6002
        <descr/>
 
6003
        <errors/>
 
6004
        <seealso/>
 
6005
      </element>
 
6006
      <element name="TControl.GetCachedText.Result">
 
6007
        <short>True if successful.</short>
 
6008
      </element>
 
6009
      <element name="TControl.GetCachedText.CachedText">
 
6010
        <short>Here: FCaption (can be overridden).</short>
 
6011
      </element>
 
6012
      <!-- procedure Visibility: protected -->
 
6013
      <element link="TControl.Action" name="TControl.SetAction"/>
 
6014
      <element name="TControl.SetAction.Value">
 
6015
        <short/>
 
6016
      </element>
 
6017
      <!-- procedure Visibility: protected -->
 
6018
      <element link="TControl.Color" name="TControl.SetColor"/>
 
6019
      <element name="TControl.SetColor.Value">
 
6020
        <short/>
 
6021
      </element>
 
6022
      <!-- procedure Visibility: protected -->
 
6023
      <element link="TControl.Enabled" name="TControl.SetEnabled"/>
 
6024
      <element name="TControl.SetEnabled.Value">
 
6025
        <short/>
 
6026
      </element>
 
6027
      <!-- procedure Visibility: protected -->
 
6028
      <element link="TControl.Hint" name="TControl.SetHint"/>
 
6029
      <element name="TControl.SetHint.Value">
 
6030
        <short/>
 
6031
      </element>
 
6032
      <!-- procedure Visibility: protected -->
 
6033
      <element link="TControl.Name" name="TControl.SetName"/>
 
6034
      <element name="TControl.SetName.Value">
 
6035
        <short/>
 
6036
      </element>
 
6037
      <!-- procedure Visibility: protected -->
 
6038
      <element link="TControl.Parent" name="TControl.SetParent"/>
 
6039
      <element name="TControl.SetParent.NewParent">
 
6040
        <short/>
 
6041
      </element>
 
6042
      <!-- procedure Visibility: protected -->
 
6043
      <element name="TControl.SetParentComponent">
 
6044
        <short>Sets the Parent property, if NewParentComponent is a TWinControl.</short>
 
6045
        <descr/>
 
6046
        <errors/>
 
6047
        <seealso/>
 
6048
      </element>
 
6049
      <element name="TControl.SetParentComponent.NewParentComponent">
 
6050
        <short/>
 
6051
      </element>
 
6052
      <!-- procedure Visibility: protected -->
 
6053
      <element name="TControl.WndProc">
 
6054
        <short>The general message handler for this control.</short>
 
6055
        <descr>Preprocesses several messages, then calls Dispatch to invoke the applicable message handler.</descr>
 
6056
        <errors/>
 
6057
        <seealso/>
 
6058
      </element>
 
6059
      <element name="TControl.WndProc.TheMessage">
 
6060
        <short>The message to handle.</short>
 
6061
      </element>
 
6062
      <!-- procedure Visibility: protected -->
 
6063
      <element name="TControl.ParentFormHandleInitialized">
 
6064
        <short>Internal handler for activities after a form widget has been created.
 
6065
        </short>
 
6066
        <descr>
 
6067
          <p>Called by <var>ChildHandlesCreated</var> of parent form.
 
6068
          </p>
 
6069
          <p>Functions like GetTextWidth require valid widgets and their device contexts.
 
6070
            That's why AutoSizing is delayed till this moment.
 
6071
          </p>
 
6072
        </descr>
 
6073
      </element>
 
6074
      <!-- procedure Visibility: protected -->
 
6075
      <element name="TControl.CaptureChanged">
 
6076
        <short>Handler for mouse capture moved to a different control.</short>
 
6077
        <descr>Notifies the DragManager of the changed capture control, to stop dragging this control.
 
6078
          A very dangerous implementation, that can cause immediate abort of dragging before dragging really starts.
 
6079
        </descr>
 
6080
        <errors/>
 
6081
        <seealso/>
 
6082
      </element>
 
6083
      <!-- procedure Visibility: protected -->
 
6084
      <element name="TControl.Notification">
 
6085
        <short>Notification handler for insertion or deletion of components.</short>
 
6086
        <descr>
 
6087
          <p>First the inherited <link id="#rtl.Classes.TComponent.Notification"/> is invoked,
 
6088
            to notify all attached notification handlers.</p>
 
6089
          <p>If Operation is removal, additional actions are performed, depending on AComponent:<br/>
 
6090
            PopupMenu, Action, or anchors to the removed control are detached.</p>
 
6091
        </descr>
 
6092
        <seealso>
 
6093
          <link id="#rtl.Classes.TComponent.Notification"/>
 
6094
        </seealso>
 
6095
      </element>
 
6096
      <element name="TControl.Notification.AComponent">
 
6097
        <short>The component being inserted or removed.</short>
 
6098
      </element>
 
6099
      <element name="TControl.Notification.Operation">
 
6100
        <short>The action (opInsert or opRemove).</short>
 
6101
      </element>
 
6102
      <!-- function Visibility: protected -->
 
6103
      <element name="TControl.CanTab">
 
6104
        <short>If True, the Tab key can be used to navigate to this control.</short>
 
6105
        <descr/>
 
6106
        <errors/>
 
6107
        <seealso/>
 
6108
      </element>
 
6109
      <element name="TControl.CanTab.Result">
 
6110
        <short/>
 
6111
      </element>
 
6112
      <!-- function Visibility: protected -->
 
6113
      <element name="TControl.GetDeviceContext">
 
6114
        <short>Returns a device context handle for the control, from Parent.
 
6115
        </short>
 
6116
        <descr>Initializes the device context position to the control origin,
 
6117
          and shrinks its clipping rectangle to the control bounds.
 
6118
        </descr>
 
6119
        <errors/>
 
6120
        <seealso/>
 
6121
      </element>
 
6122
      <element name="TControl.GetDeviceContext.Result">
 
6123
        <short>The device context.</short>
 
6124
      </element>
 
6125
      <element name="TControl.GetDeviceContext.WindowHandle">
 
6126
        <short>Returns the window handle of the device context.</short>
 
6127
      </element>
 
6128
      <!-- function Visibility: protected -->
 
6129
      <element link="TControl.Enabled" name="TControl.GetEnabled"/>
 
6130
      <element name="TControl.GetEnabled.Result">
 
6131
        <short/>
 
6132
      </element>
 
6133
      <!-- function Visibility: protected -->
 
6134
      <element link="TControl.PopupMenu" name="TControl.GetPopupMenu"/>
 
6135
      <element name="TControl.GetPopupMenu.Result">
 
6136
        <short/>
 
6137
      </element>
 
6138
      <!-- procedure Visibility: protected -->
 
6139
      <element name="TControl.DoOnShowHint">
 
6140
        <short>Invokes the <var>OnShowHint</var> event handler.</short>
 
6141
        <descr/>
 
6142
        <errors/>
 
6143
        <seealso/>
 
6144
      </element>
 
6145
      <element name="TControl.DoOnShowHint.HintInfo">
 
6146
        <short/>
 
6147
      </element>
 
6148
      <!-- procedure Visibility: protected -->
 
6149
      <element name="TControl.DoMouseWheel">
 
6150
        <short>Invokes the OnMouseWheel handlers, when the wheel has been turned.
 
6151
        </short>
 
6152
        <descr>
 
6153
          <p>Multiple wheel handlers can be implemented.
 
6154
            First the general OnMouseWheel handler is tried, and if it doesn't report the event handled,
 
6155
            then OnMouseWheelUp or OnMouseWheelDown are tried.
 
6156
          </p>
 
6157
          <p>The actual WheelDelta is available <b>only</b> to the OnMouseWheel handler,
 
6158
            not to the up and down handlers [Delphi compatible].
 
6159
          </p>
 
6160
        </descr>
 
6161
        <seealso>
 
6162
          <link id="TMouseWheelEvent"/>
 
6163
          <link id="TMouseWheelUpDownEvent"/>
 
6164
        </seealso>
 
6165
      </element>
 
6166
      <element name="TControl.DoMouseWheel.Result">
 
6167
        <short>Set Result to True if handled.</short>
 
6168
      </element>
 
6169
      <element name="TControl.DoMouseWheel.Shift">
 
6170
        <short>State of the modifier keys and mouse buttons.</short>
 
6171
      </element>
 
6172
      <element name="TControl.DoMouseWheel.WheelDelta">
 
6173
        <short>How many notches the wheel has been turned.</short>
 
6174
      </element>
 
6175
      <element name="TControl.DoMouseWheel.MousePos">
 
6176
        <short>The mouse coordinates</short>
 
6177
      <notes><note>client/screen?</note>
 
6178
        </notes>
 
6179
      </element>
 
6180
      <!-- procedure Visibility: protected -->
 
6181
      <element name="TControl.DoMouseWheelDown">
 
6182
        <short>Invokes the OnMouseWheelDown handler.</short>
 
6183
      </element>
 
6184
      <element name="TControl.DoMouseWheelDown.Result">
 
6185
        <short>True if handled.</short>
 
6186
      </element>
 
6187
      <element link="TMouseWheelEvent.Shift" name="TControl.DoMouseWheelDown.Shift">
 
6188
        <short/>
 
6189
      </element>
 
6190
      <element link="TMouseWheelEvent.MousePos" name="TControl.DoMouseWheelDown.MousePos">
 
6191
        <short/>
 
6192
      </element>
 
6193
      <!-- procedure Visibility: protected -->
 
6194
      <element name="TControl.DoMouseWheelUp">
 
6195
        <short>Invokes the OnMouseWheelUp handler.</short>
 
6196
      </element>
 
6197
      <element name="TControl.DoMouseWheelUp.Result">
 
6198
        <short>True if handled.</short>
 
6199
      </element>
 
6200
      <element link="TMouseWheelEvent.Shift" name="TControl.DoMouseWheelUp.Shift">
 
6201
        <short/>
 
6202
      </element>
 
6203
      <element link="TMouseWheelEvent.MousePos" name="TControl.DoMouseWheelUp.MousePos">
 
6204
        <short/>
 
6205
      </element>
 
6206
      <!-- procedure Visibility: protected -->
 
6207
      <element name="TControl.VisibleChanging">
 
6208
        <short>Notifies all <var>OnVisibleChanging</var> handlers.</short>
 
6209
      </element>
 
6210
      <!-- procedure Visibility: protected -->
 
6211
      <element name="TControl.VisibleChanged">
 
6212
        <short>Notifies all OnVisibleChanged handlers.</short>
 
6213
      </element>
 
6214
      <!-- procedure Visibility: protected -->
 
6215
      <element name="TControl.EnabledChanging">
 
6216
        <short>Notifies all OnEnabledChanging handlers.</short>
 
6217
      </element>
 
6218
      <!-- procedure Visibility: protected -->
 
6219
      <element name="TControl.EnabledChanged">
 
6220
        <short>Notifies all OnEnabledChanged handlers.</short>
 
6221
      </element>
 
6222
      <!-- procedure Visibility: protected -->
 
6223
      <element name="TControl.AddHandler">
 
6224
        <short>Adds an notification handler.</short>
 
6225
        <descr>Notification handlers allow to notify other components of certain events.
 
6226
          When the registered event occurs, all installed (added) handlers are invoked.
 
6227
        </descr>
 
6228
      </element>
 
6229
      <element name="TControl.AddHandler.HandlerType">
 
6230
        <short>Type of the event.</short>
 
6231
      </element>
 
6232
      <element name="TControl.AddHandler.AMethod">
 
6233
        <short>The handler to be added.</short>
 
6234
      </element>
 
6235
      <element name="TControl.AddHandler.AsFirst">
 
6236
        <short>Unused.</short>
 
6237
      <notes><note>If true, the handler is added before all installed handlers?</note>
 
6238
        </notes>
 
6239
      </element>
 
6240
      <!-- procedure Visibility: protected -->
 
6241
      <element name="TControl.RemoveHandler">
 
6242
        <short>Removes the given notification handler.</short>
 
6243
        <seealso>
 
6244
          <link id="TControl.AddHandler"/>
 
6245
        </seealso>
 
6246
      </element>
 
6247
      <element name="TControl.RemoveHandler.HandlerType">
 
6248
        <short>Type of the notification.</short>
 
6249
      </element>
 
6250
      <element name="TControl.RemoveHandler.AMethod">
 
6251
        <short>The handler to be removed.</short>
 
6252
      </element>
 
6253
      <!-- procedure Visibility: protected -->
 
6254
      <element name="TControl.DoCallNotifyHandler">
 
6255
        <short>Invokes all notification handlers of the specified type.</short>
 
6256
        <descr/>
 
6257
        <errors/>
 
6258
        <seealso/>
 
6259
      </element>
 
6260
      <element name="TControl.DoCallNotifyHandler.HandlerType">
 
6261
        <short>The event that has occured.</short>
 
6262
      </element>
 
6263
      <!-- procedure Visibility: protected -->
 
6264
      <element name="TControl.DoContextPopup">
 
6265
        <short>Invokes the OnContextPopup handler.</short>
 
6266
        <errors/>
 
6267
        <seealso/>
 
6268
      </element>
 
6269
      <element name="TControl.DoContextPopup.MousePos">
 
6270
        <short>Mouse position, used to place the menu.</short>
 
6271
      </element>
 
6272
      <element name="TControl.DoContextPopup.Handled">
 
6273
        <short>To be set by the handler, when it has handled the menu display and selection.</short>
 
6274
      </element>
 
6275
      <!-- procedure Visibility: public -->
 
6276
      <element name="TControl.SetZOrder">
 
6277
        <short>Moves the control in front or back of all sibling controls.</short>
 
6278
        <descr/>
 
6279
        <errors/>
 
6280
        <seealso/>
 
6281
      </element>
 
6282
      <element name="TControl.SetZOrder.TopMost">
 
6283
        <short/>
 
6284
      </element>
 
6285
      <!-- function Visibility: public -->
 
6286
      <element name="TControl.GetControlClassDefaultSize">
 
6287
        <short>Returns the default size for this class of controls (when added to a form).</short>
 
6288
      </element>
 
6289
      <element name="TControl.GetControlClassDefaultSize.Result">
 
6290
        <short/>
 
6291
      </element>
 
6292
      <!-- function Visibility: public -->
 
6293
      <element link="TControl.Color" name="TControl.ColorIsStored"/>
 
6294
      <element name="TControl.ColorIsStored.Result">
 
6295
        <short/>
 
6296
      </element>
 
6297
      <!-- function Visibility: protected -->
 
6298
      <element name="TControl.GetActionLinkClass">
 
6299
        <short>The default ActionLink class (TControlActionLink).</short>
 
6300
        <descr>Used when the control is linked to an Action.</descr>
 
6301
        <errors/>
 
6302
        <seealso/>
 
6303
      </element>
 
6304
      <element name="TControl.GetActionLinkClass.Result">
 
6305
        <short/>
 
6306
      </element>
 
6307
      <!-- procedure Visibility: protected -->
 
6308
      <element name="TControl.ActionChange">
 
6309
        <short>Handler for a changed Action.</short>
 
6310
        <descr>Several properties are copied from the new Action.</descr>
 
6311
      </element>
 
6312
      <element name="TControl.ActionChange.Sender">
 
6313
        <short>The changed Action.</short>
 
6314
      </element>
 
6315
      <element name="TControl.ActionChange.CheckDefaults">
 
6316
        <short>When True, forces update of all properties. Otherwise only properties in default state are overwritten.</short>
 
6317
      </element>
 
6318
      <!-- procedure Visibility: public -->
 
6319
      <element name="TControl.DragDrop">
 
6320
        <short>Invokes the OnDragDrop handler, when a dragged object is dropped onto this control.</short>
 
6321
        <seealso>
 
6322
          <link id="TControl.OnDragDrop"/>
 
6323
        </seealso>
 
6324
      </element>
 
6325
      <element name="TControl.DragDrop.Source">
 
6326
        <short>The dropped object (control or DragDrop object)</short>
 
6327
      </element>
 
6328
      <element name="TControl.DragDrop.X">
 
6329
        <short>The drop position in client coordinates.</short>
 
6330
      </element>
 
6331
      <element name="TControl.DragDrop.Y">
 
6332
        <short>The drop position in client coordinates.</short>
 
6333
      </element>
 
6334
      <!-- procedure Visibility: public -->
 
6335
      <element name="TControl.Dock">
 
6336
        <short>Moves the control into a new docksite.</short>
 
6337
        <descr>
 
6338
          <p>Calls <link id="TControl.DoDock">DoDock</link> to prepare for the new position of the control,
 
6339
            when docked into an unmanaged or floating docksite.</p>
 
6340
          <p>When the old and new docksites are different,
 
6341
            the control is removed from the DockClients of the old docksite, and added to the DockClients of the new docksite;
 
6342
            afterwards the docksites are notified by calling their DoAddDockClient and DoRemoveDockClient methods, to adjust the control's Parent.</p>
 
6343
        </descr>
 
6344
        <errors>An exception is raised if there is already a docking process in progress for this control</errors>
 
6345
      </element>
 
6346
      <element name="TControl.Dock.NewDockSite">
 
6347
        <short>The host site into which which the control is to be docked, Nil for floating.</short>
 
6348
      </element>
 
6349
      <element name="TControl.Dock.ARect">
 
6350
        <short>The control's new Bounds, in screen coordinates when NewDockSite is Nil, else in client coordinates of NewDockSite.
 
6351
        </short>
 
6352
      </element>
 
6353
      <!-- function Visibility: public -->
 
6354
      <element name="TControl.ManualDock">
 
6355
        <short>Docks a control programmatically.</short>
 
6356
        <descr>
 
6357
          <p>Docks this control into NewDockSite, relative to DropControl.
 
6358
            When NewDockSite is Nil, the control becomes floating.
 
6359
          </p>
 
6360
          <p>When the new docksite uses an DockManager, and DropControl is not Nil,
 
6361
            the control will be docked relative to DropControl,
 
6362
            as specified by ControlSide.
 
6363
          </p>
 
6364
          <p>The interpretation of ControlSide depends on the DockManager of NewDockSite,
 
6365
            or on the OnDockDrop handler in an unmanaged  docksite.
 
6366
          </p>
 
6367
          <p>A tree docking manager (TDockTree) should interpret alCustom as NoteBook docking,
 
6368
            i.e. a tabbed notebook is created in place of DropControl,
 
6369
            and both DropControl and this control are docked into pages of this notebook.
 
6370
          </p>
 
6371
        </descr>
 
6372
      </element>
 
6373
      <element name="TControl.ManualDock.Result">
 
6374
        <short>True if successfully docked.</short>
 
6375
      </element>
 
6376
      <element name="TControl.ManualDock.NewDockSite">
 
6377
        <short>The site into which the control is docked; Nil to make it float.</short>
 
6378
      </element>
 
6379
      <element name="TControl.ManualDock.DropControl">
 
6380
        <short>The sibling relative to which the control is inserted; can be Nil.
 
6381
        </short>
 
6382
      </element>
 
6383
      <element name="TControl.ManualDock.ControlSide">
 
6384
        <short>The side of DropControl on which the control is to be docked.
 
6385
        </short>
 
6386
      </element>
 
6387
      <element name="TControl.ManualDock.KeepDockSiteSize">
 
6388
        <short/>
 
6389
      <notes><note>?</note>
 
6390
        </notes>
 
6391
      </element>
 
6392
      <!-- function Visibility: public -->
 
6393
      <element name="TControl.ManualFloat">
 
6394
        <short>Undocks the control into floating state.</short>
 
6395
        <descr>TWinControls float for themselves,
 
6396
          for TControls a floating host dock site is created, and the control is docked into it.
 
6397
        </descr>
 
6398
      </element>
 
6399
      <element name="TControl.ManualFloat.Result">
 
6400
        <short>True if succesfully floated.</short>
 
6401
      </element>
 
6402
      <element name="TControl.ManualFloat.TheScreenRect">
 
6403
        <short>The screen area where the floating control is moved; the client area of a float host site.</short>
 
6404
      </element>
 
6405
      <element name="TControl.ManualFloat.KeepDockSiteSize">
 
6406
        <short/>
 
6407
      <notes><note>?</note>
 
6408
        </notes>
 
6409
      </element>
 
6410
      <!-- function Visibility: public -->
 
6411
      <element name="TControl.ReplaceDockedControl">
 
6412
        <short>Replaces a previously docked control.</short>
 
6413
        <descr>
 
6414
          <p>This method exists for use by an DockManager, for NoteBook docking.
 
6415
            It should not be used in application code.
 
6416
          </p>
 
6417
          <p>Delphi has introduced another method DockReplaceDockClient,
 
6418
            which is used when the replaced Control is in an unmanaged docksite.
 
6419
          </p>
 
6420
        </descr>
 
6421
        <seealso>
 
6422
          <link id="TControl.ManualDock"/>
 
6423
        </seealso>
 
6424
      </element>
 
6425
      <element name="TControl.ReplaceDockedControl.Result">
 
6426
        <short>True if the docked control has been successfully replaced.</short>
 
6427
      </element>
 
6428
      <element name="TControl.ReplaceDockedControl.Control">
 
6429
        <short>The control to be replaced, will be docked into NewDockSite.</short>
 
6430
      </element>
 
6431
      <element name="TControl.ReplaceDockedControl.NewDockSite">
 
6432
        <short>The new dock site for Control, typically a docking Notebook.
 
6433
        </short>
 
6434
      </element>
 
6435
      <element name="TControl.ReplaceDockedControl.DropControl">
 
6436
        <short>The control to which Control is docked.</short>
 
6437
      </element>
 
6438
      <element name="TControl.ReplaceDockedControl.ControlSide">
 
6439
        <short>The side of DropControl, to which Control is docked.</short>
 
6440
      </element>
 
6441
      <!-- function Visibility: public -->
 
6442
      <element name="TControl.Dragging">
 
6443
        <short>Returns True if the control is being dragged</short>
 
6444
      </element>
 
6445
      <element name="TControl.Dragging.Result">
 
6446
        <short>Returns True if the control is being dragged</short>
 
6447
      </element>
 
6448
      <!-- function Visibility: public -->
 
6449
      <element name="TControl.GetAccessibleObject">
 
6450
        <short>Returns True if the control is being dragged</short>
 
6451
      </element>
 
6452
      <!-- function Visibility: public -->
 
6453
      <element name="TControl.CreateAccessibleObject">
 
6454
        <short>Creates the TLazAccessibleObject for this control. This method should just create the object and return it. It is useful for classes which desire to have a descendent of TLazAccessibleObject instead of the base class.</short>
 
6455
        <seealso>
 
6456
          <link id="TLazAccessibleObject"/>
 
6457
          <link id="TControl.GetAccessibleObject"/>
 
6458
        </seealso>
 
6459
      </element>
 
6460
      <!-- function Visibility: public -->
 
6461
      <element name="TControl.GetSelectedChildAccessibleObject">
 
6462
        <short>Returns the currently selected child accessible object. This method is provided for controls which wish to override this behavior without sub-classing TLazAccessibleObject.</short>
 
6463
        <seealso>
 
6464
          <link id="TLazAccessibleObject"/>
 
6465
          <link id="TLazAccessibleObject.GetSelectedChildAccessibleObject"/>
 
6466
          <link id="TControl.CreateAccessibleObject"/>
 
6467
          <link id="TControl.GetAccessibleObject"/>
 
6468
        </seealso>
 
6469
      </element>
 
6470
      <!-- function Visibility: public -->
 
6471
      <element name="TControl.GetChildAccessibleObjectAtPos">
 
6472
        <short>Returns the child object in a given position of the control given in client coordinates. This method is provided for controls which wish to override this behavior without sub-classing TLazAccessibleObject.</short>
 
6473
        <seealso>
 
6474
          <link id="TLazAccessibleObject"/>
 
6475
          <link id="TLazAccessibleObject.GetChildAccessibleObjectAtPos"/>
 
6476
          <link id="TControl.CreateAccessibleObject"/>
 
6477
          <link id="TControl.GetAccessibleObject"/>
 
6478
        </seealso>
 
6479
      </element>
 
6480
      <!-- procedure Visibility: public -->
 
6481
      <element name="TControl.AdjustSize">
 
6482
        <short>Smart way to <var>DoAutoSize</var>.
 
6483
        </short>
 
6484
        <descr>
 
6485
          <p>This method does the same as Delphi <var>TWinControl.DoAutoSize</var>.
 
6486
            But since <var>DoAutoSize</var> is commonly overriden by descendant components, it is not useful to perform all tests, which can result in too much overhead.
 
6487
            To reduce this the LCL calls <var>AdjustSize</var> instead.
 
6488
          </p>
 
6489
          <p>During loading and handle creation the calls are delayed.</p>
 
6490
        </descr>
 
6491
        <seealso>
 
6492
          <link id="#lcl.Controls.AutoSize"/>
 
6493
        </seealso>
 
6494
      <notes><note>?</note>
 
6495
        </notes>
 
6496
      </element>
 
6497
      <!-- function Visibility: public -->
 
6498
      <element name="TControl.AutoSizePhases">
 
6499
        <short/>
 
6500
        <descr/>
 
6501
        <errors/>
 
6502
        <seealso/>
 
6503
      <notes><note>?</note>
 
6504
        </notes>
 
6505
      </element>
 
6506
      <element name="TControl.AutoSizePhases.Result">
 
6507
        <short/>
 
6508
      </element>
 
6509
      <!-- function Visibility: public -->
 
6510
      <element name="TControl.AutoSizeDelayed">
 
6511
        <short>Returns true if auto-sizing must be has been delayed, until some other process is complete.</short>
 
6512
      </element>
 
6513
      <element name="TControl.AutoSizeDelayed.Result">
 
6514
        <short>True if auto-sizing has been delayed.</short>
 
6515
      </element>
 
6516
      <!-- function Visibility: public -->
 
6517
      <element name="TControl.AutoSizeCheckParent">
 
6518
        <short/>
 
6519
        <descr/>
 
6520
        <errors/>
 
6521
        <seealso/>
 
6522
      <notes><note>?</note>
 
6523
        </notes>
 
6524
      </element>
 
6525
      <element name="TControl.AutoSizeCheckParent.Result">
 
6526
        <short/>
 
6527
      </element>
 
6528
      <!-- procedure Visibility: public -->
 
6529
      <element name="TControl.AnchorToNeighbour">
 
6530
        <short>Anchor to Sibling at Side.
 
6531
        </short>
 
6532
        <descr>
 
6533
          <p>Setup AnchorSide to anchor a side to the side of a neighbour sibling.
 
6534
            For example Right side to Left side, or Top side to Bottom.</p>
 
6535
        </descr>
 
6536
      </element>
 
6537
      <element name="TControl.AnchorToNeighbour.Side">
 
6538
        <short>The side to be anchored to Sibling.</short>
 
6539
      </element>
 
6540
      <element name="TControl.AnchorToNeighbour.Space">
 
6541
        <short>The minimum space to Sibling.</short>
 
6542
      </element>
 
6543
      <element name="TControl.AnchorToNeighbour.Sibling">
 
6544
        <short>The sibling control to which we should anchor.</short>
 
6545
      </element>
 
6546
      <!-- procedure Visibility: public -->
 
6547
      <element name="TControl.AnchorParallel">
 
6548
        <short>Anchor parallel to Sibling, at Side.
 
6549
        </short>
 
6550
        <descr/>
 
6551
      <notes><note>?</note>
 
6552
        </notes>
 
6553
      </element>
 
6554
      <element name="TControl.AnchorParallel.Side">
 
6555
        <short>The side to anchor to the sibling.</short>
 
6556
      </element>
 
6557
      <element name="TControl.AnchorParallel.Space">
 
6558
        <short>The minimum space to Sibling.</short>
 
6559
      </element>
 
6560
      <element name="TControl.AnchorParallel.Sibling">
 
6561
        <short>The sibling control to which we should anchor.</short>
 
6562
      </element>
 
6563
      <!-- procedure Visibility: public -->
 
6564
      <element name="TControl.AnchorHorizontalCenterTo">
 
6565
        <short>Setup AnchorSide to center the control horizontally relative to a sibling.
 
6566
        </short>
 
6567
      </element>
 
6568
      <element name="TControl.AnchorHorizontalCenterTo.Sibling">
 
6569
        <short>The sibling control to which we should anchor.</short>
 
6570
      </element>
 
6571
      <!-- procedure Visibility: public -->
 
6572
      <element name="TControl.AnchorVerticalCenterTo">
 
6573
        <short>Setup AnchorSide to center the control vertically relative to Sibling.
 
6574
        </short>
 
6575
      </element>
 
6576
      <element name="TControl.AnchorVerticalCenterTo.Sibling">
 
6577
        <short>The sibling control to which we should anchor.</short>
 
6578
      </element>
 
6579
      <!-- procedure Visibility: public -->
 
6580
      <element name="TControl.AnchorToCompanion">
 
6581
        <short>Anchor to Sibling at Side, with the same extent.
 
6582
        </short>
 
6583
        <descr>Table or tree style anchoring, into a neighbour cell of Sibling.
 
6584
          Obtain the row height (or column width) from Sibling.
 
6585
        </descr>
 
6586
      <notes><note>?</note>
 
6587
        </notes>
 
6588
      </element>
 
6589
      <element name="TControl.AnchorToCompanion.Side">
 
6590
        <short>The side to anchor to the sibling.</short>
 
6591
      </element>
 
6592
      <element name="TControl.AnchorToCompanion.Space">
 
6593
        <short>The minimum space to Sibling.</short>
 
6594
      </element>
 
6595
      <element name="TControl.AnchorToCompanion.Sibling">
 
6596
        <short>The sibling control to which we should anchor.</short>
 
6597
      </element>
 
6598
      <element name="TControl.AnchorToCompanion.FreeCompositeSide">
 
6599
        <short/>
 
6600
      <notes><note>?</note>
 
6601
        </notes>
 
6602
      </element>
 
6603
      <!-- procedure Visibility: public -->
 
6604
      <element name="TControl.AnchorSame">
 
6605
        <short>Copy Sibling's anchoring for Side.</short>
 
6606
        <descr/>
 
6607
        <errors/>
 
6608
        <seealso/>
 
6609
      </element>
 
6610
      <element name="TControl.AnchorSame.Side">
 
6611
        <short>The side to anchor like the sibling does.</short>
 
6612
      </element>
 
6613
      <element name="TControl.AnchorSame.Sibling">
 
6614
        <short>The sibling control from which to inherit anchoring.</short>
 
6615
      </element>
 
6616
      <!-- procedure Visibility: public -->
 
6617
      <element name="TControl.AnchorAsAlign">
 
6618
        <short>Anchor to Parent, following same rules as for Align.</short>
 
6619
        <descr/>
 
6620
        <errors/>
 
6621
        <seealso/>
 
6622
      </element>
 
6623
      <element name="TControl.AnchorAsAlign.TheAlign">
 
6624
        <short/>
 
6625
      </element>
 
6626
      <element name="TControl.AnchorAsAlign.Space">
 
6627
        <short/>
 
6628
      </element>
 
6629
      <!-- procedure Visibility: public -->
 
6630
      <element name="TControl.AnchorClient">
 
6631
        <short>Anchor to Parent's full client area.</short>
 
6632
        <descr/>
 
6633
        <errors/>
 
6634
        <seealso/>
 
6635
      </element>
 
6636
      <element name="TControl.AnchorClient.Space">
 
6637
        <short>The around space.</short>
 
6638
      </element>
 
6639
      <!-- function Visibility: public -->
 
6640
      <element name="TControl.AnchoredControlCount">
 
6641
        <short>The number of controls anchored to this one.</short>
 
6642
      </element>
 
6643
      <element name="TControl.AnchoredControlCount.Result">
 
6644
        <short/>
 
6645
      </element>
 
6646
      <!-- procedure Visibility: public -->
 
6647
      <element name="TControl.SetBounds">
 
6648
        <short>Sets the bounds (left, top, height, width) of the control.</short>
 
6649
        <descr>
 
6650
          <p>SetBounds can be used to change the left, top, width, height all at once, reducing some overhead.
 
6651
          </p>
 
6652
          <p>Use DisableAutoSize/EnableAutoSize to reduce recomputing/moving/resizing further.
 
6653
          </p>
 
6654
          <p>SetBounds is called when the properties Left, Top, Width, Height, or BoundsRect is set.
 
6655
          </p>
 
6656
          <p>SetBounds updates the BaseBounds and BaseParentClientSize, which are used by anchoring to keep the distance.
 
6657
            For example loading a Form with TMemo and the lfm contains TMemo's Left and Width, then SetBounds is called two times for the memo.
 
6658
          </p>
 
6659
          <p>When the user maximizes a window, SetBounds is called for the form, but not for the Memo, keeping the BaseBounds of the Memo.
 
6660
            If the Memo is anchored to the right, the Width of the Memo is changed based on the BaseBounds and BaseParentClientSize.
 
6661
          </p>
 
6662
          <p>Keep in mind that the given aLeft, aTop, aWidth, aHeight might not be valid and will be changed by the LCL before applied.
 
6663
          </p>
 
6664
          <p>Delphi calls SetBounds more often. SetBounds calls ChangeBounds with KeepBase=false.
 
6665
          </p>
 
6666
        </descr>
 
6667
      </element>
 
6668
      <element name="TControl.SetBounds.aLeft">
 
6669
        <short>The X coordinate of the left side of the control.</short>
 
6670
      </element>
 
6671
      <element name="TControl.SetBounds.aTop">
 
6672
        <short>The Y coordinate of the top of the control</short>
 
6673
      </element>
 
6674
      <element name="TControl.SetBounds.aWidth">
 
6675
        <short>The width of the control.</short>
 
6676
      </element>
 
6677
      <element name="TControl.SetBounds.aHeight">
 
6678
        <short>The height of the control.</short>
 
6679
      </element>
 
6680
      <!-- procedure Visibility: public -->
 
6681
      <element name="TControl.SetInitialBounds">
 
6682
        <short>Sets the bounds of the control initially, when it is created.</short>
 
6683
        <descr>Does nothing while the control is loaded.
 
6684
        </descr>
 
6685
        <seealso>
 
6686
          <link id="#lcl.Controls.TControl.SetBounds">SetBounds</link>
 
6687
        </seealso>
 
6688
      </element>
 
6689
      <element name="TControl.SetInitialBounds.aLeft">
 
6690
        <short>X coordinate of top left pixel</short>
 
6691
      </element>
 
6692
      <element name="TControl.SetInitialBounds.aTop">
 
6693
        <short>Y coordinate of top left pixel</short>
 
6694
      </element>
 
6695
      <element name="TControl.SetInitialBounds.aWidth">
 
6696
        <short>Width of control</short>
 
6697
      </element>
 
6698
      <element name="TControl.SetInitialBounds.aHeight">
 
6699
        <short>Height of control</short>
 
6700
      </element>
 
6701
      <!-- procedure Visibility: public -->
 
6702
      <element name="TControl.SetBoundsKeepBase">
 
6703
        <short>Set the bounds, keeping the base values</short>
 
6704
      <notes><note>?</note>
 
6705
        </notes>
 
6706
      </element>
 
6707
      <element name="TControl.SetBoundsKeepBase.aLeft">
 
6708
        <short/>
 
6709
      </element>
 
6710
      <element name="TControl.SetBoundsKeepBase.aTop">
 
6711
        <short/>
 
6712
      </element>
 
6713
      <element name="TControl.SetBoundsKeepBase.aWidth">
 
6714
        <short/>
 
6715
      </element>
 
6716
      <element name="TControl.SetBoundsKeepBase.aHeight">
 
6717
        <short/>
 
6718
      </element>
 
6719
      <element name="TControl.SetBoundsKeepBase.Lock">
 
6720
        <short/>
 
6721
      </element>
 
6722
      <!-- procedure Visibility: public -->
 
6723
      <element name="TControl.GetPreferredSize">
 
6724
        <short>Returns default/preferred height and width, for use in autosizing.</short>
 
6725
        <descr>
 
6726
          <p>Called during AutoSize calculations. Only positive values are valid. Negative or 0 are treated as undefined and the LCL uses other sizes instead.</p>
 
6727
          <p>WithThemeSpace: If true, adds space for stacking.</p>
 
6728
          <p>For example: <var>TRadioButton</var> has a minimum size. But for stacking multiple TRadioButtons there should be
 
6729
            some space around. This space is theme dependent, so the parameter is passed to the widgetset</p>
 
6730
          <p>
 
6731
            <var>TWinControl</var> overrides this and asks the interface for theme dependent values. See
 
6732
            
 
6733
            
 
6734
            <link id="TWinControl.CalculatePreferredSize"/> for more information.</p>
 
6735
        </descr>
 
6736
      <notes><note>link?</note>
 
6737
        </notes>
 
6738
      </element>
 
6739
      <element name="TControl.GetPreferredSize.PreferredWidth">
 
6740
        <short/>
 
6741
      </element>
 
6742
      <element name="TControl.GetPreferredSize.PreferredHeight">
 
6743
        <short/>
 
6744
      </element>
 
6745
      <element name="TControl.GetPreferredSize.Raw">
 
6746
        <short>If False then the values will be adjusted by the constraints,
 
6747
          and undefined values will be replaced by GetDefaultWidth/GetDefaultHeight.
 
6748
        </short>
 
6749
      </element>
 
6750
      <element name="TControl.GetPreferredSize.WithThemeSpace">
 
6751
        <short>If true, adds space for stacking.</short>
 
6752
      </element>
 
6753
      <!-- function Visibility: public -->
 
6754
      <element name="TControl.GetDefaultWidth">
 
6755
        <short>The default width for this control,
 
6756
          independent of any calculated values like Width and GetPreferredSize.
 
6757
        </short>
 
6758
      </element>
 
6759
      <element name="TControl.GetDefaultWidth.Result">
 
6760
        <short/>
 
6761
      </element>
 
6762
      <!-- function Visibility: public -->
 
6763
      <element name="TControl.GetDefaultHeight">
 
6764
        <short>The default height for this control,
 
6765
          independent of any calculated values like Height and GetPreferredSize.
 
6766
        </short>
 
6767
      </element>
 
6768
      <element name="TControl.GetDefaultHeight.Result">
 
6769
        <short/>
 
6770
      </element>
 
6771
      <!-- function Visibility: public -->
 
6772
      <element name="TControl.GetDefaultColor">
 
6773
        <short>Get the default color for this widget, from Parent or color type.</short>
 
6774
        <descr/>
 
6775
        <errors/>
 
6776
        <seealso>
 
6777
          <link id="TControl.Color"/>
 
6778
          <link id="TControl.ParentColor"/>
 
6779
          <link id="TControl.GetColorResolvingParent"/>
 
6780
          <link id="TControl.GetRGBColorResolvingParent"/>
 
6781
        </seealso>
 
6782
      </element>
 
6783
      <element name="TControl.GetDefaultColor.Result">
 
6784
        <short/>
 
6785
      </element>
 
6786
      <element name="TControl.GetDefaultColor.DefaultColorType">
 
6787
        <short>The color type to use, as the last resort.</short>
 
6788
      </element>
 
6789
      <!-- function Visibility: public -->
 
6790
      <element name="TControl.GetColorResolvingParent">
 
6791
        <short>Returns the color of the control while resolving clDefault and ParentColor</short>
 
6792
        <descr>This convenience routine will allow to obtain the Color of the control while resolving clDefault.
 
6793
          It will never return clDefault, but it might return non-RGB color. To obtain a purely RGB result
 
6794
          use GetRGBColorResolvingParent.</descr>
 
6795
        <seealso>
 
6796
          <link id="TControl.Color"/>
 
6797
          <link id="TControl.GetDefaultColor"/>
 
6798
          <link id="TControl.ParentColor"/>
 
6799
          <link id="TControl.GetRGBColorResolvingParent"/>
 
6800
        </seealso>
 
6801
      </element>
 
6802
      <!-- function Visibility: public -->
 
6803
      <element name="TControl.GetRGBColorResolvingParent">
 
6804
        <short>Returns a RGB value for the color of the control</short>
 
6805
        <descr>This convenience routine will allow to obtain the Color of the control while resolving clDefault,
 
6806
          ParentColor and system color indexes and returns a RGB TColor.</descr>
 
6807
        <seealso>
 
6808
          <link id="TControl.Color"/>
 
6809
          <link id="TControl.GetDefaultColor"/>
 
6810
          <link id="TControl.ParentColor"/>
 
6811
          <link id="TControl.GetColorResolvingParent"/>
 
6812
        </seealso>
 
6813
      </element>
 
6814
      <!-- function Visibility: public -->
 
6815
      <element name="TControl.GetSidePosition">
 
6816
        <short>The client coordinate of the given side.</short>
 
6817
      </element>
 
6818
      <element name="TControl.GetSidePosition.Result">
 
6819
        <short/>
 
6820
      </element>
 
6821
      <element name="TControl.GetSidePosition.Side">
 
6822
        <short/>
 
6823
      </element>
 
6824
      <!-- procedure Visibility: public -->
 
6825
      <element name="TControl.CNPreferredSizeChanged">
 
6826
        <short>Message handler for preferred size changed.</short>
 
6827
      </element>
 
6828
      <!-- procedure Visibility: public -->
 
6829
      <element name="TControl.InvalidatePreferredSize">
 
6830
        <short>Mark the preferred size no longer valid, for this control and all parents (implies that we will look for another).</short>
 
6831
      </element>
 
6832
      <!-- function Visibility: public -->
 
6833
      <element name="TControl.GetAnchorsDependingOnParent">
 
6834
        <short>Returns the sides which are anchored to the Parent.</short>
 
6835
      </element>
 
6836
      <element name="TControl.GetAnchorsDependingOnParent.Result">
 
6837
        <short/>
 
6838
      </element>
 
6839
      <element name="TControl.GetAnchorsDependingOnParent.WithNormalAnchors">
 
6840
        <short/>
 
6841
      <notes><note>?</note>
 
6842
        </notes>
 
6843
      </element>
 
6844
      <!-- procedure Visibility: public -->
 
6845
      <element name="TControl.DisableAutoSizing">
 
6846
        <short>Turn off automatic sizing - implies that default is accepted or sizing is done manually</short>
 
6847
      </element>
 
6848
      <!-- procedure Visibility: public -->
 
6849
      <element name="TControl.EnableAutoSizing">
 
6850
        <short>Turns on (enables) automatic sizing</short>
 
6851
        <descr/>
 
6852
        <errors/>
 
6853
        <seealso/>
 
6854
      </element>
 
6855
      <!-- procedure Visibility: protected -->
 
6856
      <element name="TControl.UpdateBaseBounds">
 
6857
        <short>Update the basic boundaries of the control - essential if there has been a lot of re-sizing.</short>
 
6858
      </element>
 
6859
      <element name="TControl.UpdateBaseBounds.StoreBounds">
 
6860
        <short/>
 
6861
      </element>
 
6862
      <element name="TControl.UpdateBaseBounds.StoreParentClientSize">
 
6863
        <short/>
 
6864
      </element>
 
6865
      <element name="TControl.UpdateBaseBounds.UseLoadedValues">
 
6866
        <short/>
 
6867
      <notes><note>?</note>
 
6868
        </notes>
 
6869
      </element>
 
6870
      <!-- procedure Visibility: public -->
 
6871
      <element name="TControl.WriteLayoutDebugReport">
 
6872
        <short>Used for debugging.</short>
 
6873
      </element>
 
6874
      <element name="TControl.WriteLayoutDebugReport.Prefix">
 
6875
        <short/>
 
6876
      </element>
 
6877
      <!-- constructor Visibility: public -->
 
6878
      <element name="TControl.Create"/>
 
6879
      <element name="TControl.Create.TheOwner">
 
6880
        <short>The owning component.</short>
 
6881
      </element>
 
6882
      <!-- destructor Visibility: public -->
 
6883
      <element name="TControl.Destroy">
 
6884
        <short>Removes the control from its Parent.</short>
 
6885
        <descr>
 
6886
          <p>Detaches the control from Parent, removes graphics, frees memory and Operating System handles, pointers etc.</p>
 
6887
        </descr>
 
6888
        <seealso>
 
6889
          <link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
 
6890
          <link id="#LCL.LCLClasses.TLCLComponent.Destroy">TLCLComponent.Destroy</link>
 
6891
        </seealso>
 
6892
      </element>
 
6893
      <!-- procedure Visibility: public -->
 
6894
      <element name="TControl.EditingDone">
 
6895
        <short>Invokes the <var>OnEditingDone</var> event handler.</short>
 
6896
        <descr>
 
6897
          <p>Called when user has finished editing. This procedure can be used by data links to commit the changes.</p>
 
6898
          <p>For example:</p>
 
6899
          <ul>
 
6900
            <li>When focus switches to another control (default).</li>
 
6901
            <li>When user selected another item.</li>
 
6902
          </ul>
 
6903
          <p>It's totally up to the control, what events will commit.</p>
 
6904
        </descr>
 
6905
      </element>
 
6906
      <!-- procedure Visibility: public -->
 
6907
      <element name="TControl.ExecuteDefaultAction">
 
6908
        <short>Called when the RETURN button is pressed, signifying default action.</short>
 
6909
        <descr/>
 
6910
        <errors/>
 
6911
        <seealso/>
 
6912
      </element>
 
6913
      <!-- procedure Visibility: public -->
 
6914
      <element name="TControl.ExecuteCancelAction">
 
6915
        <short>Called when ESCAPE is hit or the CANCEL button is clicked - signifying CANCEL.</short>
 
6916
        <descr/>
 
6917
        <errors/>
 
6918
        <seealso/>
 
6919
      </element>
 
6920
      <!-- procedure Visibility: public -->
 
6921
      <element name="TControl.BeginDrag">
 
6922
        <short>Starts dragging the control (programmatically).</short>
 
6923
        <descr/>
 
6924
        <errors/>
 
6925
        <seealso/>
 
6926
      </element>
 
6927
      <element name="TControl.BeginDrag.Immediate">
 
6928
        <short>If False, start dragging only after the mouse has moved.</short>
 
6929
      </element>
 
6930
      <element name="TControl.BeginDrag.Threshold">
 
6931
        <short>Minimum mouse movement before delayed dragging starts (in pixels); -1 means DragManager default; ignored if Immediate=True.</short>
 
6932
      </element>
 
6933
      <!-- procedure Visibility: public -->
 
6934
      <element name="TControl.BringToFront">
 
6935
        <short>Bring the control in front of all sibling controls.</short>
 
6936
      </element>
 
6937
      <!-- function Visibility: public -->
 
6938
      <element name="TControl.HasParent">
 
6939
        <short>Returns True if there is a parent component responsible for streaming</short>
 
6940
        <descr>
 
6941
          <p>This function will be called during streaming to decide if a component has to be streamed by its owner or parent</p>
 
6942
        </descr>
 
6943
        <seealso>
 
6944
          <link id="#rtl.Classes.TComponent.HasParent">TComponent.HasParent</link>
 
6945
        </seealso>
 
6946
      </element>
 
6947
      <element name="TControl.HasParent.Result">
 
6948
        <short>True if there is a Parent.</short>
 
6949
      </element>
 
6950
      <!-- function Visibility: public -->
 
6951
      <element name="TControl.GetParentComponent">
 
6952
        <short>Returns Parent (implements TComponent.GetParentComponent).</short>
 
6953
      </element>
 
6954
      <element name="TControl.GetParentComponent.Result">
 
6955
        <short>The Parent property.</short>
 
6956
      </element>
 
6957
      <!-- function Visibility: public -->
 
6958
      <element name="TControl.IsParentOf">
 
6959
        <short>Determines whether this control is a parent of AControl.</short>
 
6960
        <descr>The recursive search in all Parents of AControl finds not only immediate parent/child controls.
 
6961
        </descr>
 
6962
      </element>
 
6963
      <element name="TControl.IsParentOf.Result">
 
6964
        <short>True if this control is a parent of AControl.</short>
 
6965
      </element>
 
6966
      <element name="TControl.IsParentOf.AControl">
 
6967
        <short>The control of which this control may be a parent.</short>
 
6968
      </element>
 
6969
      <!-- function Visibility: public -->
 
6970
      <element name="TControl.GetTopParent">
 
6971
        <short>Find which control is the top parent (which has no further parent itself).</short>
 
6972
        <descr/>
 
6973
        <errors/>
 
6974
        <seealso/>
 
6975
      </element>
 
6976
      <element name="TControl.GetTopParent.Result">
 
6977
        <short/>
 
6978
      </element>
 
6979
      <!-- function Visibility: public -->
 
6980
      <element name="TControl.IsVisible">
 
6981
        <short>Returns True if the control is visible, including all of its Parents.</short>
 
6982
        <seealso>
 
6983
          <link id="TControl.Visible"/>
 
6984
        </seealso>
 
6985
      </element>
 
6986
      <element name="TControl.IsVisible.Result">
 
6987
        <short>True only if all Parents also are visible.</short>
 
6988
      </element>
 
6989
      <!-- function Visibility: public -->
 
6990
      <element name="TControl.IsControlVisible">
 
6991
        <short>True if the control is Visible, or is in design mode.</short>
 
6992
        <descr>
 
6993
          <p>Does not check for invisible parents.</p>
 
6994
        </descr>
 
6995
        <errors/>
 
6996
        <seealso>
 
6997
          <link id="TControl.Visible"/>
 
6998
        </seealso>
 
6999
      </element>
 
7000
      <element name="TControl.IsControlVisible.Result">
 
7001
        <short/>
 
7002
      </element>
 
7003
      <!-- function Visibility: public -->
 
7004
      <element name="TControl.IsEnabled">
 
7005
        <short>Returns True if the control is Enabled, including all of its Parents.</short>
 
7006
      </element>
 
7007
      <element name="TControl.IsEnabled.Result">
 
7008
        <short>True only if all Parents also are enabled.</short>
 
7009
      </element>
 
7010
      <!-- function Visibility: public -->
 
7011
      <element link="TControl.ParentShowHint" name="TControl.IsParentShowHint">
 
7012
        <short>Public read access to the protected ParentShowHint property.</short>
 
7013
      </element>
 
7014
      <element name="TControl.IsParentShowHint.Result">
 
7015
        <short/>
 
7016
      </element>
 
7017
      <!-- function Visibility: public -->
 
7018
      <element name="TControl.FormIsUpdating">
 
7019
        <short>True if the form is being updated</short>
 
7020
        <descr/>
 
7021
        <errors/>
 
7022
        <seealso/>
 
7023
      </element>
 
7024
      <element name="TControl.FormIsUpdating.Result">
 
7025
        <short/>
 
7026
      </element>
 
7027
      <!-- function Visibility: public -->
 
7028
      <element name="TControl.IsProcessingPaintMsg">
 
7029
        <short>True while painting the control.</short>
 
7030
        <descr>As the name says,
 
7031
          the cfProcessingWMPaint flag in FControlFlags is set while a LM_PAINT message is processed,
 
7032
          and IsProcessingPaintMsg checks this flag.
 
7033
        </descr>
 
7034
      </element>
 
7035
      <element name="TControl.IsProcessingPaintMsg.Result">
 
7036
        <short/>
 
7037
      </element>
 
7038
      <!-- procedure Visibility: public -->
 
7039
      <element name="TControl.Hide">
 
7040
        <short>Hides this control, by setting Visible to False.</short>
 
7041
        <seealso>
 
7042
          <link id="#lcl.Controls.TControl.Visible"/>
 
7043
          <link id="#lcl.Controls.TControl.Show"/>
 
7044
        </seealso>
 
7045
      </element>
 
7046
      <!-- procedure Visibility: public -->
 
7047
      <element link="TControl.Repaint" name="TControl.Refresh"/>
 
7048
      <!-- procedure Visibility: public -->
 
7049
      <element name="TControl.Repaint">
 
7050
        <short>Immediate redraw of the control, bypassing the message queue.</short>
 
7051
      </element>
 
7052
      <!-- procedure Visibility: public -->
 
7053
      <element name="TControl.Invalidate">
 
7054
        <short>Force a delayed Repaint of the control, by marking its visible area of the control as invalid.</short>
 
7055
      </element>
 
7056
      <!-- function Visibility: public -->
 
7057
      <element name="TControl.CheckChildClassAllowed">
 
7058
        <short>Returns True if the class is allowed for child controls.</short>
 
7059
        <descr>Only few controls restrict the class of acceptable child controls.
 
7060
          E.g. a PageControl only accepts TTabSheet descendants as children.
 
7061
        </descr>
 
7062
        <errors>An EInvalidOperation can be generated (see ExceptionOnInvalid).
 
7063
        </errors>
 
7064
      </element>
 
7065
      <element name="TControl.CheckChildClassAllowed.Result">
 
7066
        <short>True if the class is allowed for child controls.</short>
 
7067
      </element>
 
7068
      <element name="TControl.CheckChildClassAllowed.ChildClass">
 
7069
        <short>The class of the intended child control.</short>
 
7070
      </element>
 
7071
      <element name="TControl.CheckChildClassAllowed.ExceptionOnInvalid">
 
7072
        <short>When True, raise an exception when the class is not allowed.</short>
 
7073
      </element>
 
7074
      <!-- procedure Visibility: public -->
 
7075
      <element name="TControl.CheckNewParent">
 
7076
        <short>Checks if this control can become a child of AParent.</short>
 
7077
        <descr>This check is performed during SetParent.
 
7078
          It calls CheckChildClassAllowed and whether AParent=Self.
 
7079
        </descr>
 
7080
        <errors>An EInvalidOperation occurs when any test fails.
 
7081
        </errors>
 
7082
      </element>
 
7083
      <element name="TControl.CheckNewParent.AParent">
 
7084
        <short>The new Parent for this control.</short>
 
7085
      </element>
 
7086
      <!-- procedure Visibility: public -->
 
7087
      <element name="TControl.SendToBack">
 
7088
        <short>Moves all sibling controls in front of this control.
 
7089
        </short>
 
7090
        <descr>
 
7091
          <p>Use SendToBack to supply an specific background (image) for the Parent control.
 
7092
          </p>
 
7093
          <p>Only those portions of the control will be visible,
 
7094
            which are not covered by other controls.
 
7095
          </p>
 
7096
        </descr>
 
7097
      </element>
 
7098
      <!-- procedure Visibility: public -->
 
7099
      <element name="TControl.SetTempCursor">
 
7100
        <short>Change the cursor shape temporarily,
 
7101
          preserving the stored <link id="TControl.Cursor"/>.
 
7102
        </short>
 
7103
      </element>
 
7104
      <element name="TControl.SetTempCursor.Value">
 
7105
        <short>The temporary cursor shape to use.</short>
 
7106
      </element>
 
7107
      <!-- procedure Visibility: public -->
 
7108
      <element name="TControl.UpdateRolesForForm">
 
7109
        <short>Internal method, called by a Form when its DefaultControl or CancelControl has changed.
 
7110
        </short>
 
7111
        <descr>This method is overridden in TCustomButton,
 
7112
          where it updates the button's Cancel and Default properties.
 
7113
        </descr>
 
7114
        <seealso>
 
7115
          <link id="TControl.ActiveDefaultControlChanged"/>
 
7116
        </seealso>
 
7117
      </element>
 
7118
      <!-- procedure Visibility: public -->
 
7119
      <element name="TControl.ActiveDefaultControlChanged">
 
7120
        <short>Notification of a changed
 
7121
          active DefaultControl of a form.</short>
 
7122
        <descr>When the user pressed ENTER in a form, its DefaultControl will receive a Click event.
 
7123
        </descr>
 
7124
        <errors>Currently NewControl can be Nil, even if it should not be.
 
7125
        </errors>
 
7126
      </element>
 
7127
      <element name="TControl.ActiveDefaultControlChanged.NewControl">
 
7128
        <short>The new DefaultControl.</short>
 
7129
      </element>
 
7130
      <!-- function Visibility: public -->
 
7131
      <element name="TControl.GetTextBuf">
 
7132
        <short>Copy the <link id="TControl.Text">Text</link> property into Buffer.</short>
 
7133
        <descr>
 
7134
          <p>This method only exists for Delphi compatibility.
 
7135
          </p>
 
7136
          <p>Don't use or override it, unless really necessary.
 
7137
          </p>
 
7138
        </descr>
 
7139
        <seealso>
 
7140
          <link id="#lcl.Controls.TControl.RealGetText">RealGetText</link>
 
7141
        </seealso>
 
7142
      </element>
 
7143
      <element name="TControl.GetTextBuf.Result">
 
7144
        <short>Length of the copied text.</short>
 
7145
      </element>
 
7146
      <element name="TControl.GetTextBuf.Buffer">
 
7147
        <short>Pointer to the buffer receiving the string.</short>
 
7148
      </element>
 
7149
      <element name="TControl.GetTextBuf.BufSize">
 
7150
        <short>Length of the buffer.</short>
 
7151
      </element>
 
7152
      <!-- function Visibility: public -->
 
7153
      <element name="TControl.GetTextLen">
 
7154
        <short>The length of Text, here: of Caption.</short>
 
7155
        <descr/>
 
7156
        <errors/>
 
7157
        <seealso/>
 
7158
      </element>
 
7159
      <element name="TControl.GetTextLen.Result">
 
7160
        <short/>
 
7161
      </element>
 
7162
      <!-- procedure Visibility: public -->
 
7163
      <element name="TControl.SetTextBuf">
 
7164
        <short>Updates the <link id="TControl.Text">Text</link> property from a PChar buffer.</short>
 
7165
        <descr>
 
7166
          <p>This method only exists for Delphi compatibility.
 
7167
          </p>
 
7168
          <p>Don't use or override it, unless really necessary.
 
7169
          </p>
 
7170
        </descr>
 
7171
        <seealso>
 
7172
          <link id="#lcl.Controls.TControl.RealSetText">RealSetText</link>
 
7173
        </seealso>
 
7174
      </element>
 
7175
      <element name="TControl.SetTextBuf.Buffer">
 
7176
        <short>Pointer to the buffer containing the zero-terminated text.</short>
 
7177
      </element>
 
7178
      <!-- function Visibility: public -->
 
7179
      <element name="TControl.Perform">
 
7180
        <short>Direct call of an message handler, bypassing the message queue.</short>
 
7181
        <descr>The parameters and result depend on the concret message.
 
7182
        </descr>
 
7183
        <errors/>
 
7184
        <seealso/>
 
7185
      </element>
 
7186
      <element name="TControl.Perform.Result">
 
7187
        <short/>
 
7188
      </element>
 
7189
      <element name="TControl.Perform.Msg">
 
7190
        <short/>
 
7191
      </element>
 
7192
      <element name="TControl.Perform.WParam">
 
7193
        <short/>
 
7194
      </element>
 
7195
      <element name="TControl.Perform.LParam">
 
7196
        <short/>
 
7197
      </element>
 
7198
      <!-- function Visibility: public -->
 
7199
      <element name="TControl.ScreenToClient">
 
7200
        <short>Convert absolute screen coordinates into client-relative coordinates</short>
 
7201
        <seealso>
 
7202
          <link id="TControl.ClientToScreen"/>
 
7203
        </seealso>
 
7204
      </element>
 
7205
      <element name="TControl.ScreenToClient.Result">
 
7206
        <short/>
 
7207
      </element>
 
7208
      <element name="TControl.ScreenToClient.APoint">
 
7209
        <short/>
 
7210
      </element>
 
7211
      <!-- function Visibility: public -->
 
7212
      <element name="TControl.ClientToScreen">
 
7213
        <short>Convert client-relative coordinates into absolute screen coordinates.</short>
 
7214
        <seealso>
 
7215
          <link id="TControl.ScreenToClient"/>
 
7216
        </seealso>
 
7217
      </element>
 
7218
      <element name="TControl.ClientToScreen.Result">
 
7219
        <short/>
 
7220
      </element>
 
7221
      <element name="TControl.ClientToScreen.APoint">
 
7222
        <short/>
 
7223
      </element>
 
7224
      <!-- function Visibility: public -->
 
7225
      <element name="TControl.ScreenToControl">
 
7226
        <short>Convert absolute screen coordinates into control-relative coordinates.</short>
 
7227
        <seealso>
 
7228
          <link id="TControl.ControlToScreen"/>
 
7229
          <link id="TControl.ScreenToClient"/>
 
7230
          <link id="TControl.ClientToScreen"/>
 
7231
        </seealso>
 
7232
      </element>
 
7233
      <element name="TControl.ScreenToControl.Result">
 
7234
        <short/>
 
7235
      </element>
 
7236
      <element name="TControl.ScreenToControl.APoint">
 
7237
        <short/>
 
7238
      </element>
 
7239
      <!-- function Visibility: public -->
 
7240
      <element name="TControl.ControlToScreen">
 
7241
        <short>Convert control-relative coordinates into absolute screen coordinates.</short>
 
7242
        <seealso>
 
7243
          <link id="TControl.ScreenToControl"/>
 
7244
          <link id="TControl.ScreenToClient"/>
 
7245
          <link id="TControl.ClientToScreen"/>
 
7246
        </seealso>
 
7247
      </element>
 
7248
      <element name="TControl.ControlToScreen.Result">
 
7249
        <short/>
 
7250
      </element>
 
7251
      <element name="TControl.ControlToScreen.APoint">
 
7252
        <short/>
 
7253
      </element>
 
7254
      <!-- function Visibility: protected -->
 
7255
      <element name="TControl.GetChildsRect">
 
7256
        <short>Get the visible part of a possibly scrolled client area.</short>
 
7257
        <descr>If <var>Scrolled</var> is False, the ScrollOffset is ignored,
 
7258
          so that the ClientRect is returned.
 
7259
        </descr>
 
7260
      </element>
 
7261
      <element name="TControl.GetChildsRect.Result">
 
7262
        <short>The visible part of the client area.</short>
 
7263
      </element>
 
7264
      <element name="TControl.GetChildsRect.Scrolled">
 
7265
        <short>True forces scrolling taken into account.</short>
 
7266
      </element>
 
7267
      <!-- procedure Visibility: public -->
 
7268
      <element name="TControl.Show">
 
7269
        <short>Makes the control visible, by setting Visible to True.</short>
 
7270
        <descr/>
 
7271
        <errors/>
 
7272
        <seealso>
 
7273
          <link id="TControl.ShowControl"/>
 
7274
          <link id="TControl.Visible"/>
 
7275
          <link id="TControl.Hide"/>
 
7276
        </seealso>
 
7277
      </element>
 
7278
      <!-- procedure Visibility: public -->
 
7279
      <element name="TControl.Update">
 
7280
        <short>Redraw invalidated parts of the control immediately.</short>
 
7281
      </element>
 
7282
      <!-- function Visibility: public -->
 
7283
      <element name="TControl.HandleObjectShouldBeVisible">
 
7284
        <short>True if the control shall be visible, unless it's being destroyed.</short>
 
7285
        <descr/>
 
7286
        <errors/>
 
7287
        <seealso>
 
7288
          <link id="TControl.IsVisible"/>
 
7289
        </seealso>
 
7290
      </element>
 
7291
      <element name="TControl.HandleObjectShouldBeVisible.Result">
 
7292
        <short/>
 
7293
      </element>
 
7294
      <!-- function Visibility: public -->
 
7295
      <element name="TControl.ParentDestroyingHandle">
 
7296
        <short>Returns True if any parent is destroying its Handle (and its childrens').</short>
 
7297
        <descr/>
 
7298
        <errors/>
 
7299
        <seealso/>
 
7300
      </element>
 
7301
      <element name="TControl.ParentDestroyingHandle.Result">
 
7302
        <short/>
 
7303
      </element>
 
7304
      <!-- function Visibility: public -->
 
7305
      <element name="TControl.ParentHandlesAllocated">
 
7306
        <short>Returns True if all Parents have handles allocated, and are not being destroyed.</short>
 
7307
        <descr/>
 
7308
        <errors/>
 
7309
        <seealso/>
 
7310
      </element>
 
7311
      <element name="TControl.ParentHandlesAllocated.Result">
 
7312
        <short/>
 
7313
      </element>
 
7314
      <!-- procedure Visibility: public -->
 
7315
      <element name="TControl.InitiateAction">
 
7316
        <short>Update the action associated with this control.</short>
 
7317
        <descr/>
 
7318
        <errors/>
 
7319
        <seealso/>
 
7320
      <notes><note>?</note>
 
7321
        </notes>
 
7322
      </element>
 
7323
      <!-- procedure Visibility: public -->
 
7324
      <element name="TControl.ShowHelp">
 
7325
        <short>Show the Help associated with this control.</short>
 
7326
        <descr/>
 
7327
        <errors/>
 
7328
        <seealso/>
 
7329
      </element>
 
7330
      <!-- function Visibility: public -->
 
7331
      <element name="TControl.HasHelp">
 
7332
        <short>True when a HelpKeyword or HelpContext ID is assigned.</short>
 
7333
        <descr/>
 
7334
        <errors/>
 
7335
        <seealso/>
 
7336
      </element>
 
7337
      <element name="TControl.HasHelp.Result">
 
7338
        <short/>
 
7339
      </element>
 
7340
      <!-- procedure Visibility: public -->
 
7341
      <element link="#LCL.LCLClasses.TLCLComponent.RemoveAllHandlersOfObject" name="TControl.RemoveAllHandlersOfObject"/>
 
7342
      <element name="TControl.RemoveAllHandlersOfObject.AnObject">
 
7343
        <short/>
 
7344
      </element>
 
7345
      <!-- procedure Visibility: public -->
 
7346
      <element name="TControl.AddHandlerOnResize">
 
7347
        <short>Adds an handler for the <var>OnResize</var> event.</short>
 
7348
        <descr/>
 
7349
        <errors/>
 
7350
        <seealso/>
 
7351
      </element>
 
7352
      <element name="TControl.AddHandlerOnResize.OnResizeEvent">
 
7353
        <short/>
 
7354
      </element>
 
7355
      <element name="TControl.AddHandlerOnResize.AsFirst">
 
7356
        <short/>
 
7357
      </element>
 
7358
      <!-- procedure Visibility: public -->
 
7359
      <element name="TControl.RemoveHandlerOnResize">
 
7360
        <short>Removes an handler for the <var>OnResize</var> event.</short>
 
7361
        <descr/>
 
7362
        <errors/>
 
7363
        <seealso/>
 
7364
      </element>
 
7365
      <element name="TControl.RemoveHandlerOnResize.OnResizeEvent">
 
7366
        <short/>
 
7367
      </element>
 
7368
      <!-- procedure Visibility: public -->
 
7369
      <element name="TControl.AddHandlerOnChangeBounds">
 
7370
        <short>Adds an handler for the <var>OnChangeBounds</var> event.</short>
 
7371
        <descr/>
 
7372
        <errors/>
 
7373
        <seealso/>
 
7374
      </element>
 
7375
      <element name="TControl.AddHandlerOnChangeBounds.OnChangeBoundsEvent">
 
7376
        <short/>
 
7377
      </element>
 
7378
      <element name="TControl.AddHandlerOnChangeBounds.AsFirst">
 
7379
        <short/>
 
7380
      </element>
 
7381
      <!-- procedure Visibility: public -->
 
7382
      <element name="TControl.RemoveHandlerOnChangeBounds">
 
7383
        <short>Removes an handler for the <var>OnChangeBounds</var> event.</short>
 
7384
        <descr/>
 
7385
        <errors/>
 
7386
        <seealso/>
 
7387
      </element>
 
7388
      <element name="TControl.RemoveHandlerOnChangeBounds.OnChangeBoundsEvent">
 
7389
        <short/>
 
7390
      </element>
 
7391
      <!-- procedure Visibility: public -->
 
7392
      <element name="TControl.AddHandlerOnVisibleChanging">
 
7393
        <short>Adds an <var>OnVisibleChanging</var> handler.</short>
 
7394
        <descr/>
 
7395
        <errors/>
 
7396
        <seealso/>
 
7397
      </element>
 
7398
      <element name="TControl.AddHandlerOnVisibleChanging.OnVisibleChangingEvent">
 
7399
        <short/>
 
7400
      </element>
 
7401
      <element name="TControl.AddHandlerOnVisibleChanging.AsFirst">
 
7402
        <short/>
 
7403
      </element>
 
7404
      <!-- procedure Visibility: public -->
 
7405
      <element name="TControl.RemoveHandlerOnVisibleChanging">
 
7406
        <short>Removes an <var>OnVisibleChanging</var> handler.</short>
 
7407
        <descr/>
 
7408
        <errors/>
 
7409
        <seealso/>
 
7410
      </element>
 
7411
      <element name="TControl.RemoveHandlerOnVisibleChanging.OnVisibleChangingEvent">
 
7412
        <short/>
 
7413
      </element>
 
7414
      <!-- procedure Visibility: public -->
 
7415
      <element name="TControl.AddHandlerOnVisibleChanged">
 
7416
        <short>Adds an
 
7417
          <var>OnVisibleChanged</var> handler.</short>
 
7418
        <descr/>
 
7419
        <errors/>
 
7420
        <seealso/>
 
7421
      </element>
 
7422
      <element name="TControl.AddHandlerOnVisibleChanged.OnVisibleChangedEvent">
 
7423
        <short/>
 
7424
      </element>
 
7425
      <element name="TControl.AddHandlerOnVisibleChanged.AsFirst">
 
7426
        <short/>
 
7427
      </element>
 
7428
      <!-- procedure Visibility: public -->
 
7429
      <element name="TControl.RemoveHandlerOnVisibleChanged">
 
7430
        <short>Removes an <var>OnVisibleChanged</var> handler.</short>
 
7431
        <descr/>
 
7432
        <errors/>
 
7433
        <seealso/>
 
7434
      </element>
 
7435
      <element name="TControl.RemoveHandlerOnVisibleChanged.OnVisibleChangedEvent">
 
7436
        <short/>
 
7437
      </element>
 
7438
      <!-- procedure Visibility: public -->
 
7439
      <element name="TControl.AddHandlerOnEnabledChanged">
 
7440
        <short>Adds an
 
7441
          <var>OnEnabledChanged</var> handler.</short>
 
7442
        <descr/>
 
7443
        <errors/>
 
7444
        <seealso/>
 
7445
      </element>
 
7446
      <element name="TControl.AddHandlerOnEnabledChanged.OnEnabledChangedEvent">
 
7447
        <short/>
 
7448
      </element>
 
7449
      <element name="TControl.AddHandlerOnEnabledChanged.AsFirst">
 
7450
        <short/>
 
7451
      </element>
 
7452
      <!-- missing RemoveHandlerOnEnableChanging -->
 
7453
      <!-- procedure Visibility: public -->
 
7454
      <element name="TControl.RemoveHandlerOnEnableChanging">
 
7455
        <short>Removes an <var>OnEnabledChanged</var> handler.</short>
 
7456
        <descr/>
 
7457
        <errors/>
 
7458
        <seealso/>
 
7459
      <notes><note>The name doesn't look correct, should read RemoveHandlerOnEnabledChanged?</note>
 
7460
        </notes>
 
7461
      </element>
 
7462
      <element name="TControl.RemoveHandlerOnEnableChanging.OnEnableChangingEvent">
 
7463
        <short/>
 
7464
      </element>
 
7465
      <!-- procedure Visibility: public -->
 
7466
      <element name="TControl.AddHandlerOnKeyDown">
 
7467
        <short>Adds an handler for the <var>OnKeyDown</var> event.</short>
 
7468
        <descr/>
 
7469
        <errors/>
 
7470
        <seealso/>
 
7471
      </element>
 
7472
      <element name="TControl.AddHandlerOnKeyDown.OnKeyDownEvent">
 
7473
        <short/>
 
7474
      </element>
 
7475
      <element name="TControl.AddHandlerOnKeyDown.AsFirst">
 
7476
        <short/>
 
7477
      </element>
 
7478
      <!-- procedure Visibility: public -->
 
7479
      <element name="TControl.RemoveHandlerOnKeyDown">
 
7480
        <short>Removes an handler for the <var>OnKeyDown</var> event.</short>
 
7481
        <descr/>
 
7482
        <errors/>
 
7483
        <seealso/>
 
7484
      </element>
 
7485
      <element name="TControl.RemoveHandlerOnKeyDown.OnKeyDownEvent">
 
7486
        <short/>
 
7487
      </element>
 
7488
      <!-- function Visibility: public -->
 
7489
      <element name="TControl.UseRightToLeftAlignment">
 
7490
        <short>True when BiDiMode is bdRightToLeft.</short>
 
7491
        <descr/>
 
7492
        <errors/>
 
7493
        <seealso/>
 
7494
      </element>
 
7495
      <element name="TControl.UseRightToLeftAlignment.Result">
 
7496
        <short/>
 
7497
      </element>
 
7498
      <!-- function Visibility: public -->
 
7499
      <element name="TControl.UseRightToLeftReading">
 
7500
        <short>True when BiDiMode is not bdLeftToRight.</short>
 
7501
        <descr/>
 
7502
        <errors/>
 
7503
        <seealso/>
 
7504
      </element>
 
7505
      <element name="TControl.UseRightToLeftReading.Result">
 
7506
        <short/>
 
7507
      </element>
 
7508
      <!-- function Visibility: public -->
 
7509
      <element name="TControl.UseRightToLeftScrollBar">
 
7510
        <short>True when scrollbars appear at the left side of the control.</short>
 
7511
        <descr/>
 
7512
        <errors/>
 
7513
        <seealso/>
 
7514
      </element>
 
7515
      <element name="TControl.UseRightToLeftScrollBar.Result">
 
7516
        <short/>
 
7517
      </element>
 
7518
      <!-- function Visibility: public -->
 
7519
      <element name="TControl.IsRightToLeft">
 
7520
        <short>True when BiDiMode is not bdLeftToRight.</short>
 
7521
        <descr/>
 
7522
        <errors/>
 
7523
        <seealso/>
 
7524
      </element>
 
7525
      <element name="TControl.IsRightToLeft.Result">
 
7526
        <short/>
 
7527
      </element>
 
7528
      <!-- property Visibility: public -->
 
7529
      <element name="TControl.Action">
 
7530
        <short>The Action associated with this control.</short>
 
7531
        <descr>The Action property is a shortcut to ActionLink.Action.
 
7532
        </descr>
 
7533
        <seealso>
 
7534
          <link id="TControl.ActionLink"/>
 
7535
          <link id="#rtl.Classes.TBasicAction"/>
 
7536
        </seealso>
 
7537
      </element>
 
7538
      <!-- property Visibility: protected -->
 
7539
      <element name="TControl.AccessibleDescription">
 
7540
        <short>The accessible description of the control.This should describe the role of the control, for example for TLabel it could be "a text caption".</short>
 
7541
        <descr>The accessible description of the control. This should describe the role of the control, for example for TLabel it could be "a text caption". This property is connected and synchronized with TControl.GetAccessibleObject().AccessibleDescription.</descr>
 
7542
        <seealso>
 
7543
          <link id="TLazAccessibleObject.AccessibleDescription"/>
 
7544
        </seealso>
 
7545
      </element>
 
7546
      <!-- property Visibility: protected -->
 
7547
      <element name="TControl.AccessibleValue">
 
7548
        <short>The accessible value of the control. For example, for a TLabel it would be the same as the Caption property of the label.</short>
 
7549
        <descr>The accessible value of the control. For example, for a TLabel it would be the same as the Caption property of the label. This property is connected and synchronized with TControl.GetAccessibleObject().AccessibleValue.</descr>
 
7550
        <seealso>
 
7551
          <link id="TLazAccessibleObject.AccessibleValue"/>
 
7552
        </seealso>
 
7553
      </element>
 
7554
      <!-- property Visibility: protected -->
 
7555
      <element name="TControl.AccessibleRole">
 
7556
        <short>The accessible role of the control which classifies what kind of object this is. See TLazAccessibilityRole for a list of possible values</short>
 
7557
        <seealso>
 
7558
          <link id="TLazAccessibilityRole"/>
 
7559
          <link id="TLazAccessibleObject.AccessibleRole"/>
 
7560
        </seealso>
 
7561
      </element>
 
7562
      <!-- property Visibility: protected -->
 
7563
      <element name="TControl.ActionLink">
 
7564
        <short>Link to the default Action associated with this control.</short>
 
7565
      </element>
 
7566
      <!-- property Visibility: public -->
 
7567
      <element name="TControl.Align">
 
7568
        <short>Specifies the placement of the control inside its Parent.</short>
 
7569
        <descr>
 
7570
          <p>A control can stick to one side of its Parent control.
 
7571
          </p>
 
7572
        </descr>
 
7573
        <seealso>
 
7574
          <link id="#lcl.Controls.TAlign">TAlign</link>
 
7575
        </seealso>
 
7576
      </element>
 
7577
      <!-- property Visibility: public -->
 
7578
      <element name="TControl.AnchoredControls">
 
7579
        <short>The list of controls anchored to this one.</short>
 
7580
      </element>
 
7581
      <element name="TControl.AnchoredControls.Index">
 
7582
        <short/>
 
7583
      </element>
 
7584
      <!-- property Visibility: public -->
 
7585
      <element name="TControl.Anchors">
 
7586
        <short>The set of anchor definitions for this control.</short>
 
7587
        <descr>
 
7588
          <p>Determines which sides of the control are anchored to other controls.</p>
 
7589
        </descr>
 
7590
        <seealso>
 
7591
          <link id="#lcl.Controls.TAnchors"/>
 
7592
        </seealso>
 
7593
      </element>
 
7594
      <!-- property Visibility: public -->
 
7595
      <element name="TControl.AnchorSide">
 
7596
        <short>Array of anchor definitions, indexed by the control sides.</short>
 
7597
        <descr>
 
7598
          <p>Valid anchor definitions are flagged in <link id="TControl.Anchors">Anchors</link>.
 
7599
          </p>
 
7600
          <p>AnchorSide specifies how a side is anchored to other controls (siblings or Parent).
 
7601
          </p>
 
7602
          <p>Various AnchorAs and AnchorTo methods simplify the establishment of anchors.
 
7603
          </p>
 
7604
        </descr>
 
7605
        <seealso>
 
7606
          <link id="TAnchorSide"/>
 
7607
          <link id="TControl.AnchorAsAlign"/>
 
7608
          <link id="TControl.AnchorToNeighbour"/>
 
7609
        </seealso>
 
7610
      <notes><note>Anchors may be invalidated by cycle and other checks?</note>
 
7611
        </notes>
 
7612
      </element>
 
7613
      <element name="TControl.AnchorSide.Kind">
 
7614
        <short>The anchored side of the control.</short>
 
7615
      <notes><note>possibly?</note>
 
7616
        </notes>
 
7617
      </element>
 
7618
      <!-- property Visibility: public -->
 
7619
      <element link="TControl.AnchorSide" name="TControl.AnchorSideBottom"/>
 
7620
      <element link="TControl.AnchorSide" name="TControl.AnchorSideLeft"/>
 
7621
      <element link="TControl.AnchorSide" name="TControl.AnchorSideRight"/>
 
7622
      <element link="TControl.AnchorSide" name="TControl.AnchorSideTop"/>
 
7623
      <!-- property Visibility: protected -->
 
7624
      <element name="TControl.AutoSize">
 
7625
        <short>Allows to automatically adjust the size of the control, according to its content.</short>
 
7626
        <descr>
 
7627
          <p>The effect depends on the concrete control type.
 
7628
            For example a label or button can become bigger or smaller to accommodate a longer or shorter caption.
 
7629
          </p>
 
7630
          <p>Default is false, ie no auto-sizing
 
7631
          </p>
 
7632
        </descr>
 
7633
        <seealso>
 
7634
          <link id="#lcl.Controls.Autosize">Autosize topic</link>
 
7635
        </seealso>
 
7636
      </element>
 
7637
      <!-- property Visibility: protected -->
 
7638
      <element name="TControl.AutoSizing">
 
7639
        <short>True while autosizing is in progress.</short>
 
7640
      </element>
 
7641
      <!-- property Visibility: protected -->
 
7642
      <element name="TControl.AutoSizingAll">
 
7643
        <short>Flag to prevent recursive AutoSizing (in DoAllAutoSize).</short>
 
7644
        <descr>By default Parent.AutoSizingAll is read, because a mere TControl cannot have child controls.
 
7645
        </descr>
 
7646
        <seealso/>
 
7647
      </element>
 
7648
      <!-- property Visibility: protected -->
 
7649
      <element name="TControl.AutoSizingLockCount">
 
7650
        <short>Internal counter, in/decreased by DisableAutoSizing/EnableAutoSizing.</short>
 
7651
        <descr/>
 
7652
        <seealso/>
 
7653
      </element>
 
7654
      <!-- property Visibility: public -->
 
7655
      <element name="TControl.BaseBounds">
 
7656
        <short>The rectangle of the designed bounds.</short>
 
7657
        <descr>The current Bounds can change, due to scaling, anchoring or autosizing.
 
7658
        </descr>
 
7659
        <seealso>
 
7660
          <link id="TControl.Anchors"/>
 
7661
          <link id="TControl.AnchorSide"/>
 
7662
          <link id="TControl.AutoSize"/>
 
7663
          <link id="TControl.Scale"/>
 
7664
          <link id="TControl.SetBoundsKeepBase"/>
 
7665
        </seealso>
 
7666
      </element>
 
7667
      <!-- property Visibility: public -->
 
7668
      <element name="TControl.BaseParentClientSize">
 
7669
        <short>The Parent's client size, for which the BaseBounds are valid.</short>
 
7670
        <descr>
 
7671
          <p>BaseBounds and BaseParentClientSize determine the distance to keep from Parent's sides,
 
7672
            when a side is anchored to the Parent (akLeft...), and the Parent is resized.
 
7673
          </p>
 
7674
        </descr>
 
7675
        <seealso/>
 
7676
      </element>
 
7677
      <!-- property Visibility: protected -->
 
7678
      <element name="TControl.BiDiMode">
 
7679
        <short>Customization (of text controls) in bidirectional reading environments.
 
7680
        </short>
 
7681
        <descr>
 
7682
          <p>In "normal" reading mode (left-to-right, LTR) text entry starts at the left,
 
7683
            text is almost left justified,
 
7684
            and vertical scrollbars sit at the right side of the control.
 
7685
          </p>
 
7686
          <p>In right-to-left mode text entry starts at the right,
 
7687
            text is almost right justified,
 
7688
            and vertical scrollbars sit at the left side of the control.
 
7689
          </p>
 
7690
          <p>In a bidirectional environment these different placements and adjustments can be configured (swapped) in various (but not all) ways.
 
7691
          </p>
 
7692
          <p>(Allows RTL languages such as Arabic and Hebrew to be used)
 
7693
          </p>
 
7694
          <p>Wild guess: The default mode is established by the platform,
 
7695
            RTL reading is not supported on all (Windows) platforms.
 
7696
          </p>
 
7697
        </descr>
 
7698
        <seealso>
 
7699
          <link id="TControl.UseRightToLeftAlignment"/>
 
7700
          <link id="TControl.UseRightToLeftReading"/>
 
7701
          <link id="TControl.UseRightToLeftScrollBar"/>
 
7702
          <link id="TControl.IsRightToLeft"/>
 
7703
        </seealso>
 
7704
      </element>
 
7705
      <!-- property Visibility: public -->
 
7706
      <element name="TControl.BorderSpacing">
 
7707
        <short>Determines the inner and outer border spacing for this control.</short>
 
7708
        <descr>
 
7709
          <p>The outer border determines the minimal distance to sibling controls,
 
7710
            the inner border is the area between the control's BoundsRect and ClientRect.
 
7711
          </p>
 
7712
          <p>When a control sits in a cell of a table (Grid) control,
 
7713
            its horizontal and vertical alignment inside the cell can be specified, too.
 
7714
          </p>
 
7715
        </descr>
 
7716
      <notes><note>?</note><note>instead?</note>
 
7717
        </notes>
 
7718
      </element>
 
7719
      <!-- property Visibility: public -->
 
7720
      <element name="TControl.BoundsRect">
 
7721
        <short>The TopLeft and BottomRight of the control, in client coordinates.</short>
 
7722
        <descr>
 
7723
          <p>The BoundsRect rectangle describes the TopLeft and BottomRight coordinates of the control, relative to its parent.
 
7724
          </p>
 
7725
          <p>The values are based on the Top, Left, Width and Height properties of the control.
 
7726
          </p>
 
7727
          <p>Set BoundsRect to move and/or resize the control.
 
7728
            This can reduce flicker, occuring otherwise when Top, Width etc. are set individually.
 
7729
          </p>
 
7730
        </descr>
 
7731
      </element>
 
7732
      <!-- property Visibility: public -->
 
7733
      <element name="TControl.BoundsRectForNewParent">
 
7734
        <short>Temporary BoundsRect, used when the control e.g. is docked into a different Parent.</short>
 
7735
        <descr>
 
7736
          <p>The rectangle describes the placement of the control when its Parent is changed later.</p>
 
7737
          <p>Setting the rectangle also sets a flag, indicating that the values are available.</p>
 
7738
        </descr>
 
7739
      </element>
 
7740
      <!-- property Visibility: public -->
 
7741
      <element name="TControl.Caption">
 
7742
        <short>The text describing the control to the user.</short>
 
7743
        <descr>
 
7744
          <p>By default, the <var>Caption</var> is the same as the control's <var>Name</var> in the Object Inspector,
 
7745
            and the developer must set it explicitly to some different text.
 
7746
          </p>
 
7747
        </descr>
 
7748
        <seealso>
 
7749
          <link id="#lcl.Controls.TControl.RealGetText"/>
 
7750
          <link id="#lcl.Controls.TControl.RealSetText"/>
 
7751
        </seealso>
 
7752
      </element>
 
7753
      <!-- property Visibility: public -->
 
7754
      <element name="TControl.CaptureMouseButtons">
 
7755
        <short>Which mouse button(s) to be used for capture? Default is the left button.
 
7756
        </short>
 
7757
        <descr/>
 
7758
        <seealso/>
 
7759
      <notes><note>?</note>
 
7760
        </notes>
 
7761
      </element>
 
7762
      <!-- property Visibility: public -->
 
7763
      <element name="TControl.ClientHeight">
 
7764
        <short>The height of the client area of the control.</short>
 
7765
        <descr/>
 
7766
      </element>
 
7767
      <!-- property Visibility: public -->
 
7768
      <element name="TControl.ClientOrigin">
 
7769
        <short>Screen coordinates of the TopLeft pixel (of the client area) of the control.</short>
 
7770
        <descr>
 
7771
          <p>Only TWinControls have a client area, for other controls ClientOrigin is the same as Origin.</p>
 
7772
          <p>Note that this value is the position as stored in the object, not always in sync with the widget.</p>
 
7773
        </descr>
 
7774
      </element>
 
7775
      <!-- property Visibility: public -->
 
7776
      <element name="TControl.ClientRect">
 
7777
        <short>Size of the client area of the control.</short>
 
7778
        <descr>The origin is always (0,0). Bottom and Right reflect the ClientWidth and ClientHeight of the control.</descr>
 
7779
        <seealso>
 
7780
          <link id="#rtl.Classes.TRect"/>
 
7781
          <link id="TControl.GetLogicalClientRect"/>
 
7782
        </seealso>
 
7783
      </element>
 
7784
      <!-- property Visibility: public -->
 
7785
      <element name="TControl.ClientWidth">
 
7786
        <short>The width of the client area of the control.</short>
 
7787
        <descr/>
 
7788
      </element>
 
7789
      <!-- property Visibility: public -->
 
7790
      <element name="TControl.Color">
 
7791
        <short>The background color of the control.</short>
 
7792
        <descr>
 
7793
          <p>The default Color is the same as the parent window Color. If the color is clDefault
 
7794
            then the result will need to be passed through GetDefaultColor to resolve clDefault.
 
7795
            Convenience routines which obtains the color resolving clDefault and ParentColor are also
 
7796
            provided as TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent</p>
 
7797
        </descr>
 
7798
        <seealso>
 
7799
          <link id="TControl.ParentColor"/>
 
7800
          <link id="#lcl.Graphics.TColor"/>
 
7801
          <link id="TControl.GetDefaultColor"/>
 
7802
          <link id="TControl.GetColorResolvingParent"/>
 
7803
          <link id="TControl.GetRGBColorResolvingParent"/>
 
7804
        </seealso>
 
7805
      </element>
 
7806
      <!-- property Visibility: public -->
 
7807
      <element name="TControl.Constraints">
 
7808
        <short>The minimal and maximal Width and Height of this control.</short>
 
7809
        <descr/>
 
7810
        <seealso>
 
7811
          <link id="#lcl.Controls.TSizeConstraints"/>
 
7812
        </seealso>
 
7813
      </element>
 
7814
      <!-- property Visibility: public -->
 
7815
      <element name="TControl.ControlOrigin">
 
7816
        <short>The top left pixel of this control, in screen coordinates.</short>
 
7817
        <descr/>
 
7818
        <seealso>
 
7819
          <link id="TControl.ClientOrigin"/>
 
7820
          <link id="TControl.BoundsRect"/>
 
7821
        </seealso>
 
7822
      </element>
 
7823
      <!-- property Visibility: public -->
 
7824
      <element name="TControl.ControlState">
 
7825
        <short>State flags, telling whether the control has been clicked, data being read, control being re-drawn, etc.</short>
 
7826
        <descr/>
 
7827
        <seealso>
 
7828
          <link id="#lcl.Controls.TControlState"/>
 
7829
        </seealso>
 
7830
      </element>
 
7831
      <!-- property Visibility: public -->
 
7832
      <element name="TControl.ControlStyle">
 
7833
        <short>Style flags, specifying whether the control responds to mouse clicks, can be re-sized, has particular actions, etc.</short>
 
7834
        <descr/>
 
7835
        <seealso>
 
7836
          <link id="#lcl.Controls.TControlStyle"/>
 
7837
        </seealso>
 
7838
      </element>
 
7839
      <!-- property Visibility: published -->
 
7840
      <element name="TControl.Cursor">
 
7841
        <short>The shape of the mouse pointer, when the mouse is over this control.</short>
 
7842
        <descr/>
 
7843
        <seealso/>
 
7844
      </element>
 
7845
      <!-- property Visibility: protected -->
 
7846
      <element name="TControl.DesktopFont">
 
7847
        <short>Allows to use the desktop font for text display in this control.</short>
 
7848
        <descr/>
 
7849
        <seealso/>
 
7850
      <notes><note>?</note>
 
7851
        </notes>
 
7852
      </element>
 
7853
      <!-- property Visibility: public -->
 
7854
      <element name="TControl.DockOrientation">
 
7855
        <short>How the control is currently docked.
 
7856
           (horizontally, vertically, in a notebook, or not at all)</short>
 
7857
        <descr/>
 
7858
        <seealso/>
 
7859
      </element>
 
7860
      <!-- property Visibility: protected -->
 
7861
      <element name="TControl.DragCursor">
 
7862
        <short>The cursor shape shown while the control is dragged.</short>
 
7863
        <descr>Default is crDrag. When no drop is allowed, the cursor changes temporarily to crNoDrop.</descr>
 
7864
      </element>
 
7865
      <!-- property Visibility: protected -->
 
7866
      <element name="TControl.DragKind">
 
7867
        <short>The operation when the control is dragged - Drag or Dock.</short>
 
7868
        <descr>Set to dkDrag for drag-drop, or to dkDock for drag-dock operation.</descr>
 
7869
        <seealso/>
 
7870
      </element>
 
7871
      <!-- property Visibility: protected -->
 
7872
      <element name="TControl.DragMode">
 
7873
        <short>Allows the user to drag the control.</short>
 
7874
        <descr>
 
7875
          <p>Default is dmManual, meaning that dragging must be started in code.</p>
 
7876
          <p>Set to dmAutomatic to allow the user to drag this control.
 
7877
            In this mode dragging can start immediately (on left mouse button press)
 
7878
            or delayed, after the mouse has been moved away by a number of pixels (Threshold).</p>
 
7879
        </descr>
 
7880
        <seealso>
 
7881
          <link id="TControl.DragKind"/>
 
7882
          <link id="TDragManager.DragImmediate"/>
 
7883
        </seealso>
 
7884
      </element>
 
7885
      <!-- property Visibility: public -->
 
7886
      <element name="TControl.Enabled">
 
7887
        <short>Determines whether the control reacts on mouse or keyboard input.</short>
 
7888
        <descr>Disabled controls usually appear 'greyed-out'</descr>
 
7889
      </element>
 
7890
      <!-- property Visibility: public -->
 
7891
      <element name="TControl.Floating">
 
7892
        <short>Tries to find out whether the control is floating (not part of a form).</short>
 
7893
        <descr/>
 
7894
        <seealso>
 
7895
          <link id="TControl.FloatingDockSiteClass"/>
 
7896
        </seealso>
 
7897
      </element>
 
7898
      <!-- property Visibility: public -->
 
7899
      <element name="TControl.FloatingDockSiteClass">
 
7900
        <short>The class for a floating host dock site for this control.</short>
 
7901
        <descr/>
 
7902
        <seealso>
 
7903
          <link id="TControl.Floating"/>
 
7904
        </seealso>
 
7905
      </element>
 
7906
      <!-- property Visibility: public -->
 
7907
      <element name="TControl.Font">
 
7908
        <short>The <link id="#lcl.Graphics.TFont">font</link> to be used for text display in this control.</short>
 
7909
        <seealso>
 
7910
          <link id="#lcl.Graphics.TFont"/>
 
7911
        </seealso>
 
7912
      </element>
 
7913
      <!-- property Visibility: published -->
 
7914
      <element name="TControl.Height">
 
7915
        <short>The vertical size of the control.</short>
 
7916
      </element>
 
7917
      <!-- property Visibility: published -->
 
7918
      <element name="TControl.HelpContext">
 
7919
        <short>The ID for context-sensitive Help on this control.</short>
 
7920
        <descr/>
 
7921
        <seealso>
 
7922
          <link id="TControl.HelpKeyword"/>
 
7923
        </seealso>
 
7924
      </element>
 
7925
      <!-- property Visibility: published -->
 
7926
      <element name="TControl.HelpKeyword">
 
7927
        <short>The keyword for context-sensitive Help on this control.</short>
 
7928
        <descr/>
 
7929
        <seealso>
 
7930
          <link id="TControl.HelpContext"/>
 
7931
        </seealso>
 
7932
      </element>
 
7933
      <!-- property Visibility: published -->
 
7934
      <element name="TControl.HelpType">
 
7935
        <short>Determines whether context-sensitive Help is selected by numeric ID or keyword.</short>
 
7936
        <descr/>
 
7937
        <seealso>
 
7938
          <link id="TControl.HelpContext"/>
 
7939
          <link id="TControl.HelpKeyword"/>
 
7940
        </seealso>
 
7941
      </element>
 
7942
      <!-- property Visibility: published -->
 
7943
      <element name="TControl.Hint">
 
7944
        <short>The text to show in the Hint window for this control.</short>
 
7945
        <descr/>
 
7946
        <seealso>
 
7947
          <link id="TControl.ShowHint"/>
 
7948
          <link id="TControl.ParentShowHint"/>
 
7949
        </seealso>
 
7950
      </element>
 
7951
      <!-- property Visibility: public -->
 
7952
      <element name="TControl.HostDockSite">
 
7953
        <short>The host site (TWinControl) into which this control is docked. Nil if not docked.</short>
 
7954
        <descr/>
 
7955
        <seealso/>
 
7956
      </element>
 
7957
      <!-- property Visibility: public -->
 
7958
      <element name="TControl.IsControl">
 
7959
        <short>Determines whether this object shall be streamed as a control.</short>
 
7960
        <descr>Delphi compatible property, affecting only the streaming of <var>Form</var> properties.
 
7961
        </descr>
 
7962
      <notes><note>Has no effect in the LCL?</note>
 
7963
        </notes>
 
7964
      </element>
 
7965
      <!-- property Visibility: published -->
 
7966
      <element name="TControl.Left">
 
7967
        <short>The client coordinate of the left edge of the control.</short>
 
7968
      </element>
 
7969
      <!-- property Visibility: public -->
 
7970
      <element name="TControl.LRDockWidth">
 
7971
        <short>The Width when last docked, with siblings to the left or right.</short>
 
7972
        <descr/>
 
7973
        <seealso/>
 
7974
      </element>
 
7975
      <!-- property Visibility: protected -->
 
7976
      <element name="TControl.MouseCapture">
 
7977
        <short>True when mouse messages are currently captured by this control.</short>
 
7978
        <descr>
 
7979
          <p>In normal operation all mouse messages are sent to the control under the mouse pointer.
 
7980
            Mouse messages also can be sent to a capturing control,
 
7981
            e.g. when a control is dragged.
 
7982
          </p>
 
7983
          <p>Applications should capture mouse events only for special purposes,
 
7984
            and release the capture as soon as a the target position has been determined.
 
7985
            Limited user feedback is possible while the mouse is captured,
 
7986
            not all application controls will work properly so long.</p>
 
7987
        </descr>
 
7988
        <seealso/>
 
7989
      </element>
 
7990
      <!-- property Visibility: public -->
 
7991
      <element name="TControl.MouseEntered">
 
7992
        <short>True when the mouse has entered the control.</short>
 
7993
        <descr/>
 
7994
      </element>
 
7995
      <!-- property Visibility: public -->
 
7996
      <element name="TControl.OnChangeBounds">
 
7997
        <short>Event handler for a change of the Bounds of the control.</short>
 
7998
        <descr/>
 
7999
        <seealso>
 
8000
          <link id="#rtl.Classes.TNotifyEvent"/>
 
8001
        </seealso>
 
8002
      </element>
 
8003
      <!-- property Visibility: public -->
 
8004
      <element name="TControl.OnClick">
 
8005
        <short>Notification handler for mouse clicks.</short>
 
8006
        <descr>
 
8007
          <p>A mouse click is associated with the default action for controls, and is often the ONLY event handled in user code.
 
8008
          </p>
 
8009
          <p>The reaction on an click can be specified by a user supplied method,
 
8010
            and/or by selecting an action from a supplied <var>ActionList</var>
 
8011
          </p>
 
8012
        </descr>
 
8013
        <seealso>
 
8014
          <link id="#rtl.Classes.TNotifyEvent"/>
 
8015
        </seealso>
 
8016
      </element>
 
8017
      <!-- property Visibility: protected -->
 
8018
      <element name="TControl.OnConstrainedResize">
 
8019
        <short>This handler can supply specific Constraints (size limits), when the control is resized.</short>
 
8020
        <descr/>
 
8021
        <seealso>
 
8022
          <link id="TConstrainedResizeEvent"/>
 
8023
          <link id="TControl.Constraints"/>
 
8024
        </seealso>
 
8025
      </element>
 
8026
      <!-- property Visibility: protected -->
 
8027
      <element name="TControl.OnContextPopup">
 
8028
        <short>Invoked when a context-sensitive pop-up menu is requested.</short>
 
8029
        <descr>The handler can show and handle the menu selection itself.
 
8030
          If so, it should set Handled to True.
 
8031
          Otherwise the installed PopupMenu is shown.
 
8032
        </descr>
 
8033
        <seealso>
 
8034
          <link id="TContextPopupEvent"/>
 
8035
          <link id="TControl.PopupMenu"/>
 
8036
        </seealso>
 
8037
      </element>
 
8038
      <!-- property Visibility: protected -->
 
8039
      <element name="TControl.OnDblClick">
 
8040
        <short>Event Handler for double mouse clicks.</short>
 
8041
        <descr>
 
8042
          <p>Double-clicking is much more common in a Windows environment than in Unix or Linux,
 
8043
            where single-clicking is the default method for selecting an object.
 
8044
            However, in all environments there could be valid use for a double-click,
 
8045
            and a method should be supplied if appropriate.
 
8046
          </p>
 
8047
        </descr>
 
8048
      </element>
 
8049
      <!-- property Visibility: protected -->
 
8050
      <element name="TControl.OnDragDrop">
 
8051
        <short>This handler determines the action on an drop onto this control, in a drag-drop operation.
 
8052
        </short>
 
8053
        <descr>
 
8054
          <p>Unlike for a drag-dock operation,
 
8055
            no default action is associated with an drag-drop;
 
8056
            the OnDragDrop handler is the only way to do something meaningful on an drag-drop.
 
8057
          </p>
 
8058
        </descr>
 
8059
        <seealso>
 
8060
          <link id="TControl.TDragDropEvent"/>
 
8061
          <link id="TControl.DragDrop"/>
 
8062
        </seealso>
 
8063
      </element>
 
8064
      <!-- property Visibility: protected -->
 
8065
      <element name="TControl.OnDragOver">
 
8066
        <short>Event handler for a control being dragged over this control.</short>
 
8067
        <descr>The handler can reject an drop, by setting Accept to False.
 
8068
        </descr>
 
8069
        <seealso>
 
8070
          <link id="TDragOverEvent"/>
 
8071
        </seealso>
 
8072
      </element>
 
8073
      <!-- property Visibility: protected -->
 
8074
      <element name="TControl.OnEditingDone">
 
8075
        <short>Event handler when editing is done.</short>
 
8076
        <descr>The user definitely has finished editing,
 
8077
          the resulting text e.g. can be validated.
 
8078
        </descr>
 
8079
      </element>
 
8080
      <!-- property Visibility: protected -->
 
8081
      <element name="TControl.OnEndDock">
 
8082
        <short>Notification handler for the end of a docking operation.</short>
 
8083
        <descr/>
 
8084
        <seealso>
 
8085
          <link id="TEndDragEvent"/>
 
8086
        </seealso>
 
8087
      </element>
 
8088
      <!-- property Visibility: protected -->
 
8089
      <element name="TControl.OnEndDrag">
 
8090
        <short>Notification handler for the end of a dragging operation.</short>
 
8091
        <descr/>
 
8092
        <seealso>
 
8093
          <link id="TEndDragEvent"/>
 
8094
        </seealso>
 
8095
      </element>
 
8096
      <!-- property Visibility: protected -->
 
8097
      <element name="TControl.OnMouseDown">
 
8098
        <short>Event handler for mouse button going down.</short>
 
8099
        <seealso>
 
8100
          <link id="TControl.OnClick"/>
 
8101
        </seealso>
 
8102
      </element>
 
8103
      <!-- property Visibility: protected -->
 
8104
      <element name="TControl.OnMouseEnter">
 
8105
        <short>Event handler for mouse entering the area of the control.</short>
 
8106
      </element>
 
8107
      <!-- property Visibility: protected -->
 
8108
      <element name="TControl.OnMouseLeave">
 
8109
        <short>Event handler for mouse leaving the area of the control.</short>
 
8110
      </element>
 
8111
      <!-- property Visibility: protected -->
 
8112
      <element name="TControl.OnMouseMove">
 
8113
        <short>Event handler for mouse movement within the control.</short>
 
8114
      </element>
 
8115
      <!-- property Visibility: protected -->
 
8116
      <element name="TControl.OnMouseUp">
 
8117
        <short>Event handler for mouse button going up.</short>
 
8118
        <seealso>
 
8119
          <link id="TControl.OnClick"/>
 
8120
        </seealso>
 
8121
      </element>
 
8122
      <element name="TControl.OnMouseWheel">
 
8123
        <short>Event handler for mouse wheel turned.</short>
 
8124
        <descr>
 
8125
          <p>By default all mouse wheel actions are translated into scroll events.
 
8126
            Write an OnMouseWheel handler to react on turns of the mouse wheel.
 
8127
          </p>
 
8128
          <p>The OnMouseWheelUp and OnMouseWheelDown handlers are notified only,
 
8129
            they are not suited for customization of mouse wheel events.
 
8130
          </p>
 
8131
        </descr>
 
8132
        <seealso>
 
8133
          <link id="TMouseWheelEvent"/>
 
8134
        </seealso>
 
8135
      </element>
 
8136
      <element name="TControl.OnMouseWheelDown">
 
8137
        <short>Notification handler for downward movement of mouse wheel.</short>
 
8138
        <seealso>
 
8139
          <link id="TControl.OnMouseWheel"/>
 
8140
          <link id="TMouseWheelUpDownEvent"/>
 
8141
        </seealso>
 
8142
      </element>
 
8143
      <element name="TControl.OnMouseWheelUp">
 
8144
        <short>Notification handler for upward movement of mouse wheel.</short>
 
8145
        <seealso>
 
8146
          <link id="TControl.OnMouseWheel"/>
 
8147
          <link id="TMouseWheelUpDownEvent"/>
 
8148
        </seealso>
 
8149
      </element>
 
8150
      <!-- property Visibility: protected -->
 
8151
      <element name="TControl.OnQuadClick">
 
8152
        <short>Event handler for quadruple mouse clicks.</short>
 
8153
      </element>
 
8154
      <!-- property Visibility: public -->
 
8155
      <element name="TControl.OnResize">
 
8156
        <short>Notification handler for a resize of the control.</short>
 
8157
        <descr>
 
8158
          <p>This event is triggered after the Width, Height, ClientWidth or ClientHeight of the control has changed.
 
8159
            During autosize the size can change multiple times, but only the last change triggers the OnResize.
 
8160
          </p>
 
8161
          <p>Use OnResize to react on size changes.
 
8162
            To also react on moves, use the OnChangeBounds event.
 
8163
          </p>
 
8164
          <p>If you want to customize the resize behaviour, use OnConstrainedResize instead.
 
8165
          </p>
 
8166
          <p>Common mistake:
 
8167
            Keep in mind that ClientWidth and ClientHeight can change even when Width, Height stays the same.
 
8168
            For example when the theme changes, the Width and Height remain the same, but the changed frame reduces the ClientWidth and ClientHeight.
 
8169
            This does not happen that often under Windows, but it happens quite often on other platforms.
 
8170
          </p>
 
8171
          <p>Especially it is not sufficient to write only a TForm.OnResize handler to resize all controls on the form. This is a common bug in Delphi applications.
 
8172
          </p>
 
8173
        </descr>
 
8174
        <seealso>
 
8175
          <link id="TControl.OnConstrainedResize"/>
 
8176
          <link id="#rtl.Classes.TNotifyEvent"/>
 
8177
        </seealso>
 
8178
      <notes><note>???</note>
 
8179
        </notes>
 
8180
      </element>
 
8181
      <!-- property Visibility: public -->
 
8182
      <element name="TControl.OnShowHint">
 
8183
        <short>Event Handler when a hint shall be shown.</short>
 
8184
        <descr/>
 
8185
        <seealso>
 
8186
          <link id="TControl.Hint"/>
 
8187
          <link id="#lcl.Controls.THintInfo"/>
 
8188
          <link id="#lcl.Controls.TControlShowHintEvent"/>
 
8189
        </seealso>
 
8190
      <notes><note>Tasks, Usage?</note>
 
8191
        </notes>
 
8192
      </element>
 
8193
      <!-- property Visibility: protected -->
 
8194
      <element name="TControl.OnStartDock">
 
8195
        <short>Event handler for the start of a docking operation.</short>
 
8196
        <descr>
 
8197
          <p>The handler can provide a special DragDock object, otherwise a default object is created.</p>
 
8198
        </descr>
 
8199
        <seealso>
 
8200
          <link id="#lcl.Controls.TDragDockObject"/>
 
8201
          <link id="TControl.OnStartDrag"/>
 
8202
        </seealso>
 
8203
      </element>
 
8204
      <!-- property Visibility: protected -->
 
8205
      <element name="TControl.OnStartDrag">
 
8206
        <short>Event handler for the start of a dragging operation.</short>
 
8207
        <descr>
 
8208
          <p>The handler can provide a special DragControl object, otherwise a default object is created.</p>
 
8209
        </descr>
 
8210
        <seealso>
 
8211
          <link id="#lcl.Controls.TDragObject"/>
 
8212
          <link id="TControl.OnStartDock"/>
 
8213
        </seealso>
 
8214
      </element>
 
8215
      <!-- property Visibility: protected -->
 
8216
      <element name="TControl.OnTripleClick">
 
8217
        <short>Event handler for triple mouse clicks.</short>
 
8218
      </element>
 
8219
      <!-- property Visibility: public -->
 
8220
      <element name="TControl.Parent">
 
8221
        <short>The control within which the control is shown.</short>
 
8222
        <descr>
 
8223
          <p>When the Parent moves or hides, all its children move or hide together with it.
 
8224
</p>
 
8225
          <p>Every TControl must have a Parent, else it is never shown.
 
8226
</p>
 
8227
          <p>The Parent of a floating form is Nil.
 
8228
</p>
 
8229
          <p>Set the parent last to reduce updates. For example:
 
8230
Button1:=TButton.Create(Self);
 
8231
Button1.Name:='Button1';
 
8232
Button1.Caption:='Click me'; // parent is not set, so it does not update the whole form
 
8233
Button1.Parent:=Form1; // set parent as last, the LCL now applies all properties
 
8234
</p>
 
8235
          <p>Delphi/VCL: Parent must be set first under Delphi, because many properties work differently if they are set before or after Handle creation. The LCL applies the properties when the Handle is created.
 
8236
</p>
 
8237
        </descr>
 
8238
      </element>
 
8239
      <!-- property Visibility: public -->
 
8240
      <element name="TControl.ParentBiDiMode">
 
8241
        <short>Allows to use the BiDiMode settings of Parent. Default is true.</short>
 
8242
        <seealso>
 
8243
          <link id="TControl.BiDiMode"/>
 
8244
        </seealso>
 
8245
      </element>
 
8246
      <!-- property Visibility: protected -->
 
8247
      <element name="TControl.ParentColor">
 
8248
        <short>If true, the Color of the control will be the same as the one from the Parent. Default is true.</short>
 
8249
        <descr>While this property is True, all changes to the Color of the parent will be 
 
8250
          also done to the Color of the control, syncronizing them and keeping them with the same value. 
 
8251
          If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
 
8252
          The combination of ParentColor with clDefault can cause problems in resolving clDefault. To obtain the Color
 
8253
          property of a control while taking into account clDefault and ParentColor one whould use TControl.GetColorResolvingParent.
 
8254
          This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use
 
8255
          TColor.GetRGBColorResolvingParent
 
8256
        </descr>
 
8257
        <seealso>
 
8258
          <link id="TControl.Color"/>
 
8259
          <link id="TControl.GetColorResolvingParent"/>
 
8260
          <link id="TControl.GetRGBColorResolvingParent"/>
 
8261
        </seealso>
 
8262
      </element>
 
8263
      <!-- property Visibility: protected -->
 
8264
      <element name="TControl.ParentFont">
 
8265
        <short>If true, the Font of the control will be the same as the one from the Parent. Default is true.</short>
 
8266
        <descr>While this property is True, all changes to the font of the parent will be 
 
8267
          also done to the font of the control, syncronizing them and keeping them with the same value. 
 
8268
          If the Font of the control is changed by the application, then ParentFont will be automatically set to False.
 
8269
        </descr>
 
8270
        <seealso>
 
8271
          <link id="TControl.Font"/>
 
8272
        </seealso>
 
8273
      </element>
 
8274
      <!-- property Visibility: protected -->
 
8275
      <element name="TControl.ParentShowHint">
 
8276
        <short>If true, the value of ShowHint for the control will be the same as the one from the Parent. Default is true.</short>
 
8277
        <descr>While this property is True, all changes to the ShowHint property of the parent will be 
 
8278
          also done to the ShowHint property of the control, syncronizing them and keeping them with the same value. 
 
8279
          If the ShowHint property of the control is changed by the application, then ParentShowHint will be automatically set to False.
 
8280
        </descr>
 
8281
        <seealso>
 
8282
          <link id="TControl.Hint"/>
 
8283
          <link id="TControl.ShowHint"/>
 
8284
        </seealso>
 
8285
      </element>
 
8286
      <!-- property Visibility: public -->
 
8287
      <element name="TControl.PopupMenu">
 
8288
        <short>A context-sensitive menu that pops up when the right mouse button is clicked over this control</short>
 
8289
        <descr/>
 
8290
        <seealso>
 
8291
          <link id="#lcl.Menus.TPopupMenu"/>
 
8292
          <link id="TControl.OnContextPopup"/>
 
8293
          <link id="TControl.TContextPopupEvent"/>
 
8294
        </seealso>
 
8295
      </element>
 
8296
      <!-- property Visibility: public -->
 
8297
      <element name="TControl.ReadBounds">
 
8298
        <short/>
 
8299
        <descr/>
 
8300
        <seealso/>
 
8301
      <notes><note>?</note>
 
8302
        </notes>
 
8303
      </element>
 
8304
      <!-- property Visibility: protected -->
 
8305
      <element name="TControl.SessionProperties">
 
8306
        <short>The stored (saved) properties of the current session, expressed as a string</short>
 
8307
        <descr/>
 
8308
        <seealso/>
 
8309
      <notes><note>What's 'session'?</note><note>Usage?</note>
 
8310
        </notes>
 
8311
      </element>
 
8312
      <!-- property Visibility: public -->
 
8313
      <element name="TControl.ShowHint">
 
8314
        <short>Enables the <link id="#lcl.Controls.TControl.Hint">Hint</link> display.</short>
 
8315
        <descr>
 
8316
          <p>When True, the Hint text is shown when the mouse hovers over the control.
 
8317
          </p>
 
8318
          <p>Display of the actual hint is controlled by OnShowHint.
 
8319
          </p>
 
8320
        </descr>
 
8321
        <seealso>
 
8322
          <link id="TControl.Hint">Hint</link>
 
8323
          <link id="#lcl.Controls.TControl.OnShowHint">OnShowHint</link>
 
8324
          <link id="TControl.ParentShowHint">ParentShowHint</link>
 
8325
        </seealso>
 
8326
      </element>
 
8327
      <!-- property Visibility: public -->
 
8328
      <element name="TControl.TBDockHeight">
 
8329
        <short>The Height when last docked, with siblings above or below.</short>
 
8330
        <descr/>
 
8331
        <seealso/>
 
8332
      </element>
 
8333
      <!-- property Visibility: protected -->
 
8334
      <element name="TControl.Text">
 
8335
        <short>The character string associated with the control.</short>
 
8336
        <descr>
 
8337
          <p>This is the character string, shown in controls with visible text content (<link id="#lcl.StdCtrls.TEdit">TEdit</link>...).</p>
 
8338
          <remark>BEWARE: In other controls it can be the Name or Caption of the control, quite tricky to use.</remark>
 
8339
          <p>The Delphi VCL implementation stores Text mostly in the widgets,
 
8340
            using the virtual <var>Get/SetTextBuf</var> methods to exchange text between widgets and VCL.
 
8341
            This means a lot of text copies and message handling in WM_GETTEXT and WM_SETTEXT.
 
8342
          </p>
 
8343
          <p>The LCL instead (typically) stores Text in a field of the control,
 
8344
            and transfers it from/to the widgets only when required.
 
8345
          </p>
 
8346
          <p>To maintain VCL compatibility,
 
8347
            the virtual <var>RealGet/SetText</var> methods have been introduced,
 
8348
            which read or write the Caption string directly.
 
8349
          </p>
 
8350
          <p>The default <var>Get/SetTextBuf</var> implementation calls the <var>RealGet/SetText</var> methods,
 
8351
            resulting in a string-to-PCHAR and another PCHAR-to-string conversion.
 
8352
            But as long as <var>Get/SetTextBuf</var> is not overridden,
 
8353
            <var>Get/SetText</var> can (and does) safely call <var>RealGet/SetText</var> immediately,
 
8354
            to avoid beforementioned conversions.
 
8355
          </p>
 
8356
          <p>To keep things optimal, LCL components should always override RealGet/SetText;
 
8357
            Get/SetTextBuf is only kept for compatibility.
 
8358
          </p>
 
8359
        </descr>
 
8360
      </element>
 
8361
      <!-- property Visibility: published -->
 
8362
      <element name="TControl.Top">
 
8363
        <short>The client coordinate of the top edge of the control.</short>
 
8364
      </element>
 
8365
      <!-- property Visibility: public -->
 
8366
      <element name="TControl.UndockHeight">
 
8367
        <short>The height of the control in floating state.</short>
 
8368
        <descr/>
 
8369
        <seealso/>
 
8370
      </element>
 
8371
      <!-- property Visibility: public -->
 
8372
      <element name="TControl.UndockWidth">
 
8373
        <short>The width of the control in floating state.</short>
 
8374
        <descr/>
 
8375
        <seealso/>
 
8376
      </element>
 
8377
      <!-- property Visibility: public -->
 
8378
      <element name="TControl.Visible">
 
8379
        <short>Allows to show or hide the control, and all of its children.
 
8380
        </short>
 
8381
        <descr>
 
8382
          <p>Visible is set to True by <var>Show</var>, or to False by <var>Hide</var>.
 
8383
            Calling these methods is equivalent to setting the Visible property.
 
8384
          </p>
 
8385
          <remark>Reading the Visible property does not take into account control's parent visibility.
 
8386
            Use the IsVisible method to get the real visibility.</remark>
 
8387
        </descr>
 
8388
        <seealso>
 
8389
          <link id="#lcl.Controls.TControl.IsVisible"/>
 
8390
          <link id="#lcl.Controls.TControl.Show"/>
 
8391
          <link id="#lcl.Controls.TControl.Hide"/>
 
8392
        </seealso>
 
8393
      </element>
 
8394
      <!-- property Visibility: published -->
 
8395
      <element name="TControl.Width">
 
8396
        <short>The horizontal extent of the control.</short>
 
8397
      </element>
 
8398
      <!-- property Visibility: public -->
 
8399
      <element name="TControl.WindowProc">
 
8400
        <short>The handler for all messages.</short>
 
8401
        <descr>
 
8402
          <p>WindowProc is set to <link id="TControl.WndProc"/> by default.
 
8403
          </p>
 
8404
          <p>When you ever change WindowProc, then remember the previous setting
 
8405
            and delegate all unhandled messages to that method.
 
8406
          </p>
 
8407
        </descr>
 
8408
        <seealso>
 
8409
          <link id="#lcl.Controls.TWndMethod">TWndMethod</link>
 
8410
          <link id="#lcl.LMessages.TLMessage">TLMessage</link>
 
8411
          <link id="TControl.Perform">Perform</link>
 
8412
        </seealso>
 
8413
      </element>
 
8414
      <!-- range type Visibility: default -->
 
8415
      <element name="TBorderWidth">
 
8416
        <short>Integer type for <link id="TWinControl.BorderWidth"/>.</short>
 
8417
      </element>
 
8418
      <!-- procedure type Visibility: default -->
 
8419
      <element name="TGetChildProc">
 
8420
        <short>Type of a callback method, to be called for all children of a control.</short>
 
8421
        <descr/>
 
8422
        <seealso>
 
8423
          <link id="TWinControl.GetChildren"/>
 
8424
        </seealso>
 
8425
      </element>
 
8426
      <element name="TGetChildProc.Child">
 
8427
        <short>The child control.</short>
 
8428
      </element>
 
8429
      <!-- object Visibility: default -->
 
8430
      <element name="TControlChildSizing">
 
8431
        <short>How Child controls are to be sized relative to parent.</short>
 
8432
        <descr>
 
8433
          <code>{ LeftRightSpacing, TopBottomSpacing: integer;
 
8434
        minimum space between client border and nearest child control.
 
8435
        For example: ClientLeftRight=5 means leftmost child's Left position is at least 5.
 
8436
 
 
8437
    HorizontalSpacing, VerticalSpacing: integer;
 
8438
        minimum space between each child control.
 
8439
  }
 
8440
 
 
8441
  {   Defines how child controls are resized/aligned.
 
8442
 
 
8443
      cesAnchorAligning, cssAnchorAligning
 
8444
        Anchors and Align work like Delphi. For example if Anchors property of
 
8445
        the control is [akLeft], it means fixed distance between left border of
 
8446
        parent's client area. [akRight] means fixed distance between right
 
8447
        border of the control and the right border of the parent's client area.
 
8448
        When the parent is resized the child is moved to keep the distance.
 
8449
        [akLeft,akRight] means fixed distance to left border and fixed distance
 
8450
        to right border. When the parent is resized, the controls width is
 
8451
        changed (resized) to keep the left and right distance.
 
8452
        Same for akTop,akBottom.
 
8453
 
 
8454
        Align=alLeft for a control means set Left leftmost, Top topmost and
 
8455
        maximize Height. The width is kept, if akRight is not set. If akRight
 
8456
        is set in the Anchors property, then the right distance is kept and
 
8457
        the control's width is resized.
 
8458
        If there several controls with Align=alLeft, they will not overlapp and
 
8459
        be put side by side.
 
8460
        Same for alRight, alTop, alBottom. (Always expand 3 sides).
 
8461
 
 
8462
        Align=alClient. The control will fill the whole remaining space.
 
8463
        Setting two children to Align=alClient does only make sense, if you set
 
8464
        maximum Constraints.
 
8465
 
 
8466
        Order: First all alTop children are resized, then alBottom, then alLeft,
 
8467
        then alRight and finally alClient.
 
8468
 
 
8469
      cesScaleChilds, cssScaleChilds
 
8470
        Scale children, keep space between them fixed.
 
8471
        Children are resized to their normal/advised size. If there is some space
 
8472
        left in the client area of the parent, then the children are scaled to
 
8473
        fill the space. You can set maximum Constraints. Then the other children
 
8474
        are scaled more.
 
8475
        For example: 3 child controls A, B, C with A.Width=10, B.Width=20 and
 
8476
        C.Width=30 (total=60). If the Parent's client area has a ClientWidth of
 
8477
        120, then the children are scaled with Factor 2.
 
8478
        If B has a maximum constraint width of 30, then first the children will be
 
8479
        scaled with 1.5 (A.Width=15, B.Width=30, C.Width=45). Then A and C
 
8480
        (15+45=60 and 30 pixel space left) will be scaled by 1.5 again, to a
 
8481
        final result of: A.Width=23, B.Width=30, C.Width=67 (23+30+67=120).
 
8482
 
 
8483
      cesHomogenousChildGrowth, cssHomogenousChildDecrease
 
8484
        Enlarge children equally.
 
8485
        Children are resized to their normal/advised size. If there is some space
 
8486
        left in the client area of the parent, then the remaining space is
 
8487
        distributed equally to each child.
 
8488
        For example: 3 child controls A, B, C with A.Width=10, B.Width=20 and
 
8489
        C.Width=30 (total=60). If the Parent's client area has a ClientWidth of
 
8490
        120, then 60/3=20 is added to each Child.
 
8491
        If B has a maximum constraint width of 30, then first 10 is added to
 
8492
        all children (A.Width=20, B.Width=30, C.Width=40). Then A and C
 
8493
        (20+40=60 and 30 pixel space left) will get 30/2=15 additional,
 
8494
        resulting in: A.Width=35, B.Width=30, C.Width=55 (35+30+55=120).
 
8495
 
 
8496
      cesHomogenousSpaceGrowth
 
8497
        Enlarge space between children equally.
 
8498
        Children are resized to their normal/advised size. If there is some space
 
8499
        left in the client area of the parent, then the space between the children
 
8500
        is expanded.
 
8501
        For example: 3 child controls A, B, C with A.Width=10, B.Width=20 and
 
8502
        C.Width=30 (total=60). If the Parent's client area has a ClientWidth of
 
8503
        120, then there will be 60/2=30 space between A and B and between
 
8504
        B and C.
 
8505
  }
 
8506
 
 
8507
</code>
 
8508
        </descr>
 
8509
        <errors/>
 
8510
        <seealso/>
 
8511
      <notes><note>???</note>
 
8512
        </notes>
 
8513
      </element>
 
8514
      <!-- variable Visibility: private -->
 
8515
      <element link="TControlChildSizing.Control" name="TControlChildSizing.FControl"/>
 
8516
      <element link="TControlChildSizing.ControlsPerLine" name="TControlChildSizing.FControlsPerLine"/>
 
8517
      <element link="TControlChildSizing.EnlargeHorizontal" name="TControlChildSizing.FEnlargeHorizontal"/>
 
8518
      <element link="TControlChildSizing.EnlargeVertical" name="TControlChildSizing.FEnlargeVertical"/>
 
8519
      <element link="TControlChildSizing.HorizontalSpacing" name="TControlChildSizing.FHorizontalSpacing"/>
 
8520
      <element link="TControlChildSizing.Layout" name="TControlChildSizing.FLayout"/>
 
8521
      <element link="TControlChildSizing.LeftRightSpacing" name="TControlChildSizing.FLeftRightSpacing"/>
 
8522
      <element link="TControlChildSizing.OnChange" name="TControlChildSizing.FOnChange"/>
 
8523
      <element link="TControlChildSizing.ShrinkHorizontal" name="TControlChildSizing.FShrinkHorizontal"/>
 
8524
      <element link="TControlChildSizing.ShrinkVertical" name="TControlChildSizing.FShrinkVertical"/>
 
8525
      <element link="TControlChildSizing.TopBottomSpacing" name="TControlChildSizing.FTopBottomSpacing"/>
 
8526
      <element link="TControlChildSizing.VerticalSpacing" name="TControlChildSizing.FVerticalSpacing"/>
 
8527
      <!-- procedure Visibility: private -->
 
8528
      <element link="TControlChildSizing.ControlsPerLine" name="TControlChildSizing.SetControlsPerLine"/>
 
8529
      <element name="TControlChildSizing.SetControlsPerLine.AValue">
 
8530
        <short/>
 
8531
      </element>
 
8532
      <!-- procedure Visibility: private -->
 
8533
      <element link="TControlChildSizing.EnlargeHorizontal" name="TControlChildSizing.SetEnlargeHorizontal"/>
 
8534
      <element name="TControlChildSizing.SetEnlargeHorizontal.AValue">
 
8535
        <short/>
 
8536
      </element>
 
8537
      <!-- procedure Visibility: private -->
 
8538
      <element link="TControlChildSizing.EnlargeVertical" name="TControlChildSizing.SetEnlargeVertical"/>
 
8539
      <element name="TControlChildSizing.SetEnlargeVertical.AValue">
 
8540
        <short/>
 
8541
      </element>
 
8542
      <!-- procedure Visibility: private -->
 
8543
      <element link="TControlChildSizing.HorizontalSpacing" name="TControlChildSizing.SetHorizontalSpacing"/>
 
8544
      <element name="TControlChildSizing.SetHorizontalSpacing.AValue">
 
8545
        <short/>
 
8546
      </element>
 
8547
      <!-- procedure Visibility: private -->
 
8548
      <element link="TControlChildSizing.Layout" name="TControlChildSizing.SetLayout"/>
 
8549
      <element name="TControlChildSizing.SetLayout.AValue">
 
8550
        <short/>
 
8551
      </element>
 
8552
      <!-- procedure Visibility: private -->
 
8553
      <element link="TControlChildSizing.LeftRightSpacing" name="TControlChildSizing.SetLeftRightSpacing"/>
 
8554
      <element name="TControlChildSizing.SetLeftRightSpacing.AValue">
 
8555
        <short/>
 
8556
      </element>
 
8557
      <!-- procedure Visibility: private -->
 
8558
      <element link="TControlChildSizing.ShrinkHorizontal" name="TControlChildSizing.SetShrinkHorizontal"/>
 
8559
      <element name="TControlChildSizing.SetShrinkHorizontal.AValue">
 
8560
        <short/>
 
8561
      </element>
 
8562
      <!-- procedure Visibility: private -->
 
8563
      <element link="TControlChildSizing.ShrinkVertical" name="TControlChildSizing.SetShrinkVertical"/>
 
8564
      <element name="TControlChildSizing.SetShrinkVertical.AValue">
 
8565
        <short/>
 
8566
      </element>
 
8567
      <!-- procedure Visibility: private -->
 
8568
      <element link="TControlChildSizing.TopBottomSpacing" name="TControlChildSizing.SetTopBottomSpacing"/>
 
8569
      <element name="TControlChildSizing.SetTopBottomSpacing.AValue">
 
8570
        <short/>
 
8571
      </element>
 
8572
      <!-- procedure Visibility: private -->
 
8573
      <element link="TControlChildSizing.VerticalSpacing" name="TControlChildSizing.SetVerticalSpacing"/>
 
8574
      <element name="TControlChildSizing.SetVerticalSpacing.AValue">
 
8575
        <short/>
 
8576
      </element>
 
8577
      <!-- procedure Visibility: protected -->
 
8578
      <element name="TControlChildSizing.Change">
 
8579
        <short>Notifies Control and invokes the
 
8580
          <var>OnChange</var> handler.</short>
 
8581
        <descr/>
 
8582
        <errors/>
 
8583
        <seealso>
 
8584
          <link id="TWinControl.DoChildSizingChange"/>
 
8585
        </seealso>
 
8586
      </element>
 
8587
      <!-- constructor Visibility: public -->
 
8588
      <element name="TControlChildSizing.Create"/>
 
8589
      <element name="TControlChildSizing.Create.OwnerControl">
 
8590
        <short/>
 
8591
      </element>
 
8592
      <!-- procedure Visibility: public -->
 
8593
      <element link="#rtl.Classes.TPersistent.Assign" name="TControlChildSizing.Assign"/>
 
8594
      <element name="TControlChildSizing.Assign.Source">
 
8595
        <short/>
 
8596
      </element>
 
8597
      <!-- procedure Visibility: public -->
 
8598
      <element link="TPersistent.AssignTo" name="TControlChildSizing.AssignTo"/>
 
8599
      <element name="TControlChildSizing.AssignTo.Dest">
 
8600
        <short/>
 
8601
      </element>
 
8602
      <!-- function Visibility: public -->
 
8603
      <element name="TControlChildSizing.IsEqual">
 
8604
        <short>True if the specified sizing is equal to this one.</short>
 
8605
        <descr/>
 
8606
        <errors/>
 
8607
        <seealso/>
 
8608
      </element>
 
8609
      <element name="TControlChildSizing.IsEqual.Result">
 
8610
        <short/>
 
8611
      </element>
 
8612
      <element name="TControlChildSizing.IsEqual.Sizing">
 
8613
        <short/>
 
8614
      </element>
 
8615
      <!-- procedure Visibility: public -->
 
8616
      <element name="TControlChildSizing.SetGridSpacing">
 
8617
        <short>Set all spaceing to the same value.</short>
 
8618
        <descr/>
 
8619
        <errors/>
 
8620
        <seealso/>
 
8621
      </element>
 
8622
      <element name="TControlChildSizing.SetGridSpacing.Spacing">
 
8623
        <short/>
 
8624
      </element>
 
8625
      <!-- property Visibility: public -->
 
8626
      <element name="TControlChildSizing.Control">
 
8627
        <short>The <var>Control</var> to which childsizing applies.</short>
 
8628
        <descr/>
 
8629
        <seealso/>
 
8630
      </element>
 
8631
      <!-- property Visibility: published -->
 
8632
      <element name="TControlChildSizing.ControlsPerLine">
 
8633
        <short>number of controls per line</short>
 
8634
        <descr/>
 
8635
        <seealso/>
 
8636
      </element>
 
8637
      <!-- property Visibility: public -->
 
8638
      <element name="TControlChildSizing.EnlargeHorizontal">
 
8639
        <short>Various ways to fit controls into the available Width.</short>
 
8640
        <descr/>
 
8641
        <seealso/>
 
8642
      </element>
 
8643
      <!-- property Visibility: public -->
 
8644
      <element name="TControlChildSizing.EnlargeVertical">
 
8645
        <short>Various ways to fit controls into the available Height.</short>
 
8646
        <descr/>
 
8647
        <seealso/>
 
8648
      </element>
 
8649
      <!-- property Visibility: published -->
 
8650
      <element name="TControlChildSizing.HorizontalSpacing">
 
8651
        <short>Minimum space between children.</short>
 
8652
        <descr/>
 
8653
        <seealso/>
 
8654
      </element>
 
8655
      <!-- property Visibility: published -->
 
8656
      <element name="TControlChildSizing.Layout">
 
8657
        <short>Allows to also arrange the child controls in rows or columns.</short>
 
8658
        <descr/>
 
8659
        <seealso/>
 
8660
      </element>
 
8661
      <!-- property Visibility: published -->
 
8662
      <element name="TControlChildSizing.LeftRightSpacing">
 
8663
        <short>Minimum distance between children and client border.
 
8664
        </short>
 
8665
        <descr/>
 
8666
        <seealso/>
 
8667
      </element>
 
8668
      <!-- property Visibility: public -->
 
8669
      <element name="TControlChildSizing.OnChange">
 
8670
        <short>Event handler for any change in the data.</short>
 
8671
        <descr/>
 
8672
        <seealso/>
 
8673
      </element>
 
8674
      <!-- property Visibility: public -->
 
8675
      <element name="TControlChildSizing.ShrinkHorizontal">
 
8676
        <short>Various ways to fit controls into the available Width.</short>
 
8677
        <descr/>
 
8678
        <seealso/>
 
8679
      </element>
 
8680
      <!-- property Visibility: public -->
 
8681
      <element name="TControlChildSizing.ShrinkVertical">
 
8682
        <short>Various ways to fit controls into the available Height.</short>
 
8683
        <descr/>
 
8684
        <seealso/>
 
8685
      </element>
 
8686
      <!-- property Visibility: published -->
 
8687
      <element name="TControlChildSizing.TopBottomSpacing">
 
8688
        <short>Minimum distance between children and client border.
 
8689
        </short>
 
8690
        <descr/>
 
8691
        <seealso/>
 
8692
      </element>
 
8693
      <!-- property Visibility: published -->
 
8694
      <element name="TControlChildSizing.VerticalSpacing">
 
8695
        <short>Minimum space between children.</short>
 
8696
        <descr/>
 
8697
        <seealso/>
 
8698
      </element>
 
8699
      <!-- object Visibility: default -->
 
8700
      <element link="TControlActionLink" name="TWinControlActionLink"/>
 
8701
      <element link="TControlActionLink" name="TWinControlActionLinkClass">
 
8702
        <short>Class of
 
8703
          <var>TWinControlActionLink</var>
 
8704
        </short>
 
8705
        <descr/>
 
8706
        <seealso/>
 
8707
      </element>
 
8708
      <!-- enumeration type Visibility: default -->
 
8709
      <element name="TWinControlFlag">
 
8710
        <short>State flags of TWinControl.</short>
 
8711
        <descr/>
 
8712
        <seealso/>
 
8713
      </element>
 
8714
      <element name="TWinControlFlag.wcfClientRectNeedsUpdate">
 
8715
        <short/>
 
8716
      <notes><note>?</note>
 
8717
        </notes>
 
8718
      </element>
 
8719
      <element name="TWinControlFlag.wcfColorChanged">
 
8720
        <short/>
 
8721
      <notes><note>?</note>
 
8722
        </notes>
 
8723
      </element>
 
8724
      <element name="TWinControlFlag.wcfFontChanged">
 
8725
        <short>Set if font was changed before handle creation.</short>
 
8726
      </element>
 
8727
      <element name="TWinControlFlag.wcfAllAutoSizing">
 
8728
        <short>Set during DoAllAutosize.</short>
 
8729
      </element>
 
8730
      <element name="TWinControlFlag.wcfAligningControls">
 
8731
        <short>Set during <link id="TWinControl.AlignControls"/>
 
8732
        </short>
 
8733
      </element>
 
8734
      <element name="TWinControlFlag.wcfEraseBackground">
 
8735
        <short/>
 
8736
      <notes><note>?</note>
 
8737
        </notes>
 
8738
      </element>
 
8739
      <element name="TWinControlFlag.wcfCreatingHandle">
 
8740
        <short>Set while constructing the handle of this control.</short>
 
8741
      </element>
 
8742
      <element name="TWinControlFlag.wcfInitializing">
 
8743
        <short>Set while initializing during handle creation.</short>
 
8744
      </element>
 
8745
      <element name="TWinControlFlag.wcfCreatingChildHandles">
 
8746
        <short>Set while constructing the handles of the children.</short>
 
8747
      </element>
 
8748
      <element name="TWinControlFlag.wcfRealizingBounds">
 
8749
        <short>Set inside RealizeBoundsRecursive.</short>
 
8750
      </element>
 
8751
      <element name="TWinControlFlag.wcfBoundsRealized">
 
8752
        <short>Set before bounds are sent to the widget.
 
8753
          Used to suppress consequential size messages, sent by the widget.
 
8754
        </short>
 
8755
      </element>
 
8756
      <element name="TWinControlFlag.wcfUpdateShowing">
 
8757
        <short/>
 
8758
      <notes><note>?</note>
 
8759
        </notes>
 
8760
      </element>
 
8761
      <element name="TWinControlFlag.wcfHandleVisible">
 
8762
        <short/>
 
8763
      <notes><note>?</note>
 
8764
        </notes>
 
8765
      </element>
 
8766
      <element name="TWinControlFlag.wcfAdjustedLogicalClientRectValid">
 
8767
        <short>Set when the adjusted ClientRect is valid.</short>
 
8768
        <seealso>
 
8769
          <link id="TWinControl.GetAdjustedLogicalClientRect"/>
 
8770
        </seealso>
 
8771
      </element>
 
8772
      <element name="TWinControlFlag.wcfKillIntfSetBounds">
 
8773
        <short/>
 
8774
      <notes><note>?</note>
 
8775
        </notes>
 
8776
      </element>
 
8777
      <!-- set type Visibility: default -->
 
8778
      <element link="TWinControlFlag" name="TWinControlFlags">
 
8779
        <short>Set of TWinControlFlag.</short>
 
8780
      </element>
 
8781
      <!-- record type Visibility: default -->
 
8782
      <element name="TAlignInfo">
 
8783
        <short>Used in custom alignment (alCustom).</short>
 
8784
        <descr>This record was added only after D7.
 
8785
          It's used in CustomInsertBefore and CustomAlignPosition methods and handlers.
 
8786
        </descr>
 
8787
        <seealso>
 
8788
          <link id="TWinControl.CustomAlignPosition"/>
 
8789
          <link id="TWinControl.CustomAlignInsertBefore"/>
 
8790
        </seealso>
 
8791
      </element>
 
8792
      <element name="TAlignInfo.AlignList">
 
8793
        <short>The list of controls currently being aligned.</short>
 
8794
        <descr/>
 
8795
        <seealso/>
 
8796
      </element>
 
8797
      <element name="TAlignInfo.ControlIndex">
 
8798
        <short>Index of current control.</short>
 
8799
        <descr/>
 
8800
        <seealso/>
 
8801
      <notes><note>in AlignList?</note>
 
8802
        </notes>
 
8803
      </element>
 
8804
      <element name="TAlignInfo.Align">
 
8805
        <short>The kind of alignment currently processed (always alCustom).</short>
 
8806
        <descr/>
 
8807
        <seealso/>
 
8808
      </element>
 
8809
      <element name="TAlignInfo.Scratch">
 
8810
        <short>For internal use.</short>
 
8811
        <descr/>
 
8812
        <seealso/>
 
8813
      </element>
 
8814
      <!-- function type Visibility: default -->
 
8815
      <element name="TAlignInsertBeforeEvent">
 
8816
        <short>Type of an OnAlignInsertBefore handler.</short>
 
8817
        <descr>The handler determines the order, in which both controls are aligned later.
 
8818
        </descr>
 
8819
        <seealso>
 
8820
          <link id="TWinControl.CustomAlignInsertBefore"/>
 
8821
        </seealso>
 
8822
      </element>
 
8823
      <element name="TAlignInsertBeforeEvent.Result">
 
8824
        <short>True if Control2 shall be placed before Control1 is placed.</short>
 
8825
      </element>
 
8826
      <element name="TAlignInsertBeforeEvent.Sender">
 
8827
        <short>The Parent control</short>
 
8828
      <notes><note>?</note>
 
8829
        </notes>
 
8830
      </element>
 
8831
      <element name="TAlignInsertBeforeEvent.Control1">
 
8832
        <short/>
 
8833
      </element>
 
8834
      <element name="TAlignInsertBeforeEvent.Control2">
 
8835
        <short/>
 
8836
      </element>
 
8837
      <!-- procedure type Visibility: default -->
 
8838
      <element name="TAlignPositionEvent">
 
8839
        <short>Type of an OnAlignPosition handler.</short>
 
8840
        <descr>The handler positions Control by changing the given coordinates.
 
8841
        </descr>
 
8842
        <seealso>
 
8843
          <link id="TWinControl.CustomAlignPosition"/>
 
8844
        </seealso>
 
8845
      </element>
 
8846
      <element name="TAlignPositionEvent.Sender">
 
8847
        <short>The Parent control</short>
 
8848
      <notes><note>?</note>
 
8849
        </notes>
 
8850
      </element>
 
8851
      <element name="TAlignPositionEvent.Control">
 
8852
        <short>The control to place.</short>
 
8853
      </element>
 
8854
      <element name="TAlignPositionEvent.NewLeft">
 
8855
        <short/>
 
8856
      </element>
 
8857
      <element name="TAlignPositionEvent.NewTop">
 
8858
        <short/>
 
8859
      </element>
 
8860
      <element name="TAlignPositionEvent.NewWidth">
 
8861
        <short/>
 
8862
      </element>
 
8863
      <element name="TAlignPositionEvent.NewHeight">
 
8864
        <short/>
 
8865
      </element>
 
8866
      <element name="TAlignPositionEvent.AlignRect">
 
8867
        <short>The remaining ClientRect</short>
 
8868
      <notes><note>?</note>
 
8869
        </notes>
 
8870
      </element>
 
8871
      <element name="TAlignPositionEvent.AlignInfo">
 
8872
        <short>Information about the current align process</short>
 
8873
      <notes><note>?</note>
 
8874
        </notes>
 
8875
      </element>
 
8876
      <!-- object Visibility: default -->
 
8877
      <element name="TWinControl">
 
8878
        <short>The base class for controls which can contain other (child) controls.</short>
 
8879
        <descr>The name reflects the fact that (on Windows) these controls are based on OS provided widgets, which have window Handles.
 
8880
        </descr>
 
8881
        <seealso/>
 
8882
      </element>
 
8883
      <!-- variable Visibility: private -->
 
8884
      <element name="TWinControl.FAdjustClientRect">
 
8885
        <short>valid if wcfAdjustClientRectValid</short>
 
8886
        <descr/>
 
8887
        <seealso/>
 
8888
      <notes><note>what?</note>
 
8889
        </notes>
 
8890
      </element>
 
8891
      <!-- variable Visibility: private -->
 
8892
      <element name="TWinControl.FAdjustClientRectRealized">
 
8893
        <short/>
 
8894
        <descr/>
 
8895
        <seealso/>
 
8896
      </element>
 
8897
      <!-- variable Visibility: private -->
 
8898
      <element name="TWinControl.FAlignOrder">
 
8899
        <short/>
 
8900
        <descr/>
 
8901
        <seealso/>
 
8902
      </element>
 
8903
      <!-- variable Visibility: private -->
 
8904
      <element link="TWinControl.BorderStyle" name="TWinControl.FBorderStyle"/>
 
8905
      <element link="TWinControl.BorderWidth" name="TWinControl.FBorderWidth"/>
 
8906
      <element link="TWinControl.BoundsLockCount" name="TWinControl.FBoundsLockCount"/>
 
8907
      <element name="TWinControl.FBoundsRealized">
 
8908
        <short>The bounds as sent to the widget.
 
8909
          Used to suppress according feedback messages from the widget.
 
8910
        </short>
 
8911
      </element>
 
8912
      <element link="TWinControl.Brush" name="TWinControl.FBrush"/>
 
8913
      <element link="TWinControl.ChildSizing" name="TWinControl.FChildSizing"/>
 
8914
      <element link="TWinControl.ClientWidth" name="TWinControl.FClientWidth"/>
 
8915
      <element link="TWinControl.ClientHeight" name="TWinControl.FClientHeight"/>
 
8916
      <element link="TWinControl.Controls" name="TWinControl.FControls"/>
 
8917
      <element link="TWinControl.DefWndProc" name="TWinControl.FDefWndProc"/>
 
8918
      <element link="TWinControl.DockClients" name="TWinControl.FDockClients"/>
 
8919
      <element link="TWinControl.DockManager" name="TWinControl.FDockManager"/>
 
8920
      <element link="TWinControl.DockSite" name="TWinControl.FDockSite"/>
 
8921
      <element link="TWinControl.DoubleBuffered" name="TWinControl.FDoubleBuffered"/>
 
8922
      <element link="TWinControl.Handle" name="TWinControl.FHandle"/>
 
8923
      <element link="TWinControl.OnAlignInsertBefore" name="TWinControl.FOnAlignInsertBefore"/>
 
8924
      <element link="TWinControl.OnAlignPosition" name="TWinControl.FOnAlignPosition"/>
 
8925
      <element link="TWinControl.OnDockDrop" name="TWinControl.FOnDockDrop"/>
 
8926
      <element link="TWinControl.OnDockOver" name="TWinControl.FOnDockOver"/>
 
8927
      <element link="TWinControl.OnEnter" name="TWinControl.FOnEnter"/>
 
8928
      <element link="TWinControl.OnExit" name="TWinControl.FOnExit"/>
 
8929
      <element link="TWinControl.OnGetDockCaption" name="TWinControl.FOnGetDockCaption"/>
 
8930
      <element link="TWinControl.OnGetSiteInfo" name="TWinControl.FOnGetSiteInfo"/>
 
8931
      <element link="TWinControl.OnKeyDown" name="TWinControl.FOnKeyDown"/>
 
8932
      <element link="TWinControl.OnKeyPress" name="TWinControl.FOnKeyPress"/>
 
8933
      <element link="TWinControl.OnKeyUp" name="TWinControl.FOnKeyUp"/>
 
8934
      <element link="TWinControl.OnUnDock" name="TWinControl.FOnUnDock"/>
 
8935
      <element link="TWinControl.OnUTF8KeyPress" name="TWinControl.FOnUTF8KeyPress"/>
 
8936
      <element link="TWinControl.ParentWindow" name="TWinControl.FParentWindow"/>
 
8937
      <!-- variable Visibility: private -->
 
8938
      <element name="TWinControl.FRealizeBoundsLockCount">
 
8939
        <short/>
 
8940
        <descr/>
 
8941
        <seealso/>
 
8942
      </element>
 
8943
      <element link="TWinControl.Showing" name="TWinControl.FShowing"/>
 
8944
      <!-- variable Visibility: private -->
 
8945
      <element name="TWinControl.FTabList">
 
8946
        <short/>
 
8947
        <descr/>
 
8948
        <seealso/>
 
8949
      </element>
 
8950
      <element link="TWinControl.TabOrder" name="TWinControl.FTabOrder"/>
 
8951
      <element link="TWinControl.TabStop" name="TWinControl.FTabStop"/>
 
8952
      <element link="TWinControl.UseDockManager" name="TWinControl.FUseDockManager"/>
 
8953
      <!-- variable Visibility: private -->
 
8954
      <element name="TWinControl.FWinControlFlags">
 
8955
        <short>Various control state flags.</short>
 
8956
        <descr/>
 
8957
        <seealso/>
 
8958
      </element>
 
8959
      <!-- procedure Visibility: private -->
 
8960
      <element name="TWinControl.AlignControl">
 
8961
        <short/>
 
8962
        <descr/>
 
8963
        <errors/>
 
8964
        <seealso/>
 
8965
      </element>
 
8966
      <element name="TWinControl.AlignControl.AControl">
 
8967
        <short/>
 
8968
      </element>
 
8969
      <!-- function Visibility: private -->
 
8970
      <element link="TWinControl.Brush" name="TWinControl.GetBrush"/>
 
8971
      <element name="TWinControl.GetBrush.Result">
 
8972
        <short/>
 
8973
      </element>
 
8974
      <!-- function Visibility: private -->
 
8975
      <element link="TWinControl.Controls" name="TWinControl.GetControl"/>
 
8976
      <element name="TWinControl.GetControl.Result">
 
8977
        <short/>
 
8978
      </element>
 
8979
      <element name="TWinControl.GetControl.Index">
 
8980
        <short/>
 
8981
      </element>
 
8982
      <!-- function Visibility: private -->
 
8983
      <element link="TWinControl.ControlCount" name="TWinControl.GetControlCount"/>
 
8984
      <element name="TWinControl.GetControlCount.Result">
 
8985
        <short/>
 
8986
      </element>
 
8987
      <!-- function Visibility: private -->
 
8988
      <element link="TWinControl.DockClientCount" name="TWinControl.GetDockClientCount"/>
 
8989
      <element name="TWinControl.GetDockClientCount.Result">
 
8990
        <short/>
 
8991
      </element>
 
8992
      <!-- function Visibility: private -->
 
8993
      <element link="TWinControl.DockClients" name="TWinControl.GetDockClients"/>
 
8994
      <element name="TWinControl.GetDockClients.Result">
 
8995
        <short/>
 
8996
      </element>
 
8997
      <element name="TWinControl.GetDockClients.Index">
 
8998
        <short/>
 
8999
      </element>
 
9000
      <!-- function Visibility: private -->
 
9001
      <element link="TWinControl.Handle" name="TWinControl.GetHandle"/>
 
9002
      <element name="TWinControl.GetHandle.Result">
 
9003
        <short/>
 
9004
      </element>
 
9005
      <!-- function Visibility: private -->
 
9006
      <element link="TWinControl.IsResizing" name="TWinControl.GetIsResizing"/>
 
9007
      <element name="TWinControl.GetIsResizing.Result">
 
9008
        <short/>
 
9009
      </element>
 
9010
      <!-- function Visibility: private -->
 
9011
      <element link="TWinControl.TabOrder" name="TWinControl.GetTabOrder"/>
 
9012
      <element name="TWinControl.GetTabOrder.Result">
 
9013
        <short/>
 
9014
      </element>
 
9015
      <!-- function Visibility: private -->
 
9016
      <element name="TWinControl.GetVisibleDockClientCount">
 
9017
        <short/>
 
9018
        <descr/>
 
9019
        <errors/>
 
9020
        <seealso/>
 
9021
      </element>
 
9022
      <element name="TWinControl.GetVisibleDockClientCount.Result">
 
9023
        <short/>
 
9024
      </element>
 
9025
      <!-- procedure Visibility: private -->
 
9026
      <element link="TWinControl.ChildSizing" name="TWinControl.SetChildSizing"/>
 
9027
      <element name="TWinControl.SetChildSizing.AValue">
 
9028
        <short/>
 
9029
      </element>
 
9030
      <!-- procedure Visibility: private -->
 
9031
      <element link="TWinControl.DockSite" name="TWinControl.SetDockSite"/>
 
9032
      <element name="TWinControl.SetDockSite.NewDockSite">
 
9033
        <short/>
 
9034
      </element>
 
9035
      <!-- procedure Visibility: private -->
 
9036
      <element link="TWinControl.Handle" name="TWinControl.SetHandle"/>
 
9037
      <element name="TWinControl.SetHandle.NewHandle">
 
9038
        <short/>
 
9039
      </element>
 
9040
      <!-- procedure Visibility: private -->
 
9041
      <element link="TWinControl.BorderWidth" name="TWinControl.SetBorderWidth"/>
 
9042
      <element name="TWinControl.SetBorderWidth.Value">
 
9043
        <short/>
 
9044
      </element>
 
9045
      <!-- procedure Visibility: private -->
 
9046
      <element link="TWinControl.ParentWindow" name="TWinControl.SetParentWindow"/>
 
9047
      <element name="TWinControl.SetParentWindow.AValue">
 
9048
        <short/>
 
9049
      </element>
 
9050
      <!-- procedure Visibility: private -->
 
9051
      <element link="TWinControl.TabOrder" name="TWinControl.SetTabOrder"/>
 
9052
      <element name="TWinControl.SetTabOrder.NewTabOrder">
 
9053
        <short/>
 
9054
      </element>
 
9055
      <!-- procedure Visibility: private -->
 
9056
      <element link="TWinControl.TabStop" name="TWinControl.SetTabStop"/>
 
9057
      <element name="TWinControl.SetTabStop.NewTabStop">
 
9058
        <short/>
 
9059
      </element>
 
9060
      <!-- procedure Visibility: private -->
 
9061
      <element link="TWinControl.UseDockManager" name="TWinControl.SetUseDockManager"/>
 
9062
      <element name="TWinControl.SetUseDockManager.AValue">
 
9063
        <short/>
 
9064
      </element>
 
9065
      <!-- procedure Visibility: private -->
 
9066
      <element name="TWinControl.UpdateTabOrder">
 
9067
        <short/>
 
9068
        <descr/>
 
9069
        <errors/>
 
9070
        <seealso/>
 
9071
      </element>
 
9072
      <element name="TWinControl.UpdateTabOrder.NewTabOrder">
 
9073
        <short/>
 
9074
      </element>
 
9075
      <!-- function Visibility: private -->
 
9076
      <element name="TWinControl.WantsKeyBeforeInterface">
 
9077
        <short/>
 
9078
        <descr/>
 
9079
        <errors/>
 
9080
        <seealso/>
 
9081
      </element>
 
9082
      <element name="TWinControl.WantsKeyBeforeInterface.Result">
 
9083
        <short/>
 
9084
      </element>
 
9085
      <element name="TWinControl.WantsKeyBeforeInterface.Key">
 
9086
        <short/>
 
9087
      </element>
 
9088
      <element name="TWinControl.WantsKeyBeforeInterface.Shift">
 
9089
        <short/>
 
9090
      </element>
 
9091
      <!-- procedure Visibility: public -->
 
9092
      <element name="TWinControl.Insert">
 
9093
        <short/>
 
9094
        <descr/>
 
9095
        <errors/>
 
9096
        <seealso/>
 
9097
      </element>
 
9098
      <element name="TWinControl.Insert.AControl">
 
9099
        <short/>
 
9100
      </element>
 
9101
      <element name="TWinControl.Insert.Index">
 
9102
        <short/>
 
9103
      </element>
 
9104
      <!-- procedure Visibility: public -->
 
9105
      <element name="TWinControl.Remove">
 
9106
        <short/>
 
9107
        <descr/>
 
9108
        <errors/>
 
9109
        <seealso/>
 
9110
      </element>
 
9111
      <element name="TWinControl.Remove.AControl">
 
9112
        <short/>
 
9113
      </element>
 
9114
      <!-- procedure Visibility: private -->
 
9115
      <element name="TWinControl.AlignNonAlignedControls">
 
9116
        <short/>
 
9117
        <descr/>
 
9118
        <errors/>
 
9119
        <seealso/>
 
9120
      </element>
 
9121
      <element name="TWinControl.AlignNonAlignedControls.ListOfControls">
 
9122
        <short/>
 
9123
      </element>
 
9124
      <element name="TWinControl.AlignNonAlignedControls.BoundsModified">
 
9125
        <short/>
 
9126
      </element>
 
9127
      <element link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass" name="TWinControl.WSRegisterClass"/>
 
9128
      <!-- procedure Visibility: protected -->
 
9129
      <element name="TWinControl.AdjustClientRect">
 
9130
        <short>Override this method when the ClientRect of a control differs from the default value.
 
9131
        </short>
 
9132
        <descr/>It's called often, so don't put expensive code here, or cache the result.
 
9133
        
 
9134
        
 
9135
        <errors/>
 
9136
        <seealso>
 
9137
          <link id="TWinControl.GetAdjustedLogicalClientRect"/>
 
9138
        </seealso>
 
9139
      </element>
 
9140
      <element name="TWinControl.AdjustClientRect.ARect">
 
9141
        <short/>
 
9142
      </element>
 
9143
      <!-- procedure Visibility: protected -->
 
9144
      <element name="TWinControl.GetAdjustedLogicalClientRect">
 
9145
        <short>Returns the adjusted ClientRect, cached value if available.
 
9146
        </short>
 
9147
        <descr/>
 
9148
        <errors/>
 
9149
        <seealso>
 
9150
          <link id="TControl.ClientRect"/>
 
9151
          <link id="TWinControl.AdjustClientRect"/>
 
9152
          <link id="TWinControlFlag.wcfAdjustedLogicalClientRectValid"/>
 
9153
        </seealso>
 
9154
      </element>
 
9155
      <element name="TWinControl.GetAdjustedLogicalClientRect.ARect">
 
9156
        <short/>
 
9157
      </element>
 
9158
      <!-- procedure Visibility: protected -->
 
9159
      <element name="TWinControl.CreateControlAlignList">
 
9160
        <short>Fills the list with the controls which must be realigned.
 
9161
        </short>
 
9162
        <descr>The list is initialized with all child controls,
 
9163
          which have the given alignment and are visible.
 
9164
        </descr>
 
9165
        <errors/>
 
9166
        <seealso>
 
9167
          <link id="TWinControl.AlignControls"/>
 
9168
        </seealso>
 
9169
      </element>
 
9170
      <element name="TWinControl.CreateControlAlignList.TheAlign">
 
9171
        <short>List all controls with this alignment.</short>
 
9172
      </element>
 
9173
      <element name="TWinControl.CreateControlAlignList.AlignList">
 
9174
        <short/>
 
9175
      </element>
 
9176
      <element name="TWinControl.CreateControlAlignList.StartControl">
 
9177
        <short/>
 
9178
      </element>
 
9179
      <!-- procedure Visibility: protected -->
 
9180
      <element name="TWinControl.AlignControls">
 
9181
        <short>Aligns all child controls.</short>
 
9182
        <descr/>
 
9183
        <errors/>
 
9184
        <seealso>
 
9185
          <link id="TWinControlFlag.wcfAligningControls"/>
 
9186
        </seealso>
 
9187
      </element>
 
9188
      <element name="TWinControl.AlignControls.AControl">
 
9189
        <short/>
 
9190
      <notes><note>?</note>
 
9191
        </notes>
 
9192
      </element>
 
9193
      <element name="TWinControl.AlignControls.RemainingClientRect">
 
9194
        <short>The available space, becomes remaining space on exit.</short>
 
9195
      </element>
 
9196
      <element name="TWinControl.CustomAlignInsertBefore">
 
9197
        <short>Returns the placement order of custom-aligned child controls, using
 
9198
          the <var>OnAlignInsertBefore</var> handler.</short>
 
9199
        <seealso>
 
9200
          <link id="TAlignInsertBeforeEvent"/>
 
9201
        </seealso>
 
9202
      </element>
 
9203
      <element name="TWinControl.CustomAlignInsertBefore.Result">
 
9204
        <short>True if Control2 shall be placed before Control1 is placed.</short>
 
9205
      </element>
 
9206
      <element name="TWinControl.CustomAlignInsertBefore.AControl1">
 
9207
        <short/>
 
9208
      </element>
 
9209
      <element name="TWinControl.CustomAlignInsertBefore.AControl2">
 
9210
        <short/>
 
9211
      </element>
 
9212
      <element name="TWinControl.CustomAlignPosition">
 
9213
        <short>Returns the aligned position of a custom-aligned child control,
 
9214
          using the <var>OnAlignPosition</var> handler.</short>
 
9215
        <descr>
 
9216
          <p>The given coordinates take into account the anchoring of AControl.
 
9217
          </p>
 
9218
          <p>The handler updates the coordinates as required.
 
9219
          </p>
 
9220
        </descr>
 
9221
        <seealso>
 
9222
          <link id="TAlignInsertBeforeEvent"/>
 
9223
        </seealso>
 
9224
      </element>
 
9225
      <element name="TWinControl.CustomAlignPosition.AControl">
 
9226
        <short>The control to be placed.</short>
 
9227
      </element>
 
9228
      <element name="TWinControl.CustomAlignPosition.ANewLeft">
 
9229
        <short/>
 
9230
      </element>
 
9231
      <element name="TWinControl.CustomAlignPosition.ANewTop">
 
9232
        <short/>
 
9233
      </element>
 
9234
      <element name="TWinControl.CustomAlignPosition.ANewWidth">
 
9235
        <short/>
 
9236
      </element>
 
9237
      <element name="TWinControl.CustomAlignPosition.ANewHeight">
 
9238
        <short/>
 
9239
      </element>
 
9240
      <element name="TWinControl.CustomAlignPosition.AlignRect">
 
9241
        <short>The remaining client area, within which the control can be placed.</short>
 
9242
      <notes><note>?</note>
 
9243
        </notes>
 
9244
      </element>
 
9245
      <element name="TWinControl.CustomAlignPosition.AlignInfo">
 
9246
        <short>Information about the current align process</short>
 
9247
      <notes><note>?</note>
 
9248
        </notes>
 
9249
      </element>
 
9250
      <!-- function Visibility: protected -->
 
9251
      <element name="TWinControl.DoAlignChildControls">
 
9252
        <short>Override this method to place all given controls.
 
9253
        </short>
 
9254
        <descr/>
 
9255
        <errors/>
 
9256
        <seealso>
 
9257
          <link id="TWinControl.AlignControls"/>
 
9258
        </seealso>
 
9259
      </element>
 
9260
      <element name="TWinControl.DoAlignChildControls.Result">
 
9261
        <short>True when all controls have been placed.</short>
 
9262
      </element>
 
9263
      <element name="TWinControl.DoAlignChildControls.TheAlign">
 
9264
        <short>The alignment of all given controls.</short>
 
9265
      </element>
 
9266
      <element name="TWinControl.DoAlignChildControls.AControl">
 
9267
        <short/>
 
9268
      </element>
 
9269
      <element name="TWinControl.DoAlignChildControls.AControlList">
 
9270
        <short>The controls to be placed.</short>
 
9271
      </element>
 
9272
      <element name="TWinControl.DoAlignChildControls.ARect">
 
9273
        <short/>
 
9274
      </element>
 
9275
      <!-- procedure Visibility: protected -->
 
9276
      <element name="TWinControl.DoChildSizingChange">
 
9277
        <short>Call this after a change in the ChildSizing information, to trigger further processing.
 
9278
        </short>
 
9279
        <descr/>
 
9280
        <errors/>
 
9281
        <seealso/>
 
9282
      </element>
 
9283
      <element name="TWinControl.DoChildSizingChange.Sender">
 
9284
        <short/>
 
9285
      </element>
 
9286
      <element name="TWinControl.InvalidatePreferredChildSizes">
 
9287
        <short>Flags the preferred sizes of all child controls as invalid (recursively).</short>
 
9288
        <seealso>
 
9289
          <link id="TControlFlag.cfPreferredSizeValid"/>
 
9290
          <link id="TControlFlag.cfPreferredMinSizeValid"/>
 
9291
          <link id="TWinControlFlag.wcfAdjustedLogicalClientRectValid"/>
 
9292
        </seealso>
 
9293
      </element>
 
9294
      <!-- function Visibility: protected -->
 
9295
      <element link="#LCL.Controls.TControl.CanTab" name="TWinControl.CanTab"/>
 
9296
      <element name="TWinControl.CanTab.Result">
 
9297
        <short/>
 
9298
      </element>
 
9299
      <!-- function Visibility: private -->
 
9300
      <element link="TControl.ClientHeight" name="TWinControl.IsClientHeightStored"/>
 
9301
      <element name="TWinControl.IsClientHeightStored.Result">
 
9302
        <short/>
 
9303
      </element>
 
9304
      <!-- function Visibility: private -->
 
9305
      <element link="TControl.ClientWidth" name="TWinControl.IsClientWidthStored"/>
 
9306
      <element name="TWinControl.IsClientWidthStored.Result">
 
9307
        <short/>
 
9308
      </element>
 
9309
      <!-- procedure Visibility: protected -->
 
9310
      <element name="TWinControl.DoSendShowHideToInterface">
 
9311
        <short>Sends the new Visible state to the widgetset.</short>
 
9312
        <descr>Called by TWinControl.CMShowingChanged.</descr>
 
9313
        <errors/>
 
9314
        <seealso/>
 
9315
      </element>
 
9316
      <!-- procedure Visibility: protected -->
 
9317
      <element name="TWinControl.ControlsAligned">
 
9318
        <short>Called by AlignControls after aligning controls.</short>
 
9319
        <descr>
 
9320
        </descr>
 
9321
        <errors/>
 
9322
        <seealso/>
 
9323
      <notes><note>to do what?</note>
 
9324
        </notes>
 
9325
      </element>
 
9326
      <!-- procedure Visibility: protected -->
 
9327
      <element name="TWinControl.DoSendBoundsToInterface">
 
9328
        <short>Sends the control's new bounds to the widget.</short>
 
9329
        <descr>Called by RealizeBounds.
 
9330
        </descr>
 
9331
        <errors/>
 
9332
        <seealso>
 
9333
          <link id="TWinControlFlag.wcfBoundsRealized"/>
 
9334
        </seealso>
 
9335
      </element>
 
9336
      <!-- procedure Visibility: protected -->
 
9337
      <element name="TWinControl.RealizeBounds">
 
9338
        <short>Checks for BoundsRect changes and sends changed bounds to the widget, using DoSendBoundsToInterface.</short>
 
9339
        <descr/>
 
9340
        <errors/>
 
9341
        <seealso/>
 
9342
      </element>
 
9343
      <!-- procedure Visibility: protected -->
 
9344
      <element name="TWinControl.RealizeBoundsRecursive">
 
9345
        <short>Sends eventually changed BoundsRects to the widgets, for this and all child controls.
 
9346
        </short>
 
9347
        <descr/>
 
9348
        <errors/>
 
9349
        <seealso>
 
9350
          <link id="TWinControl.RealizeBounds"/>
 
9351
          <link id="TWinControlFlag.wcfRealizingBounds"/>
 
9352
        </seealso>
 
9353
      </element>
 
9354
      <!-- procedure Visibility: protected -->
 
9355
      <element name="TWinControl.CreateSubClass">
 
9356
        <short>TODO: Check if we need this method
 
9357
        </short>
 
9358
        <descr/>
 
9359
        <errors/>
 
9360
        <seealso/>
 
9361
      <notes><note>?</note>
 
9362
        </notes>
 
9363
      </element>
 
9364
      <element name="TWinControl.CreateSubClass.Params">
 
9365
        <short/>
 
9366
      </element>
 
9367
      <element name="TWinControl.CreateSubClass.ControlClassName">
 
9368
        <short/>
 
9369
      </element>
 
9370
      <!-- procedure Visibility: protected -->
 
9371
      <element link="TControl.DoConstraintsChange" name="TWinControl.DoConstraintsChange"/>
 
9372
      <element name="TWinControl.DoConstraintsChange.Sender">
 
9373
        <short/>
 
9374
      </element>
 
9375
      <!-- procedure Visibility: protected -->
 
9376
      <element name="TWinControl.DoSetBounds">
 
9377
        <short>Updates the size and extent of the control and ClientRect.
 
9378
        </short>
 
9379
        <descr>
 
9380
          <p>Changing the ClientRect here, to the most probable size, reduces unneccessary resizes.
 
9381
          </p>
 
9382
          <p>Normally the clientwidth/clientheight is adjusted automatically by the widget,
 
9383
            but it is up to widget when this will be done.
 
9384
            The gtk for example just puts resize requests into a queue.
 
9385
            The LCL would resize the child components just after this procedure due to the clientrect.
 
9386
            On complex forms with lots of nested controls, this would result in thousands of resizes.
 
9387
          </p>
 
9388
        </descr>
 
9389
        <seealso>
 
9390
          <link id="#LCL.Controls.TControl.DoSetBounds"/>
 
9391
        </seealso>
 
9392
      </element>
 
9393
      <element name="TWinControl.DoSetBounds.ALeft">
 
9394
        <short/>
 
9395
      </element>
 
9396
      <element name="TWinControl.DoSetBounds.ATop">
 
9397
        <short/>
 
9398
      </element>
 
9399
      <element name="TWinControl.DoSetBounds.AWidth">
 
9400
        <short/>
 
9401
      </element>
 
9402
      <element name="TWinControl.DoSetBounds.AHeight">
 
9403
        <short/>
 
9404
      </element>
 
9405
      <!-- procedure Visibility: protected -->
 
9406
      <element name="TWinControl.DoAutoSize">
 
9407
        <short>Shrink or enlarge the control to fit children.
 
9408
        </short>
 
9409
        <descr>
 
9410
          <p>Because this method is frequently overridden,
 
9411
            the LCL calls the added <link id="TControl.AdjustSize"/> instead,
 
9412
            which checks whether DoAutoSize really should be called right now.
 
9413
          </p>
 
9414
          <p>DoAutoSize does roughly this:
 
9415
          </p>
 
9416
          <ul>
 
9417
            <li>Checks whether Autosize is in fact permitted</li>
 
9418
            <li>Checks for unaligned child components and fits them in as best it can</li>
 
9419
            <li>Moves the constrained (aligned) child components to the correct position</li>
 
9420
            <li>Adjusts the size of the client rectangle</li>
 
9421
            <li>Adjusts the bounds of the whole control</li>
 
9422
          </ul>
 
9423
        </descr>
 
9424
        <errors/>
 
9425
        <seealso>
 
9426
          <link id="TControl.DoAutoSize"/>
 
9427
        </seealso>
 
9428
      </element>
 
9429
      <!-- procedure Visibility: protected -->
 
9430
      <element link="TControl.DoAllAutoSize" name="TWinControl.DoAllAutoSize"/>
 
9431
      <!-- function Visibility: protected -->
 
9432
      <element name="TWinControl.AutoSizeCanStart">
 
9433
        <short>Deprecated, don't use it.</short>
 
9434
      </element>
 
9435
      <element name="TWinControl.AutoSizeCanStart.Result">
 
9436
        <short/>
 
9437
      </element>
 
9438
      <!-- procedure Visibility: protected -->
 
9439
      <element name="TWinControl.AllAutoSized">
 
9440
        <short>Called by DoAllAutoSize after all bounds are computed.</short>
 
9441
        <descr/>
 
9442
        <errors/>
 
9443
        <seealso>
 
9444
          <link id="#lcl.forms.TCustomForm.AllAutoSized"/>
 
9445
        </seealso>
 
9446
      </element>
 
9447
      <!-- procedure Visibility: protected -->
 
9448
      <element name="TWinControl.CalculatePreferredSize">
 
9449
        <short>Override this method to return a different preferred height and width for autosizing.
 
9450
        </short>
 
9451
        <descr>
 
9452
          <p>Calls the inherited method to calculate the default/preferred width and height for a <var>TWinControl</var>, which is used by the LCL autosizing algorithms as default size.
 
9453
            Only positive values are valid. Negative or 0 are treated as undefined and the LCL uses other sizes instead.</p>
 
9454
          <p>
 
9455
            <var>TWinControl</var> overrides this:</p>
 
9456
          <ul>
 
9457
            <li>If there are child components, their total preferred size is calculated</li>
 
9458
            <li>If this value can not be computed (e.g. the children depend too much on their
 
9459
              parent clientrect), then the interface is asked for the preferred size</li>
 
9460
          </ul>
 
9461
          <p>For example the preferred size of a <var>TButton</var> is the size, where the label fits
 
9462
            exactly. This depends heavily on the current theme and widgetset.</p>
 
9463
          <p>This value is independent of constraints and siblings, only the inner parts are relevant.</p>
 
9464
          <p>
 
9465
            <var>WithThemeSpace</var>: If true, adds space for stacking. For example:
 
9466
            
 
9467
            
 
9468
            <var>TRadioButton</var> has a minimum size. But for stacking multiple TRadioButtons there should be some space around.
 
9469
            This space is theme dependent, so it is passed as a parameter to the widgetset. </p>
 
9470
        </descr>
 
9471
        <errors/>
 
9472
        <seealso>
 
9473
          <link id="TControl.CalculatePreferredSize"/>
 
9474
        </seealso>
 
9475
      </element>
 
9476
      <element name="TWinControl.CalculatePreferredSize.PreferredWidth">
 
9477
        <short/>
 
9478
      </element>
 
9479
      <element name="TWinControl.CalculatePreferredSize.PreferredHeight">
 
9480
        <short/>
 
9481
      </element>
 
9482
      <element name="TWinControl.CalculatePreferredSize.WithThemeSpace">
 
9483
        <short/>
 
9484
      </element>
 
9485
      <!-- procedure Visibility: protected -->
 
9486
      <element name="TWinControl.GetChildren">
 
9487
        <short>Calls Proc with every child control, owned by Root.
 
9488
        </short>
 
9489
        <descr/>
 
9490
        <errors/>
 
9491
        <seealso>
 
9492
          <link id="#rtl.Classes.TComponent.GetChildren">TComponent.GetChildren</link>
 
9493
        </seealso>
 
9494
      </element>
 
9495
      <element name="TWinControl.GetChildren.Proc">
 
9496
        <short>The callback procedure.</short>
 
9497
      </element>
 
9498
      <element name="TWinControl.GetChildren.Root">
 
9499
        <short>The Owner of the reported controls.</short>
 
9500
      </element>
 
9501
      <!-- function Visibility: protected -->
 
9502
      <element name="TWinControl.ChildClassAllowed">
 
9503
        <short>Returns True if the given class is allowed for child controls.</short>
 
9504
        <descr/>
 
9505
        <errors/>
 
9506
        <seealso/>
 
9507
      </element>
 
9508
      <element name="TWinControl.ChildClassAllowed.Result">
 
9509
        <short/>
 
9510
      </element>
 
9511
      <element name="TWinControl.ChildClassAllowed.ChildClass">
 
9512
        <short/>
 
9513
      </element>
 
9514
      <!-- procedure Visibility: protected -->
 
9515
      <element name="TWinControl.PaintControls">
 
9516
        <short>Paint all child controls which don't have a Handle.
 
9517
        </short>
 
9518
        <descr>Controls that are not TWinControl, have no handle of their own,
 
9519
          and so they are repainted as part of the parent.
 
9520
        </descr>
 
9521
        <errors/>
 
9522
        <seealso/>
 
9523
      </element>
 
9524
      <element name="TWinControl.PaintControls.DC">
 
9525
        <short>The device context usable for painting child controls.</short>
 
9526
      </element>
 
9527
      <element name="TWinControl.PaintControls.First">
 
9528
        <short>First of the controls in Controls[], which remain to paint.
 
9529
        </short>
 
9530
      </element>
 
9531
      <!-- procedure Visibility: protected -->
 
9532
      <element name="TWinControl.PaintHandler">
 
9533
        <short>Handler for TLMPaint, manages the painting of child controls.
 
9534
         </short>
 
9535
        <descr/>
 
9536
        <errors/>
 
9537
        <seealso/>
 
9538
      </element>
 
9539
      <element name="TWinControl.PaintHandler.TheMessage">
 
9540
        <short/>
 
9541
      </element>
 
9542
      <!-- procedure Visibility: protected -->
 
9543
      <element name="TWinControl.PaintWindow">
 
9544
        <short>Paints an clipped part (child control) of the DC.
 
9545
        </short>
 
9546
        <descr/>
 
9547
        <errors/>
 
9548
        <seealso/>
 
9549
      </element>
 
9550
      <element name="TWinControl.PaintWindow.DC">
 
9551
        <short/>
 
9552
      </element>
 
9553
      <!-- procedure Visibility: protected -->
 
9554
      <element name="TWinControl.CreateBrush">
 
9555
        <short>Creates the <link id="#lcl.Controls.TWinControl.Brush">Brush</link>, if not already created.
 
9556
        </short>
 
9557
        <descr/>
 
9558
        <errors/>
 
9559
        <seealso/>
 
9560
      </element>
 
9561
      <!-- procedure Visibility: protected -->
 
9562
      <element name="TWinControl.ScaleControls">
 
9563
        <short>Scales (resizes) all child controls.</short>
 
9564
        <descr/>
 
9565
        <errors/>
 
9566
        <seealso>
 
9567
          <link id="TWinControl.ChangeScale"/>
 
9568
        </seealso>
 
9569
      </element>
 
9570
      <element name="TWinControl.ScaleControls.Multiplier">
 
9571
        <short/>
 
9572
      </element>
 
9573
      <element name="TWinControl.ScaleControls.Divider">
 
9574
        <short/>
 
9575
      </element>
 
9576
      <!-- procedure Visibility: protected -->
 
9577
      <element link="TControl.ChangeScale" name="TWinControl.ChangeScale">
 
9578
        <short>Scales (resizes) the control and all child controls.
 
9579
        </short>
 
9580
        <descr/>
 
9581
        <errors/>
 
9582
        <seealso/>
 
9583
      </element>
 
9584
      <element name="TWinControl.ChangeScale.Multiplier">
 
9585
        <short/>
 
9586
      </element>
 
9587
      <element name="TWinControl.ChangeScale.Divider">
 
9588
        <short/>
 
9589
      </element>
 
9590
      <!-- procedure Visibility: protected -->
 
9591
      <element name="TWinControl.CMBiDiModeChanged">
 
9592
        <short>Handler for
 
9593
          changed <link id="#lcl.Controls.TControl.BiDiMode">BiDiMode</link>
 
9594
          message.
 
9595
          Notifies the widget and all child controls.
 
9596
        </short>
 
9597
        <descr/>
 
9598
        <errors/>
 
9599
        <seealso/>
 
9600
      </element>
 
9601
      <element name="TWinControl.CMBiDiModeChanged.Message">
 
9602
        <short/>
 
9603
      </element>
 
9604
      <!-- procedure Visibility: protected -->
 
9605
      <element name="TWinControl.CMBorderChanged">
 
9606
        <short>Handler for
 
9607
          changed Border properties
 
9608
          message.
 
9609
          Adjusts and invalidates the control.
 
9610
        </short>
 
9611
      </element>
 
9612
      <element name="TWinControl.CMBorderChanged.Message">
 
9613
        <short/>
 
9614
      </element>
 
9615
      <!-- procedure Visibility: protected -->
 
9616
      <element name="TWinControl.CMEnabledChanged">
 
9617
        <short>Handler for
 
9618
          changed <link id="#lcl.Controls.TControl.Enabled">Enabled</link>
 
9619
          message.
 
9620
          Notifies the widgetset.
 
9621
        </short>
 
9622
        <descr/>
 
9623
        <errors/>
 
9624
        <seealso/>
 
9625
      </element>
 
9626
      <element name="TWinControl.CMEnabledChanged.Message">
 
9627
        <short/>
 
9628
      </element>
 
9629
      <!-- procedure Visibility: protected -->
 
9630
      <element name="TWinControl.CMShowingChanged">
 
9631
        <short>Handler for
 
9632
          changed <link id="TWinControl.Showing">Showing</link>
 
9633
          message.
 
9634
          Notifies the widgetset.
 
9635
        </short>
 
9636
        <descr/>
 
9637
        <errors/>
 
9638
        <seealso/>
 
9639
      </element>
 
9640
      <element name="TWinControl.CMShowingChanged.Message">
 
9641
        <short/>
 
9642
      </element>
 
9643
      <!-- procedure Visibility: protected -->
 
9644
      <element name="TWinControl.CMShowHintChanged">
 
9645
        <short>Handler for
 
9646
          changed <link id="TWinControl.ShowHint">ShowHint</link>
 
9647
          message.
 
9648
          Notifies all child controls.
 
9649
        </short>
 
9650
        <descr/>
 
9651
        <errors/>
 
9652
        <seealso/>
 
9653
      </element>
 
9654
      <element name="TWinControl.CMShowHintChanged.Message">
 
9655
        <short/>
 
9656
      </element>
 
9657
      <!-- procedure Visibility: protected -->
 
9658
      <element name="TWinControl.CMVisibleChanged">
 
9659
        <short>Handler for
 
9660
          changed <link id="#lcl.Controls.TControl.Visible">Visible</link>
 
9661
          message.
 
9662
          Handles Focus, forces UpdateControlState.
 
9663
        </short>
 
9664
        <descr/>
 
9665
        <errors/>
 
9666
        <seealso/>
 
9667
      </element>
 
9668
      <element name="TWinControl.CMVisibleChanged.Message">
 
9669
        <short/>
 
9670
      </element>
 
9671
      <!-- procedure Visibility: protected -->
 
9672
      <element name="TWinControl.CMEnter">
 
9673
        <short/>
 
9674
        <descr/>
 
9675
        <errors/>
 
9676
        <seealso/>
 
9677
      <notes><note>?</note>
 
9678
        </notes>
 
9679
      </element>
 
9680
      <element name="TWinControl.CMEnter.Message">
 
9681
        <short/>
 
9682
      </element>
 
9683
      <!-- procedure Visibility: protected -->
 
9684
      <element name="TWinControl.CMExit">
 
9685
        <short/>
 
9686
        <descr/>
 
9687
        <errors/>
 
9688
        <seealso/>
 
9689
      <notes><note>?</note>
 
9690
        </notes>
 
9691
      </element>
 
9692
      <element name="TWinControl.CMExit.Message">
 
9693
        <short/>
 
9694
      </element>
 
9695
      <!-- procedure Visibility: protected -->
 
9696
      <element name="TWinControl.WMContextMenu">
 
9697
        <short>Handler for an
 
9698
          <link id="TControl.PopupMenu">ContextMenu</link> event.
 
9699
          Eventually delegates handling to the affected child control.
 
9700
        </short>
 
9701
        <descr/>
 
9702
        <errors/>
 
9703
        <seealso/>
 
9704
      </element>
 
9705
      <element name="TWinControl.WMContextMenu.Message">
 
9706
        <short/>
 
9707
      </element>
 
9708
      <!-- procedure Visibility: protected -->
 
9709
      <element name="TWinControl.WMEraseBkgnd">
 
9710
        <short>Erases the background,
 
9711
          if <link id="TWinControlFlag.wcfEraseBackground">required</link>.
 
9712
        </short>
 
9713
        <descr/>
 
9714
        <errors/>
 
9715
        <seealso/>
 
9716
      </element>
 
9717
      <element name="TWinControl.WMEraseBkgnd.Message">
 
9718
        <short/>
 
9719
      </element>
 
9720
      <!-- procedure Visibility: protected -->
 
9721
      <element name="TWinControl.WMNotify">
 
9722
        <short>Handles (dispatches) notification messages.
 
9723
        </short>
 
9724
        <descr/>
 
9725
        <errors/>
 
9726
        <seealso/>
 
9727
      </element>
 
9728
      <element name="TWinControl.WMNotify.Message">
 
9729
        <short/>
 
9730
      </element>
 
9731
      <!-- procedure Visibility: protected -->
 
9732
      <element name="TWinControl.WMSetFocus">
 
9733
        <short>Handler for receiving Focus event.</short>
 
9734
        <descr/>
 
9735
        <errors/>
 
9736
        <seealso/>
 
9737
      <notes><note>do what?</note>
 
9738
        </notes>
 
9739
      </element>
 
9740
      <element name="TWinControl.WMSetFocus.Message">
 
9741
        <short/>
 
9742
      </element>
 
9743
      <!-- procedure Visibility: protected -->
 
9744
      <element name="TWinControl.WMKillFocus">
 
9745
        <short>Handler for
 
9746
          loosing Focus
 
9747
          event.
 
9748
          Eventually triggers <link id="#lcl.Controls.TControl.EditingDone"/>.
 
9749
        </short>
 
9750
        <descr/>
 
9751
        <errors/>
 
9752
        <seealso/>
 
9753
      </element>
 
9754
      <element name="TWinControl.WMKillFocus.Message">
 
9755
        <short/>
 
9756
      </element>
 
9757
      <!-- procedure Visibility: protected -->
 
9758
      <element name="TWinControl.WMShowWindow">
 
9759
        <short>Handler for changed visibility notification
 
9760
        </short>
 
9761
        <descr/>
 
9762
        <errors/>
 
9763
        <seealso/>
 
9764
      <notes><note>?</note>
 
9765
        </notes>
 
9766
      </element>
 
9767
      <element name="TWinControl.WMShowWindow.Message">
 
9768
        <short/>
 
9769
      </element>
 
9770
      <!-- procedure Visibility: protected -->
 
9771
      <element name="TWinControl.WMEnter">
 
9772
        <short/>
 
9773
        <descr/>
 
9774
        <errors/>
 
9775
        <seealso/>
 
9776
      <notes><note>?</note>
 
9777
        </notes>
 
9778
      </element>
 
9779
      <element name="TWinControl.WMEnter.Message">
 
9780
        <short/>
 
9781
      </element>
 
9782
      <!-- procedure Visibility: protected -->
 
9783
      <element name="TWinControl.WMExit">
 
9784
        <short/>
 
9785
        <descr/>
 
9786
        <errors/>
 
9787
        <seealso/>
 
9788
      <notes><note>?</note>
 
9789
        </notes>
 
9790
      </element>
 
9791
      <element name="TWinControl.WMExit.Message">
 
9792
        <short/>
 
9793
      </element>
 
9794
      <!-- procedure Visibility: protected -->
 
9795
      <element name="TWinControl.WMKeyDown">
 
9796
        <short>Event handler for key pressed, not handled by the widget.
 
9797
          Tries <link id="TWinControl.DoRemainingKeyDown"/>.
 
9798
        </short>
 
9799
        <descr/>
 
9800
        <errors/>
 
9801
        <seealso/>
 
9802
      </element>
 
9803
      <element name="TWinControl.WMKeyDown.Message">
 
9804
        <short/>
 
9805
      </element>
 
9806
      <!-- procedure Visibility: protected -->
 
9807
      <element name="TWinControl.WMSysKeyDown">
 
9808
        <short>Event handler for sys key pressed, not handled by the widget.
 
9809
          Tries <link id="TWinControl.DoRemainingKeyDown"/>.
 
9810
        </short>
 
9811
        <descr/>
 
9812
        <errors/>
 
9813
        <seealso/>
 
9814
      <notes><note>what's this?</note>
 
9815
        </notes>
 
9816
      </element>
 
9817
      <element name="TWinControl.WMSysKeyDown.Message">
 
9818
        <short/>
 
9819
      </element>
 
9820
      <!-- procedure Visibility: protected -->
 
9821
      <element name="TWinControl.WMKeyUp">
 
9822
        <short>Event handler for
 
9823
          key released, not handled by the widget.
 
9824
          Tries <link id="TWinControl.DoRemainingKeyUp"/>.
 
9825
        </short>
 
9826
        <descr/>
 
9827
        <errors/>
 
9828
        <seealso/>
 
9829
      </element>
 
9830
      <element name="TWinControl.WMKeyUp.Message">
 
9831
        <short/>
 
9832
      </element>
 
9833
      <!-- procedure Visibility: protected -->
 
9834
      <element name="TWinControl.WMSysKeyUp">
 
9835
        <short>Event handler for
 
9836
          system key released, not handled by the widget.
 
9837
          Tries <link id="TWinControl.DoRemainingKeyUp"/>.
 
9838
        </short>
 
9839
        <descr/>
 
9840
        <errors/>
 
9841
        <seealso/>
 
9842
      </element>
 
9843
      <element name="TWinControl.WMSysKeyUp.Message">
 
9844
        <short/>
 
9845
      </element>
 
9846
      <!-- procedure Visibility: protected -->
 
9847
      <element name="TWinControl.WMChar">
 
9848
        <short>Handler for
 
9849
          message sent by the widget, after it has handled the keypress itself.
 
9850
        </short>
 
9851
        <descr/>
 
9852
        <errors/>
 
9853
        <seealso/>
 
9854
      </element>
 
9855
      <element name="TWinControl.WMChar.Message">
 
9856
        <short/>
 
9857
      </element>
 
9858
      <!-- procedure Visibility: protected -->
 
9859
      <element name="TWinControl.WMSysChar">
 
9860
        <short>Handler for
 
9861
          message sent by the widget, after it has handled the keypress itself.
 
9862
        </short>
 
9863
        <descr/>
 
9864
        <errors/>
 
9865
        <seealso/>
 
9866
      </element>
 
9867
      <element name="TWinControl.WMSysChar.Message">
 
9868
        <short/>
 
9869
      </element>
 
9870
      <!-- procedure Visibility: protected -->
 
9871
      <element name="TWinControl.WMPaint">
 
9872
        <short>Manages paint requests, handles double buffering.
 
9873
        </short>
 
9874
        <descr/>
 
9875
        <errors/>
 
9876
        <seealso/>
 
9877
      </element>
 
9878
      <element name="TWinControl.WMPaint.Msg">
 
9879
        <short/>
 
9880
      </element>
 
9881
      <!-- procedure Visibility: protected -->
 
9882
      <element name="TWinControl.WMDestroy">
 
9883
        <short>Handler for
 
9884
          widget destroyed message. Clears the Handle.
 
9885
        </short>
 
9886
        <descr/>
 
9887
        <errors/>
 
9888
        <seealso/>
 
9889
      </element>
 
9890
      <element name="TWinControl.WMDestroy.Message">
 
9891
        <short/>
 
9892
      </element>
 
9893
      <!-- procedure Visibility: protected -->
 
9894
      <element name="TWinControl.WMMove">
 
9895
        <short>Handler for
 
9896
          widget moved message. Updates the Bounds.
 
9897
        </short>
 
9898
        <descr/>
 
9899
        <errors/>
 
9900
        <seealso/>
 
9901
      </element>
 
9902
      <element name="TWinControl.WMMove.Message">
 
9903
        <short/>
 
9904
      </element>
 
9905
      <!-- procedure Visibility: protected -->
 
9906
      <element name="TWinControl.WMSize">
 
9907
        <short>Event handler for size messages.
 
9908
        </short>
 
9909
        <descr>
 
9910
          <p>This method is called whenever width, height, clientwidth or clientheight have changed.
 
9911
          </p>
 
9912
          <p>If the source of the message is the interface, the new size is stored
 
9913
            in FBoundsRealized to avoid sending a size message back to the interface.
 
9914
          </p>
 
9915
        </descr>
 
9916
        <errors/>
 
9917
        <seealso/>
 
9918
      </element>
 
9919
      <element name="TWinControl.WMSize.Message">
 
9920
        <short/>
 
9921
      </element>
 
9922
      <!-- procedure Visibility: protected -->
 
9923
      <element name="TWinControl.WMWindowPosChanged">
 
9924
        <short>Event handler for size/move messages.
 
9925
        </short>
 
9926
        <descr>
 
9927
          <p>This method is called whenever left, top, width, height, clientwidth or clientheight have changed.
 
9928
          </p>
 
9929
          <p>If the source of the message is the interface, the new size is stored
 
9930
            in FBoundsRealized to avoid sending a size message back to the interface.
 
9931
          </p>
 
9932
        </descr>
 
9933
        <errors/>
 
9934
        <seealso/>
 
9935
      </element>
 
9936
      <element name="TWinControl.WMWindowPosChanged.Message">
 
9937
        <short/>
 
9938
      </element>
 
9939
      <!-- procedure Visibility: protected -->
 
9940
      <element name="TWinControl.CNKeyDown">
 
9941
        <short>Handler for
 
9942
          a key pushed notification.
 
9943
          The message is handled by DoKeyDownBeforeInterface by default.
 
9944
        </short>
 
9945
        <descr/>
 
9946
        <errors/>
 
9947
        <seealso/>
 
9948
      </element>
 
9949
      <element name="TWinControl.CNKeyDown.Message">
 
9950
        <short/>
 
9951
      </element>
 
9952
      <!-- procedure Visibility: protected -->
 
9953
      <element name="TWinControl.CNSysKeyDown">
 
9954
        <short>Handler for
 
9955
          a system key pushed notification.
 
9956
          The message is handled by DoKeyDownBeforeInterface by default.
 
9957
        </short>
 
9958
        <descr/>
 
9959
        <errors/>
 
9960
        <seealso/>
 
9961
      </element>
 
9962
      <element name="TWinControl.CNSysKeyDown.Message">
 
9963
        <short/>
 
9964
      </element>
 
9965
      <!-- procedure Visibility: protected -->
 
9966
      <element name="TWinControl.CNKeyUp">
 
9967
        <short>Handler for
 
9968
          a key released notification.
 
9969
          The message is handled by DoKeyUpBeforeInterface by default.
 
9970
        </short>
 
9971
        <descr/>
 
9972
        <errors/>
 
9973
        <seealso/>
 
9974
      </element>
 
9975
      <element name="TWinControl.CNKeyUp.Message">
 
9976
        <short/>
 
9977
      </element>
 
9978
      <!-- procedure Visibility: protected -->
 
9979
      <element name="TWinControl.CNSysKeyUp">
 
9980
        <short>Handler for
 
9981
          a system key released notification.
 
9982
          The message is handled by DoKeyUpBeforeInterface by default.
 
9983
        </short>
 
9984
        <descr/>
 
9985
        <errors/>
 
9986
        <seealso/>
 
9987
      </element>
 
9988
      <element name="TWinControl.CNSysKeyUp.Message">
 
9989
        <short/>
 
9990
      </element>
 
9991
      <!-- procedure Visibility: protected -->
 
9992
      <element name="TWinControl.CNChar">
 
9993
        <short>Handler for
 
9994
          a key pressed notification.
 
9995
          CNChar is sent by the widget before it has handled the keypress itself.
 
9996
        </short>
 
9997
        <descr/>
 
9998
        <errors/>
 
9999
        <seealso/>
 
10000
      </element>
 
10001
      <element name="TWinControl.CNChar.Message">
 
10002
        <short/>
 
10003
      </element>
 
10004
      <!-- procedure Visibility: protected -->
 
10005
      <element name="TWinControl.DoDragMsg">
 
10006
        <short>Dispatches a drag message, sent by the DragManager.</short>
 
10007
        <descr>
 
10008
          <p>On dmFindTarget a TWinControl returns the child control under the mouse, or Self if none is found.
 
10009
          </p>
 
10010
          <p>All other messages are handled by inherited <link id="TControl.DoDragMsg"/>.
 
10011
          </p>
 
10012
        </descr>
 
10013
        <seealso>
 
10014
          <link id="TControl.DoDragMsg"/>
 
10015
        </seealso>
 
10016
      </element>
 
10017
      <element name="TWinControl.DoDragMsg.Result">
 
10018
        <short/>
 
10019
      </element>
 
10020
      <element name="TWinControl.DoDragMsg.ADragMessage">
 
10021
        <short/>
 
10022
      </element>
 
10023
      <element name="TWinControl.DoDragMsg.APosition">
 
10024
        <short/>
 
10025
      </element>
 
10026
      <element name="TWinControl.DoDragMsg.ADragObject">
 
10027
        <short/>
 
10028
      </element>
 
10029
      <element name="TWinControl.DoDragMsg.ATarget">
 
10030
        <short/>
 
10031
      </element>
 
10032
      <element name="TWinControl.DoDragMsg.ADocking">
 
10033
        <short/>
 
10034
      </element>
 
10035
      <!-- function Visibility: protected -->
 
10036
      <element name="TWinControl.DoDockClientMsg">
 
10037
        <short>Handles a dmDragDock message, when a control has been docked to this site.</short>
 
10038
        <descr>
 
10039
          <p>Called when a control is dropped for docking.
 
10040
          </p>
 
10041
          <p>Asks the dropped control to Dock itself into this control (adjust HostDockSite etc.).
 
10042
            <br/>
 
10043
            Calls an installed DockManager to adjust the coordinates of the docked control.
 
10044
          </p>
 
10045
          <p>The Result is always True (unless overridden).
 
10046
          </p>
 
10047
        </descr>
 
10048
        <seealso/>
 
10049
      </element>
 
10050
      <element name="TWinControl.DoDockClientMsg.Result">
 
10051
        <short/>
 
10052
      </element>
 
10053
      <element name="TWinControl.DoDockClientMsg.DragDockObject">
 
10054
        <short/>
 
10055
      </element>
 
10056
      <element name="TWinControl.DoDockClientMsg.aPosition">
 
10057
        <short/>
 
10058
      </element>
 
10059
      <!-- function Visibility: protected -->
 
10060
      <element name="TWinControl.DoUndockClientMsg">
 
10061
        <short>Notifies the DockManager of the undock of a client control.
 
10062
        </short>
 
10063
        <descr/>
 
10064
        <errors/>
 
10065
        <seealso>
 
10066
          <link id="TDockManager.RemoveControl"/>
 
10067
        </seealso>
 
10068
      </element>
 
10069
      <element name="TWinControl.DoUndockClientMsg.Result">
 
10070
        <short>Always True.</short>
 
10071
      </element>
 
10072
      <element name="TWinControl.DoUndockClientMsg.NewTarget">
 
10073
        <short/>
 
10074
      </element>
 
10075
      <element name="TWinControl.DoUndockClientMsg.Client">
 
10076
        <short/>
 
10077
      </element>
 
10078
      <!-- procedure Visibility: protected -->
 
10079
      <element name="TWinControl.DoAddDockClient">
 
10080
        <short>Adjust the Parent of a newly docked Client.</short>
 
10081
        <descr>The default action is to set the Parent to the new docksite (this control),
 
10082
          so that the client is displayed within the new site.</descr>
 
10083
      </element>
 
10084
      <element name="TWinControl.DoAddDockClient.Client">
 
10085
        <short/>
 
10086
      </element>
 
10087
      <element name="TWinControl.DoAddDockClient.ARect">
 
10088
        <short/>
 
10089
      </element>
 
10090
      <!-- procedure Visibility: protected -->
 
10091
      <element name="TWinControl.DockOver">
 
10092
        <short>Called to check whether this control allows docking and where.
 
10093
        </short>
 
10094
        <descr>
 
10095
          <p>Called on dragmanager messages dmEnter/Leave/Move, to get the DockRect to show.
 
10096
          </p>
 
10097
          <p>Positions the DockRect, invokes OnDockOver (via DoDockOver)
 
10098
          </p>
 
10099
          <p>Everything can be overridden by the OnDockOver handler, if installed.
 
10100
          </p>
 
10101
        </descr>
 
10102
        <seealso>
 
10103
          <link id="TControl.PositionDockRect"/>
 
10104
          <link id="TControl.OnDockOver"/>
 
10105
        </seealso>
 
10106
      </element>
 
10107
      <element name="TWinControl.DockOver.Source">
 
10108
        <short/>
 
10109
      </element>
 
10110
      <element name="TWinControl.DockOver.X">
 
10111
        <short/>
 
10112
      </element>
 
10113
      <element name="TWinControl.DockOver.Y">
 
10114
        <short/>
 
10115
      </element>
 
10116
      <element name="TWinControl.DockOver.State">
 
10117
        <short/>
 
10118
      </element>
 
10119
      <element name="TWinControl.DockOver.Accept">
 
10120
        <short>Initially True, set to False to reject an drop.</short>
 
10121
      </element>
 
10122
      <!-- procedure Visibility: protected -->
 
10123
      <element name="TWinControl.DoDockOver">
 
10124
        <short>Invoke the <link id="TWinControl.OnDockOver">OnDockOver</link> handler.</short>
 
10125
      </element>
 
10126
      <element name="TWinControl.DoDockOver.Source">
 
10127
        <short/>
 
10128
      </element>
 
10129
      <element name="TWinControl.DoDockOver.X">
 
10130
        <short/>
 
10131
      </element>
 
10132
      <element name="TWinControl.DoDockOver.Y">
 
10133
        <short/>
 
10134
      </element>
 
10135
      <element name="TWinControl.DoDockOver.State">
 
10136
        <short/>
 
10137
      </element>
 
10138
      <element name="TWinControl.DoDockOver.Accept">
 
10139
        <short/>
 
10140
      </element>
 
10141
      <!-- procedure Visibility: protected -->
 
10142
      <element name="TWinControl.DoRemoveDockClient">
 
10143
        <short>Override this method to take special actions on removal of an docked client.</short>
 
10144
        <descr>The default implementation does nothing.</descr>
 
10145
      </element>
 
10146
      <element name="TWinControl.DoRemoveDockClient.Client">
 
10147
        <short/>
 
10148
      </element>
 
10149
      <!-- function Visibility: protected -->
 
10150
      <element name="TWinControl.DoUnDock">
 
10151
        <short>Notifies an <var>OnUnDock</var> handler and DockManager of an undocked client control.</short>
 
10152
        <descr>The OnUnDock handler can deny to undock the control.
 
10153
          This can cause trouble, the control better should not be draggable instead.
 
10154
        </descr>
 
10155
        <errors/>
 
10156
        <seealso>
 
10157
          <link id="TWinControl.DoUndockClientMsg"/>
 
10158
          <link id="TWinControl.OnUnDock"/>
 
10159
        </seealso>
 
10160
      </element>
 
10161
      <element name="TWinControl.DoUnDock.Result">
 
10162
        <short>Set to False to deny undocking.</short>
 
10163
      </element>
 
10164
      <element name="TWinControl.DoUnDock.NewTarget">
 
10165
        <short>The new docksite, Nil for floating.</short>
 
10166
      </element>
 
10167
      <element name="TWinControl.DoUnDock.Client">
 
10168
        <short>The control being undocked.</short>
 
10169
      </element>
 
10170
      <element name="TWinControl.DoUnDock.KeepDockSiteSize">
 
10171
        <short/>
 
10172
      <notes><note>?</note>
 
10173
        </notes>
 
10174
      </element>
 
10175
      <!-- procedure Visibility: protected -->
 
10176
      <element name="TWinControl.GetSiteInfo">
 
10177
        <short>Return information about this dock site (InfluenceRect).</short>
 
10178
        <descr>The InfluenceRect determines the screen coordinates,
 
10179
          within which a drop is accepted.<br/>
 
10180
          The InfluenceRect is the slightly inflated WindowRect of the dock site,
 
10181
          adjustable in an OnGetSiteInfo handler.
 
10182
        </descr>
 
10183
      </element>
 
10184
      <element name="TWinControl.GetSiteInfo.Client">
 
10185
        <short>The dragged control</short>
 
10186
      <notes><note>?</note>
 
10187
        </notes>
 
10188
      </element>
 
10189
      <element name="TWinControl.GetSiteInfo.InfluenceRect">
 
10190
        <short>The screen rectangle within which a drop is allowed.</short>
 
10191
      </element>
 
10192
      <element name="TWinControl.GetSiteInfo.MousePos">
 
10193
        <short>The current mouse position.</short>
 
10194
      </element>
 
10195
      <element name="TWinControl.GetSiteInfo.CanDock">
 
10196
        <short>Can be set to False to reject an drop.</short>
 
10197
      </element>
 
10198
      <!-- procedure Visibility: protected -->
 
10199
      <element name="TWinControl.ReloadDockedControl">
 
10200
        <short>Returns the docked control of the specified name.</short>
 
10201
        <descr>
 
10202
          <p>This method is used during the restore of the layout of a docksite.
 
10203
          </p>
 
10204
          <p>The control is searched in the controls owned by the owner of the docksite.
 
10205
          </p>
 
10206
          <p>Override to search other places, or to create a control of the requested name.
 
10207
          </p>
 
10208
        </descr>
 
10209
      </element>
 
10210
      <element name="TWinControl.ReloadDockedControl.AControlName">
 
10211
        <short>The name of the control to be docked.</short>
 
10212
      </element>
 
10213
      <element name="TWinControl.ReloadDockedControl.AControl">
 
10214
        <short>The matching control.</short>
 
10215
      </element>
 
10216
      <!-- function Visibility: protected -->
 
10217
      <element name="TWinControl.CreateDockManager">
 
10218
        <short>Returns the DockManager for this control.</short>
 
10219
        <descr>If DockManager is nil, and UseDockManager is True, a new default DockManager is created.</descr>
 
10220
        <errors/>
 
10221
        <seealso/>
 
10222
      </element>
 
10223
      <element name="TWinControl.CreateDockManager.Result">
 
10224
        <short>The dockmanager for this site, can be Nil for an unmanaged site.</short>
 
10225
      </element>
 
10226
      <!-- procedure Visibility: protected -->
 
10227
      <element link="TWinControl.DockManager" name="TWinControl.SetDockManager"/>
 
10228
      <element name="TWinControl.SetDockManager.AMgr">
 
10229
        <short/>
 
10230
      </element>
 
10231
      <!-- procedure Visibility: protected -->
 
10232
      <element link="TControl.DoFloatMsg" name="TWinControl.DoFloatMsg">
 
10233
        <short>Handler called when the control starts floating.</short>
 
10234
        <descr>TWinControls can float for themselves, unless they request a special FloatingDockSiteClass.
 
10235
        </descr>
 
10236
        <errors/>
 
10237
        <seealso/>
 
10238
      <notes><note>Bug: when no FloatingDockSiteClass was assigned,
 
10239
          a default floating site is created?</note>
 
10240
        </notes>
 
10241
      </element>
 
10242
      <element name="TWinControl.DoFloatMsg.ADockSource">
 
10243
        <short/>
 
10244
      </element>
 
10245
      <!-- procedure Visibility: protected -->
 
10246
      <element name="TWinControl.DoGetDockCaption">
 
10247
        <short>Returns the dock caption of AControl.
 
10248
        </short>
 
10249
        <descr>
 
10250
          <p>Asks the control for its default dock caption,
 
10251
            then allows the OnGetDockCaption handler to adjust this string.
 
10252
          </p>
 
10253
        </descr>
 
10254
        <errors/>
 
10255
        <seealso>
 
10256
          <link id="TControl.GetDockCaption"/>
 
10257
          <link id="TWinControl.OnGetDockCaption"/>
 
10258
        </seealso>
 
10259
      </element>
 
10260
      <element name="TWinControl.DoGetDockCaption.AControl">
 
10261
        <short>The control whose dock caption string is requested.</short>
 
10262
      </element>
 
10263
      <element name="TWinControl.DoGetDockCaption.ACaption">
 
10264
        <short>The dock caption to use.</short>
 
10265
      </element>
 
10266
      <!-- procedure Visibility: protected -->
 
10267
      <element name="TWinControl.DoEnter">
 
10268
        <short>Invokes the <link id="#lcl.Controls.TWinControl.OnEnter">OnEnter</link> event handler.</short>
 
10269
      </element>
 
10270
      <!-- procedure Visibility: protected -->
 
10271
      <element name="TWinControl.DoExit">
 
10272
        <short>Invoke the <link id="#lcl.Controls.TWinControl.OnExit">OnExit</link> event handler.</short>
 
10273
      </element>
 
10274
      <!-- function Visibility: protected -->
 
10275
      <element name="TWinControl.DoKeyDownBeforeInterface">
 
10276
        <short>Handles a KeyDown event before the widget processes the key.
 
10277
        </short>
 
10278
        <descr>
 
10279
          <p>A number of handlers is invoked, until one handles the key.
 
10280
          </p>
 
10281
          <p>First all application wide handlers are invoked (<link id="#lcl.Forms.TApplication.NotifyKeyDownBeforeHandler"/>).
 
10282
          </p>
 
10283
          <p>Then the form's handler is invoked, when KeyPreview is requested.
 
10284
          </p>
 
10285
          <p>Then the DragManager is asked, when dragging.
 
10286
            It interprets ESC to cancel dragging, and CTRL to ignore drag targets.
 
10287
          </p>
 
10288
          <p>Finally the <link id="TWinControl.OnKeyDown"/> user handler is invoked.
 
10289
          </p>
 
10290
          <p>If no handler accepts the key, the widget continues to interpret it itself.
 
10291
          </p>
 
10292
        </descr>
 
10293
        <errors/>
 
10294
        <seealso/>
 
10295
      </element>
 
10296
      <element name="TWinControl.DoKeyDownBeforeInterface.Result">
 
10297
        <short>Set to True when the key was handled.</short>
 
10298
      </element>
 
10299
      <element name="TWinControl.DoKeyDownBeforeInterface.Message">
 
10300
        <short/>
 
10301
      </element>
 
10302
      <element name="TWinControl.DoKeyDownBeforeInterface.IsRecurseCall">
 
10303
        <short/>
 
10304
      <notes><note>?</note>
 
10305
        </notes>
 
10306
      </element>
 
10307
      <!-- function Visibility: protected -->
 
10308
      <element name="TWinControl.DoRemainingKeyDown">
 
10309
        <short>Handles keys which are not handled by the widget.
 
10310
        </short>
 
10311
        <descr/>
 
10312
        <errors/>
 
10313
        <seealso/>
 
10314
      </element>
 
10315
      <element name="TWinControl.DoRemainingKeyDown.Result">
 
10316
        <short>True if the key was handled.</short>
 
10317
      </element>
 
10318
      <element name="TWinControl.DoRemainingKeyDown.Message">
 
10319
        <short/>
 
10320
      </element>
 
10321
      <!-- function Visibility: protected -->
 
10322
      <element name="TWinControl.DoRemainingKeyUp">
 
10323
        <short/>
 
10324
        <descr/>
 
10325
        <errors/>
 
10326
        <seealso/>
 
10327
      <notes><note>?</note>
 
10328
        </notes>
 
10329
      </element>
 
10330
      <element name="TWinControl.DoRemainingKeyUp.Result">
 
10331
        <short>True if the key was handled.</short>
 
10332
      </element>
 
10333
      <element name="TWinControl.DoRemainingKeyUp.Message">
 
10334
        <short/>
 
10335
      </element>
 
10336
      <!-- function Visibility: protected -->
 
10337
      <element name="TWinControl.DoKeyPress">
 
10338
        <short>Tries all <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> handlers, of Parents first.
 
10339
        </short>
 
10340
        <descr/>
 
10341
        <errors/>
 
10342
        <seealso>
 
10343
          <link id="TWinControl.OnUTF8KeyPress"/>
 
10344
        </seealso>
 
10345
      </element>
 
10346
      <element name="TWinControl.DoKeyPress.Result">
 
10347
        <short>True if the key was handled.</short>
 
10348
      </element>
 
10349
      <element name="TWinControl.DoKeyPress.Message">
 
10350
        <short/>
 
10351
      </element>
 
10352
      <!-- function Visibility: protected -->
 
10353
      <element link="TWinControl.DoKeyPress" name="TWinControl.DoUTF8KeyPress"/>
 
10354
      <element name="TWinControl.DoUTF8KeyPress.Result">
 
10355
        <short>True if the key was handled.</short>
 
10356
      </element>
 
10357
      <element name="TWinControl.DoUTF8KeyPress.UTF8Key">
 
10358
        <short/>
 
10359
      </element>
 
10360
      <!-- function Visibility: protected -->
 
10361
      <element name="TWinControl.DoKeyUpBeforeInterface">
 
10362
        <short>Handles a KeyUp event before the widget processes the key.
 
10363
        </short>
 
10364
        <descr>For details see the equivalent method <link id="TWinControl.DoKeyDownBeforeInterface"/>.
 
10365
        </descr>
 
10366
        <errors/>
 
10367
        <seealso/>
 
10368
      </element>
 
10369
      <element name="TWinControl.DoKeyUpBeforeInterface.Result">
 
10370
        <short>True if the key was handled.</short>
 
10371
      </element>
 
10372
      <element name="TWinControl.DoKeyUpBeforeInterface.Message">
 
10373
        <short/>
 
10374
      </element>
 
10375
      <!-- function Visibility: protected -->
 
10376
      <element name="TWinControl.ChildKey">
 
10377
        <short/>
 
10378
        <descr/>
 
10379
        <errors/>
 
10380
        <seealso/>
 
10381
      <notes><note>?</note>
 
10382
        </notes>
 
10383
      </element>
 
10384
      <element name="TWinControl.ChildKey.Result">
 
10385
        <short>True if the key was handled.</short>
 
10386
      </element>
 
10387
      <element name="TWinControl.ChildKey.Message">
 
10388
        <short/>
 
10389
      </element>
 
10390
      <!-- function Visibility: protected -->
 
10391
      <element name="TWinControl.SendDialogChar">
 
10392
        <short/>
 
10393
        <descr/>
 
10394
        <errors/>
 
10395
        <seealso/>
 
10396
      <notes><note>?</note>
 
10397
        </notes>
 
10398
      </element>
 
10399
      <element name="TWinControl.SendDialogChar.Result">
 
10400
        <short>True if the key was handled.</short>
 
10401
      </element>
 
10402
      <element name="TWinControl.SendDialogChar.Message">
 
10403
        <short/>
 
10404
      </element>
 
10405
      <!-- function Visibility: protected -->
 
10406
      <element link="#LCL.Controls.TControl.DialogChar" name="TWinControl.DialogChar"/>
 
10407
      <element name="TWinControl.DialogChar.Result">
 
10408
        <short>True if the key was handled.</short>
 
10409
      </element>
 
10410
      <element name="TWinControl.DialogChar.Message">
 
10411
        <short/>
 
10412
      </element>
 
10413
      <!-- procedure Visibility: protected -->
 
10414
      <element name="TWinControl.ControlKeyDown">
 
10415
        <short>Lets the Application handle an navigation key.
 
10416
        </short>
 
10417
        <descr/>
 
10418
        <errors/>
 
10419
        <seealso/>
 
10420
      </element>
 
10421
      <element name="TWinControl.ControlKeyDown.Key">
 
10422
        <short/>
 
10423
      </element>
 
10424
      <element name="TWinControl.ControlKeyDown.Shift">
 
10425
        <short/>
 
10426
      </element>
 
10427
      <!-- procedure Visibility: protected -->
 
10428
      <element name="TWinControl.ControlKeyUp">
 
10429
        <short>Lets the Application handle an navigation key.
 
10430
        </short>
 
10431
        <descr/>
 
10432
        <errors/>
 
10433
        <seealso/>
 
10434
      </element>
 
10435
      <element name="TWinControl.ControlKeyUp.Key">
 
10436
        <short/>
 
10437
      </element>
 
10438
      <element name="TWinControl.ControlKeyUp.Shift">
 
10439
        <short/>
 
10440
      </element>
 
10441
      <!-- procedure Visibility: protected -->
 
10442
      <element name="TWinControl.KeyDown">
 
10443
        <short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> handler.
 
10444
        </short>
 
10445
        <descr/>
 
10446
        <errors/>
 
10447
        <seealso/>
 
10448
      </element>
 
10449
      <element name="TWinControl.KeyDown.Key">
 
10450
        <short/>
 
10451
      </element>
 
10452
      <element name="TWinControl.KeyDown.Shift">
 
10453
        <short/>
 
10454
      </element>
 
10455
      <!-- procedure Visibility: protected -->
 
10456
      <element name="TWinControl.KeyDownBeforeInterface">
 
10457
        <short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> handler.
 
10458
        </short>
 
10459
        <descr/>
 
10460
        <errors/>
 
10461
        <seealso/>
 
10462
      </element>
 
10463
      <element name="TWinControl.KeyDownBeforeInterface.Key">
 
10464
        <short/>
 
10465
      </element>
 
10466
      <element name="TWinControl.KeyDownBeforeInterface.Shift">
 
10467
        <short/>
 
10468
      </element>
 
10469
      <!-- procedure Visibility: protected -->
 
10470
      <element name="TWinControl.KeyDownAfterInterface">
 
10471
        <short/>
 
10472
        <descr/>
 
10473
        <errors/>
 
10474
        <seealso/>
 
10475
      <notes><note>?</note>
 
10476
        </notes>
 
10477
      </element>
 
10478
      <element name="TWinControl.KeyDownAfterInterface.Key">
 
10479
        <short/>
 
10480
      </element>
 
10481
      <element name="TWinControl.KeyDownAfterInterface.Shift">
 
10482
        <short/>
 
10483
      </element>
 
10484
      <!-- procedure Visibility: protected -->
 
10485
      <element name="TWinControl.KeyPress">
 
10486
        <short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> handler.
 
10487
        </short>
 
10488
        <descr/>
 
10489
        <errors/>
 
10490
        <seealso/>
 
10491
      </element>
 
10492
      <element name="TWinControl.KeyPress.Key">
 
10493
        <short/>
 
10494
      </element>
 
10495
      <!-- procedure Visibility: protected -->
 
10496
      <element name="TWinControl.KeyUp">
 
10497
        <short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyUp">OnKeyUp</link> handler.
 
10498
        </short>
 
10499
        <descr/>
 
10500
        <errors/>
 
10501
        <seealso/>
 
10502
      </element>
 
10503
      <element name="TWinControl.KeyUp.Key">
 
10504
        <short/>
 
10505
      </element>
 
10506
      <element name="TWinControl.KeyUp.Shift">
 
10507
        <short/>
 
10508
      </element>
 
10509
      <!-- procedure Visibility: protected -->
 
10510
      <element name="TWinControl.KeyUpBeforeInterface">
 
10511
        <short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyUp">OnKeyUp</link> handler.
 
10512
        </short>
 
10513
        <descr/>
 
10514
        <errors/>
 
10515
        <seealso/>
 
10516
      </element>
 
10517
      <element name="TWinControl.KeyUpBeforeInterface.Key">
 
10518
        <short/>
 
10519
      </element>
 
10520
      <element name="TWinControl.KeyUpBeforeInterface.Shift">
 
10521
        <short/>
 
10522
      </element>
 
10523
      <!-- procedure Visibility: protected -->
 
10524
      <element name="TWinControl.KeyUpAfterInterface">
 
10525
        <short/>
 
10526
        <descr/>
 
10527
        <errors/>
 
10528
        <seealso/>
 
10529
      <notes><note>?</note>
 
10530
        </notes>
 
10531
      </element>
 
10532
      <element name="TWinControl.KeyUpAfterInterface.Key">
 
10533
        <short/>
 
10534
      </element>
 
10535
      <element name="TWinControl.KeyUpAfterInterface.Shift">
 
10536
        <short/>
 
10537
      </element>
 
10538
      <!-- procedure Visibility: protected -->
 
10539
      <element name="TWinControl.UTF8KeyPress">
 
10540
        <short>Invokes the <link id="#lcl.Controls.TWinControl.OnUTF8KeyPress">OnUTF8KeyPress</link> handler.
 
10541
        </short>
 
10542
        <descr/>
 
10543
        <errors/>
 
10544
        <seealso/>
 
10545
      </element>
 
10546
      <element name="TWinControl.UTF8KeyPress.UTF8Key">
 
10547
        <short/>
 
10548
      </element>
 
10549
      <!-- function Visibility: protected -->
 
10550
      <element name="TWinControl.FindNextControl">
 
10551
        <short>Returns the preceding or next control in tab order.</short>
 
10552
        <descr>When CurrentControl is Nil, the first control (forward)
 
10553
          or last control (backward) in TabOrder is returned, depending on GoForward.
 
10554
        </descr>
 
10555
        <errors/>
 
10556
        <seealso/>
 
10557
      </element>
 
10558
      <element name="TWinControl.FindNextControl.Result">
 
10559
        <short>The (next) control.</short>
 
10560
      </element>
 
10561
      <element name="TWinControl.FindNextControl.CurrentControl">
 
10562
        <short>The control which has the focus.
 
10563
          If Nil, the first control (forward)
 
10564
          or last control (backward) in TabOrder is returned,
 
10565
          depending on GoForward.
 
10566
        </short>
 
10567
      </element>
 
10568
      <element name="TWinControl.FindNextControl.GoForward">
 
10569
        <short>False to find the preceding control.</short>
 
10570
      </element>
 
10571
      <element name="TWinControl.FindNextControl.CheckTabStop">
 
10572
        <short>When True: only find controls with TabStop=True.</short>
 
10573
      </element>
 
10574
      <element name="TWinControl.FindNextControl.CheckParent">
 
10575
        <short>When True: only find controls with Parent=Self.</short>
 
10576
      </element>
 
10577
      <!-- procedure Visibility: protected -->
 
10578
      <element name="TWinControl.SelectFirst">
 
10579
        <short>Returns the first control in tab order.</short>
 
10580
        <descr/>
 
10581
        <errors/>
 
10582
        <seealso/>
 
10583
      </element>
 
10584
      <!-- function Visibility: protected -->
 
10585
      <element link="#LCL.Controls.TControl.RealGetText" name="TWinControl.RealGetText"/>
 
10586
      <element name="TWinControl.RealGetText.Result">
 
10587
        <short/>
 
10588
      </element>
 
10589
      <!-- function Visibility: protected -->
 
10590
      <element link="TWinControl.BorderStyle" name="TWinControl.GetBorderStyle"/>
 
10591
      <element name="TWinControl.GetBorderStyle.Result">
 
10592
        <short/>
 
10593
      </element>
 
10594
      <!-- function Visibility: protected -->
 
10595
      <element link="#LCL.Controls.TControl.GetClientOrigin" name="TWinControl.GetClientOrigin"/>
 
10596
      <element name="TWinControl.GetClientOrigin.Result">
 
10597
        <short/>
 
10598
      </element>
 
10599
      <!-- function Visibility: protected -->
 
10600
      <element link="#LCL.Controls.TControl.GetClientRect" name="TWinControl.GetClientRect"/>
 
10601
      <element name="TWinControl.GetClientRect.Result">
 
10602
        <short/>
 
10603
      </element>
 
10604
      <!-- function Visibility: protected -->
 
10605
      <element link="#LCL.Controls.TControl.GetControlOrigin" name="TWinControl.GetControlOrigin">
 
10606
        <short>The screen coordinates of the control.</short>
 
10607
        <descr>
 
10608
          <p>Returns the screen coordinates of the topleft pixel of the control on the screen.</p>
 
10609
          <remark>Note that this value is the position as stored in the interface and is not always in sync with the LCL.
 
10610
            When a control is moved, the LCL sets the bounds to the wanted position and sends a move message to the interface.
 
10611
            It is up to the interface to handle moves instantly or queued.
 
10612
          </remark>
 
10613
        </descr>
 
10614
      </element>
 
10615
      <element name="TWinControl.GetControlOrigin.Result">
 
10616
        <short/>
 
10617
      </element>
 
10618
      <!-- function Visibility: protected -->
 
10619
      <element link="#LCL.Controls.TControl.GetDeviceContext" name="TWinControl.GetDeviceContext"/>
 
10620
      <element name="TWinControl.GetDeviceContext.Result">
 
10621
        <short/>
 
10622
      </element>
 
10623
      <element name="TWinControl.GetDeviceContext.WindowHandle">
 
10624
        <short/>
 
10625
      </element>
 
10626
      <!-- function Visibility: protected -->
 
10627
      <element name="TWinControl.IsControlMouseMsg">
 
10628
        <short>Sends the mouse message to a child control.
 
10629
        </short>
 
10630
        <descr/>
 
10631
        <errors/>
 
10632
        <seealso/>
 
10633
      </element>
 
10634
      <element name="TWinControl.IsControlMouseMsg.Result">
 
10635
        <short>True if a child control was found at the mouse coordinates.</short>
 
10636
      </element>
 
10637
      <element name="TWinControl.IsControlMouseMsg.TheMessage">
 
10638
        <short/>
 
10639
      </element>
 
10640
      <!-- procedure Visibility: protected -->
 
10641
      <element name="TWinControl.CreateHandle">
 
10642
        <short>Creates the Handle ( = widget) if not already done.
 
10643
        </short>
 
10644
        <descr/>
 
10645
        <errors/>
 
10646
        <seealso/>
 
10647
      </element>
 
10648
      <!-- procedure Visibility: protected -->
 
10649
      <element name="TWinControl.CreateParams">
 
10650
        <short>Initializes the window creation parameter record with the settings of the control.
 
10651
        </short>
 
10652
        <descr>
 
10653
          <p>Definition of parameters:</p>
 
10654
          <pre>TCreateParams = record
 
10655
    Caption: PChar;
 
10656
    Style: Cardinal;
 
10657
    ExStyle: Cardinal;
 
10658
    X, Y: Integer;
 
10659
    Width, Height: Integer;
 
10660
    WndParent: HWnd;
 
10661
    Param: Pointer;
 
10662
    WindowClass: TWndClass;
 
10663
    WinClassName: array[0..63] of Char;
 
10664
End;
 
10665
</pre>
 
10666
        </descr>
 
10667
        <errors/>
 
10668
        <seealso/>
 
10669
      </element>
 
10670
      <element name="TWinControl.CreateParams.Params">
 
10671
        <short/>
 
10672
      </element>
 
10673
      <!-- procedure Visibility: protected -->
 
10674
      <element name="TWinControl.CreateWnd">
 
10675
        <short>Creates the interface object (widget) and assigns it to Handle.
 
10676
        </short>
 
10677
        <descr/>
 
10678
        <errors/>
 
10679
        <seealso/>
 
10680
      </element>
 
10681
      <!-- procedure Visibility: protected -->
 
10682
      <element name="TWinControl.DestroyHandle">
 
10683
        <short>Destroys this and all child widgets.
 
10684
        </short>
 
10685
        <descr/>
 
10686
        <errors/>
 
10687
        <seealso/>
 
10688
      </element>
 
10689
      <!-- procedure Visibility: protected -->
 
10690
      <element name="TWinControl.DestroyWnd">
 
10691
        <short>Destroys the interface object (widget).
 
10692
        </short>
 
10693
        <descr/>
 
10694
        <errors/>
 
10695
        <seealso/>
 
10696
      </element>
 
10697
      <!-- procedure Visibility: protected -->
 
10698
      <element name="TWinControl.DoFlipChildren">
 
10699
        <short>Flip children horizontally. That means mirroring the Left position.
 
10700
        </short>
 
10701
        <descr>Child controls arranged in left-to-right order appear in right-to-left order after flipping.
 
10702
          All anchors are adjusted accordingly.
 
10703
        </descr>
 
10704
        <errors/>
 
10705
        <seealso>
 
10706
          <link id="TWinControl.FlipChildren"/>
 
10707
        </seealso>
 
10708
      </element>
 
10709
      <!-- procedure Visibility: protected -->
 
10710
      <element name="TWinControl.FinalizeWnd">
 
10711
        <short>Prepare to remove the window (gets called before the Handle is destroyed).
 
10712
        </short>
 
10713
        <descr/>
 
10714
        <errors/>
 
10715
        <seealso/>
 
10716
      </element>
 
10717
      <!-- procedure Visibility: protected -->
 
10718
      <element name="TWinControl.FixupTabList">
 
10719
        <short>Assigns strictly sequential TabOrder values to all child windows.
 
10720
        </short>
 
10721
        <descr/>
 
10722
        <errors/>
 
10723
        <seealso/>
 
10724
      </element>
 
10725
      <!-- procedure Visibility: protected -->
 
10726
      <element link="#LCL.Controls.TControl.FontChanged" name="TWinControl.FontChanged"/>
 
10727
      <element name="TWinControl.FontChanged.Sender">
 
10728
        <short/>
 
10729
      </element>
 
10730
      <!-- procedure Visibility: protected -->
 
10731
      <element name="TWinControl.InitializeWnd">
 
10732
        <short>Copies cached control properties to the just created widget.</short>
 
10733
        <descr>
 
10734
          <p>Gets called after the Handle is created and before the child handles are created.
 
10735
          </p>
 
10736
        </descr>
 
10737
        <errors/>
 
10738
        <seealso/>
 
10739
      </element>
 
10740
      <!-- procedure Visibility: protected -->
 
10741
      <element name="TWinControl.Loaded">
 
10742
        <short>Called when the control has been loaded from a resource, transfers the loaded property values to the widget.
 
10743
        </short>
 
10744
        <descr/>
 
10745
        <errors/>
 
10746
        <seealso>
 
10747
          <link id="#LCL.Controls.TControl.Loaded">TControl.Loaded</link>
 
10748
        </seealso>
 
10749
      </element>
 
10750
      <!-- procedure Visibility: protected -->
 
10751
      <element name="TWinControl.FormEndUpdated">
 
10752
        <short>Realizes all cached changes after a bulk update of the form. Calls inherited
 
10753
          <var>FormEndUpdated</var>, then informs each child control.</short>
 
10754
        <descr/>
 
10755
        <errors/>
 
10756
        <seealso>
 
10757
          <link id="#LCL.Controls.TControl.FormEndUpdated">TControl.FormEndUpdated</link>
 
10758
        </seealso>
 
10759
      </element>
 
10760
      <!-- procedure Visibility: protected -->
 
10761
      <element name="TWinControl.MainWndProc">
 
10762
        <short>This method allows handling messages in Windows</short>
 
10763
        <descr>
 
10764
        </descr>
 
10765
        <errors/>
 
10766
        <seealso/>
 
10767
      <notes><note>?</note><note>This method does nothing, and cannot be overridden???</note>
 
10768
        </notes>
 
10769
      </element>
 
10770
      <element name="TWinControl.MainWndProc.Msg">
 
10771
        <short/>
 
10772
      </element>
 
10773
      <!-- procedure Visibility: protected -->
 
10774
      <element name="TWinControl.ParentFormHandleInitialized">
 
10775
        <short>Called after all children handles of the ParentForm are created.
 
10776
          Notifies all children of the end of the handle creation phase.
 
10777
        </short>
 
10778
        <descr/>
 
10779
        <errors/>
 
10780
        <seealso>
 
10781
          <link id="#LCL.Controls.TControl.ParentFormHandleInitialized">TControl.ParentFormHandleInitialized</link>
 
10782
        </seealso>
 
10783
      </element>
 
10784
      <!-- procedure Visibility: protected -->
 
10785
      <element name="TWinControl.ChildHandlesCreated">
 
10786
        <short>Called after all child handles have been created. Resets wcfCreatingChildHandles.
 
10787
        </short>
 
10788
        <descr/>
 
10789
        <errors/>
 
10790
        <seealso/>
 
10791
      </element>
 
10792
      <!-- procedure Visibility: protected -->
 
10793
      <element link="#LCL.Controls.TControl.RealSetText" name="TWinControl.RealSetText"/>
 
10794
      <element name="TWinControl.RealSetText.AValue">
 
10795
        <short/>
 
10796
      </element>
 
10797
      <!-- procedure Visibility: protected -->
 
10798
      <element name="TWinControl.RemoveFocus">
 
10799
        <short>Notifies the parent form of the focus loss.
 
10800
        </short>
 
10801
        <descr/>
 
10802
        <errors/>
 
10803
        <seealso/>
 
10804
      </element>
 
10805
      <element name="TWinControl.RemoveFocus.Removing">
 
10806
        <short/>
 
10807
      </element>
 
10808
      <!-- procedure Visibility: protected -->
 
10809
      <element link="#LCL.Controls.TControl.SendMoveSizeMessages" name="TWinControl.SendMoveSizeMessages"/>
 
10810
      <element name="TWinControl.SendMoveSizeMessages.SizeChanged">
 
10811
        <short/>
 
10812
      </element>
 
10813
      <element name="TWinControl.SendMoveSizeMessages.PosChanged">
 
10814
        <short/>
 
10815
      </element>
 
10816
      <!-- procedure Visibility: protected -->
 
10817
      <element link="TWinControl.BorderStyle" name="TWinControl.SetBorderStyle"/>
 
10818
      <element name="TWinControl.SetBorderStyle.NewStyle">
 
10819
        <short/>
 
10820
      </element>
 
10821
      <!-- procedure Visibility: protected -->
 
10822
      <element link="#LCL.Controls.TControl.SetColor" name="TWinControl.SetColor"/>
 
10823
      <element name="TWinControl.SetColor.Value">
 
10824
        <short/>
 
10825
      </element>
 
10826
      <!-- procedure Visibility: protected -->
 
10827
      <element name="TWinControl.SetChildZPosition">
 
10828
        <short>Updates the position of the child control in the Z plane (ie front-to-back).
 
10829
        </short>
 
10830
        <descr/>
 
10831
        <errors/>
 
10832
        <seealso/>
 
10833
      </element>
 
10834
      <element name="TWinControl.SetChildZPosition.AChild">
 
10835
        <short/>
 
10836
      </element>
 
10837
      <element name="TWinControl.SetChildZPosition.APosition">
 
10838
        <short/>
 
10839
      </element>
 
10840
      <!-- procedure Visibility: protected -->
 
10841
      <element name="TWinControl.ShowControl">
 
10842
        <short>Asks the parent to show ourself.
 
10843
        </short>
 
10844
        <descr/>
 
10845
        <errors/>
 
10846
        <seealso/>
 
10847
      </element>
 
10848
      <element name="TWinControl.ShowControl.AControl">
 
10849
        <short>The control to show, here: ignored!</short>
 
10850
      </element>
 
10851
      <!-- procedure Visibility: protected -->
 
10852
      <element name="TWinControl.UpdateControlState">
 
10853
        <short>Essentially updates the visible state of the control, and of the widget if already created.
 
10854
        </short>
 
10855
        <descr/>
 
10856
        <errors/>
 
10857
        <seealso/>
 
10858
      </element>
 
10859
      <!-- procedure Visibility: protected -->
 
10860
      <element name="TWinControl.UpdateShowing">
 
10861
        <short>When the widget should be visible and has not yet been created, it's created along with all children.
 
10862
        </short>
 
10863
        <descr/>
 
10864
        <errors/>
 
10865
        <seealso/>
 
10866
      </element>
 
10867
      <!-- procedure Visibility: protected -->
 
10868
      <element name="TWinControl.WndProc">
 
10869
        <short>Adds special handling for focus and input messages, notifies an DockManager.
 
10870
        </short>
 
10871
        <descr>
 
10872
          <p>LM_SETFOCUS: gets parent form and show this control as focused</p>
 
10873
          <p>LM_KILLFOCUS: removes focus fromthis control</p>
 
10874
          <p>LM_NCHITTEST: check transparency etc</p>
 
10875
          <p>Mouse messages: send to DockManager.</p>
 
10876
        </descr>
 
10877
        <errors/>
 
10878
        <seealso>
 
10879
          <link id="#LCL.Controls.TControl.WndProc">TControl.WndProc</link>
 
10880
        </seealso>
 
10881
      </element>
 
10882
      <element name="TWinControl.WndProc.Message">
 
10883
        <short/>
 
10884
      </element>
 
10885
      <!-- procedure Visibility: protected -->
 
10886
      <element name="TWinControl.WSSetText">
 
10887
        <short>Sends text to the widget (from WM_SETTEXT?).
 
10888
        </short>
 
10889
        <descr/>
 
10890
        <errors/>
 
10891
        <seealso/>
 
10892
      </element>
 
10893
      <element name="TWinControl.WSSetText.AText">
 
10894
        <short>The text to send.</short>
 
10895
      </element>
 
10896
      <!-- function Visibility: public -->
 
10897
      <element name="TWinControl.AutoSizePhases">
 
10898
        <short>Translates state flags into AutoSizePhases</short>
 
10899
        <descr/>
 
10900
        <errors/>
 
10901
        <seealso/>
 
10902
      <notes><note>?</note>
 
10903
        </notes>
 
10904
      </element>
 
10905
      <element name="TWinControl.AutoSizePhases.Result">
 
10906
        <short/>
 
10907
      </element>
 
10908
      <!-- function Visibility: public -->
 
10909
      <element link="#LCL.Controls.TControl.AutoSizeDelayed" name="TWinControl.AutoSizeDelayed"/>
 
10910
      <element name="TWinControl.AutoSizeDelayed.Result">
 
10911
        <short/>
 
10912
      </element>
 
10913
      <!-- function Visibility: public -->
 
10914
      <element name="TWinControl.AutoSizeCheckParent">
 
10915
        <short>Checks for a parent control or widget.</short>
 
10916
        <descr/>
 
10917
        <errors/>
 
10918
        <seealso/>
 
10919
      </element>
 
10920
      <element name="TWinControl.AutoSizeCheckParent.Result">
 
10921
        <short>True when a parent exists.</short>
 
10922
      </element>
 
10923
      <!-- procedure Visibility: public -->
 
10924
      <element name="TWinControl.BeginUpdateBounds">
 
10925
        <short>Start of Bounds updates. Disables SetBounds by incrementing BoundsLockCount.</short>
 
10926
        <descr/>
 
10927
        <errors/>
 
10928
        <seealso>
 
10929
          <link id="TWinControl.EndUpdateBounds"/>
 
10930
        </seealso>
 
10931
      </element>
 
10932
      <!-- procedure Visibility: public -->
 
10933
      <element name="TWinControl.EndUpdateBounds">
 
10934
        <short>End of Bounds update. Decrements BoundsLockCount and eventually calls SetBounds.
 
10935
        </short>
 
10936
        <descr/>
 
10937
        <errors/>
 
10938
        <seealso>
 
10939
          <link id="TWinControl.BeginUpdateBounds"/>
 
10940
        </seealso>
 
10941
      </element>
 
10942
      <!-- procedure Visibility: public -->
 
10943
      <element name="TWinControl.LockRealizeBounds">
 
10944
        <short>Disables sending bounds to the widget, by incrementing FRealizeBoundsLockCount.
 
10945
        </short>
 
10946
        <descr/>
 
10947
        <errors/>
 
10948
        <seealso>
 
10949
          <link id="TWinControl.UnlockRealizeBounds"/>
 
10950
        </seealso>
 
10951
      </element>
 
10952
      <!-- procedure Visibility: public -->
 
10953
      <element name="TWinControl.UnlockRealizeBounds">
 
10954
        <short>Enables sending bounds to the widget again, eventually updates the widget.
 
10955
        </short>
 
10956
        <descr/>
 
10957
        <errors/>
 
10958
        <seealso>
 
10959
          <link id="TWinControl.LockRealizeBounds"/>
 
10960
        </seealso>
 
10961
      </element>
 
10962
      <!-- function Visibility: public -->
 
10963
      <element name="TWinControl.ControlAtPos">
 
10964
        <short>Get the child control at the given client position.</short>
 
10965
        <descr>
 
10966
          <p>WinControls are found before Controls (if overlapping).</p>
 
10967
        </descr>
 
10968
        <errors/>
 
10969
        <seealso/>
 
10970
      </element>
 
10971
      <element name="TWinControl.ControlAtPos.Result">
 
10972
        <short>The found control, Nil if none found.</short>
 
10973
      </element>
 
10974
      <element name="TWinControl.ControlAtPos.Pos">
 
10975
        <short>The client coordinates.</short>
 
10976
      </element>
 
10977
      <element name="TWinControl.ControlAtPos.AllowDisabled">
 
10978
        <short>Allow finding disabled controls.</short>
 
10979
      </element>
 
10980
      <element name="TWinControl.ControlAtPos.AllowWinControls">
 
10981
        <short>Allow finding TWinControls, in addition to TControls.</short>
 
10982
      </element>
 
10983
      <element name="TWinControl.ControlAtPos.OnlyClientAreas">
 
10984
        <short>Only search in client areas.</short>
 
10985
      </element>
 
10986
      <element name="TWinControl.ControlAtPos.Flags">
 
10987
        <short>Encoded Allow... conditions.</short>
 
10988
      </element>
 
10989
      <!-- function Visibility: protected -->
 
10990
      <element name="TWinControl.ContainsControl">
 
10991
        <short>Returns True if this is a parent of the given control.
 
10992
        </short>
 
10993
        <descr/>
 
10994
        <errors/>
 
10995
        <seealso/>
 
10996
      </element>
 
10997
      <element name="TWinControl.ContainsControl.Result">
 
10998
        <short>True when we are a parent of Control.</short>
 
10999
      </element>
 
11000
      <element name="TWinControl.ContainsControl.Control">
 
11001
        <short>The (possible) child control.</short>
 
11002
      </element>
 
11003
      <!-- procedure Visibility: public -->
 
11004
      <element name="TWinControl.DoAdjustClientRectChange">
 
11005
        <short>Asks the widget if clientrect has changed since last AlignControl,
 
11006
          and calls AdjustSize on change.
 
11007
        </short>
 
11008
        <descr/>
 
11009
        <errors/>
 
11010
        <seealso/>
 
11011
      </element>
 
11012
      <element name="TWinControl.DoAdjustClientRectChange.InvalidateRect">
 
11013
        <short/>
 
11014
      </element>
 
11015
      <!-- procedure Visibility: public -->
 
11016
      <element name="TWinControl.InvalidateClientRectCache">
 
11017
        <short>The ClientRect is cached.
 
11018
          Call this procedure to invalidate the cache,
 
11019
          so that next time the ClientRect is fetched from the widget.
 
11020
        </short>
 
11021
        <descr/>
 
11022
        <errors/>
 
11023
        <seealso/>
 
11024
      </element>
 
11025
      <element name="TWinControl.InvalidateClientRectCache.WithChildControls">
 
11026
        <short>Also invalidate all child controls, if True.</short>
 
11027
      </element>
 
11028
      <!-- function Visibility: public -->
 
11029
      <element name="TWinControl.ClientRectNeedsInterfaceUpdate">
 
11030
        <short>The ClientRect is cached - check if the cache is valid.
 
11031
        </short>
 
11032
        <descr/>
 
11033
        <errors/>
 
11034
        <seealso/>
 
11035
      </element>
 
11036
      <element name="TWinControl.ClientRectNeedsInterfaceUpdate.Result">
 
11037
        <short>True if update needed.</short>
 
11038
      </element>
 
11039
      <!-- procedure Visibility: public -->
 
11040
      <element link="#LCL.Controls.TControl.SetBounds" name="TWinControl.SetBounds">
 
11041
        <short>Sets the control bounds and adjusts child and docked controls.</short>
 
11042
      </element>
 
11043
      <element name="TWinControl.SetBounds.aLeft">
 
11044
        <short/>
 
11045
      </element>
 
11046
      <element name="TWinControl.SetBounds.aTop">
 
11047
        <short/>
 
11048
      </element>
 
11049
      <element name="TWinControl.SetBounds.aWidth">
 
11050
        <short/>
 
11051
      </element>
 
11052
      <element name="TWinControl.SetBounds.aHeight">
 
11053
        <short/>
 
11054
      </element>
 
11055
      <!-- function Visibility: protected -->
 
11056
      <element link="#LCL.Controls.TControl.GetChildsRect" name="TWinControl.GetChildsRect"/>
 
11057
      <element name="TWinControl.GetChildsRect.Result">
 
11058
        <short/>
 
11059
      </element>
 
11060
      <element name="TWinControl.GetChildsRect.Scrolled">
 
11061
        <short/>
 
11062
      </element>
 
11063
      <!-- procedure Visibility: public -->
 
11064
      <element link="TWinControl.DisableAutoSizing" name="TWinControl.DisableAlign"/>
 
11065
      <!-- procedure Visibility: public -->
 
11066
      <element link="TWinControl.EnableAutoSizing" name="TWinControl.EnableAlign"/>
 
11067
      <!-- procedure Visibility: protected -->
 
11068
      <element link="TControl.AdjustSize" name="TWinControl.ReAlign"/>
 
11069
      <!-- procedure Visibility: public -->
 
11070
      <element name="TWinControl.ScrollBy">
 
11071
        <short>Move all child controls.</short>
 
11072
        <descr/>
 
11073
        <errors/>
 
11074
        <seealso/>
 
11075
      </element>
 
11076
      <element name="TWinControl.ScrollBy.DeltaX">
 
11077
        <short>Increment for Left.</short>
 
11078
      </element>
 
11079
      <element name="TWinControl.ScrollBy.DeltaY">
 
11080
        <short>Increment for Top</short>
 
11081
      </element>
 
11082
      <!-- procedure Visibility: public -->
 
11083
      <element link="#LCL.Controls.TControl.WriteLayoutDebugReport" name="TWinControl.WriteLayoutDebugReport"/>
 
11084
      <element name="TWinControl.WriteLayoutDebugReport.Prefix">
 
11085
        <short/>
 
11086
      </element>
 
11087
      <!-- constructor Visibility: public -->
 
11088
      <element name="TWinControl.Create"/>
 
11089
      <element name="TWinControl.Create.TheOwner">
 
11090
        <short/>
 
11091
      </element>
 
11092
      <!-- constructor Visibility: public -->
 
11093
      <element name="TWinControl.CreateParented">
 
11094
        <short>Constructor for a control that is the child of the given widget.</short>
 
11095
        <descr/>
 
11096
        <errors/>
 
11097
        <seealso/>
 
11098
      </element>
 
11099
      <element name="TWinControl.CreateParented.AParentWindow">
 
11100
        <short/>
 
11101
      </element>
 
11102
      <!-- function Visibility: public -->
 
11103
      <element link="TWinControl.CreateParented" name="TWinControl.CreateParentedControl"/>
 
11104
      <element name="TWinControl.CreateParentedControl.Result">
 
11105
        <short/>
 
11106
      </element>
 
11107
      <element name="TWinControl.CreateParentedControl.AParentWindow">
 
11108
        <short/>
 
11109
      </element>
 
11110
      <!-- destructor Visibility: public -->
 
11111
      <element name="TWinControl.Destroy"/>
 
11112
      <!-- procedure Visibility: public -->
 
11113
      <element name="TWinControl.DockDrop">
 
11114
        <short>Handler for a DragManager dmDragDrop message,
 
11115
          sent when a dragged control has been dropped onto this docksite.
 
11116
        </short>
 
11117
        <descr>
 
11118
          <p>Asks the dropped control to dock itself into this docksite,
 
11119
            updating its Parent, HostDockSite,
 
11120
            and the DockClients of the old and new DockSite.
 
11121
          </p>
 
11122
          <p>When a DockManager is installed,
 
11123
            asks the DockManager to position the docked control (InsertControl).
 
11124
          </p>
 
11125
          <p>Finally creates an OnDockDrop event.
 
11126
          </p>
 
11127
        </descr>
 
11128
        <seealso>
 
11129
          <link id="TWinControl.DoDockClientMsg"/>
 
11130
          <link id="TWinControl.OnDockDrop"/>
 
11131
          <link id="TDragDockObject"/>
 
11132
        </seealso>
 
11133
      </element>
 
11134
      <element name="TWinControl.DockDrop.DragDockObject">
 
11135
        <short/>
 
11136
      </element>
 
11137
      <element name="TWinControl.DockDrop.X">
 
11138
        <short/>
 
11139
      </element>
 
11140
      <element name="TWinControl.DockDrop.Y">
 
11141
        <short/>
 
11142
      </element>
 
11143
      <!-- function Visibility: public -->
 
11144
      <element name="TWinControl.CanFocus">
 
11145
        <short>Is this control allowed to receive the focus?</short>
 
11146
        <descr>A control can get the focus only when all of its Parents except the form are Visible and Enabled.
 
11147
While CanFocus checks all control parents it does not check whether a form control is placed on can have focus.</descr>
 
11148
        <errors/>
 
11149
        <seealso/>
 
11150
      </element>
 
11151
      <element name="TWinControl.CanFocus.Result">
 
11152
        <short/>
 
11153
      </element>
 
11154
      <!-- function Visibility: public -->
 
11155
      <element name="TWinControl.GetControlIndex">
 
11156
        <short>Finds the index value for the given control,
 
11157
          in <link id="TWinControl.Controls">Controls[]</link>.
 
11158
        </short>
 
11159
        <descr/>
 
11160
        <errors/>
 
11161
        <seealso/>
 
11162
      </element>
 
11163
      <element name="TWinControl.GetControlIndex.Result">
 
11164
        <short>The index in Controls, -1 if not found.</short>
 
11165
      </element>
 
11166
      <element name="TWinControl.GetControlIndex.AControl">
 
11167
        <short>The (possible) child control.</short>
 
11168
      </element>
 
11169
      <!-- procedure Visibility: public -->
 
11170
      <element link="TWinControl.SetChildZPosition" name="TWinControl.SetControlIndex"/>
 
11171
      <element name="TWinControl.SetControlIndex.AControl">
 
11172
        <short/>
 
11173
      </element>
 
11174
      <element name="TWinControl.SetControlIndex.NewIndex">
 
11175
        <short/>
 
11176
      </element>
 
11177
      <!-- function Visibility: public -->
 
11178
      <element name="TWinControl.Focused">
 
11179
        <short>Checks whether the control has the focus.
 
11180
        </short>
 
11181
        <descr/>
 
11182
        <errors/>
 
11183
        <seealso/>
 
11184
      </element>
 
11185
      <element name="TWinControl.Focused.Result">
 
11186
        <short>True when we have the focus.</short>
 
11187
      </element>
 
11188
      <!-- function Visibility: public -->
 
11189
      <element name="TWinControl.PerformTab">
 
11190
        <short>Sets the focus to the next (or preceding) control.
 
11191
        </short>
 
11192
        <descr/>
 
11193
        <errors/>
 
11194
        <seealso/>
 
11195
      </element>
 
11196
      <element name="TWinControl.PerformTab.Result">
 
11197
        <short>True when the focus has been transferred.</short>
 
11198
      </element>
 
11199
      <element name="TWinControl.PerformTab.ForwardTab">
 
11200
        <short>The direction of transfer: True for the next control in the TabOrder, False for the preceding control.</short>
 
11201
      </element>
 
11202
      <!-- function Visibility: public -->
 
11203
      <element name="TWinControl.FindChildControl">
 
11204
        <short>Finds a child control by name.
 
11205
        </short>
 
11206
        <descr/>
 
11207
        <errors/>
 
11208
        <seealso/>
 
11209
      </element>
 
11210
      <element name="TWinControl.FindChildControl.Result">
 
11211
        <short>True when the control has been found.</short>
 
11212
      </element>
 
11213
      <element name="TWinControl.FindChildControl.ControlName">
 
11214
        <short>The Name of the control to find.</short>
 
11215
      </element>
 
11216
      <!-- procedure Visibility: public -->
 
11217
      <element name="TWinControl.SelectNext">
 
11218
        <short>Transfers the focus to the next child control.
 
11219
        </short>
 
11220
        <descr>
 
11221
          <p>The search wraps around on the boundaries of the TabOrder array.
 
11222
          </p>
 
11223
          <p>When no next control can be found, the focus remains unchanged.
 
11224
          </p>
 
11225
        </descr>
 
11226
        <errors/>
 
11227
        <seealso>
 
11228
          <link id="TWinControl.FindNextControl"/>
 
11229
        </seealso>
 
11230
      </element>
 
11231
      <element name="TWinControl.SelectNext.CurControl">
 
11232
        <short>The control which is assumed to have the focus.</short>
 
11233
      </element>
 
11234
      <element name="TWinControl.SelectNext.GoForward">
 
11235
        <short>False when the control preceding CurControl shall be found.</short>
 
11236
      </element>
 
11237
      <element name="TWinControl.SelectNext.CheckTabStop">
 
11238
        <short>When True, only select a control that can receive the focus.</short>
 
11239
      </element>
 
11240
      <!-- procedure Visibility: public -->
 
11241
      <element link="#LCL.Controls.TControl.SetTempCursor" name="TWinControl.SetTempCursor"/>
 
11242
      <element name="TWinControl.SetTempCursor.Value">
 
11243
        <short/>
 
11244
      </element>
 
11245
      <!-- procedure Visibility: public -->
 
11246
      <element name="TWinControl.BroadCast">
 
11247
        <short>Sends a message to all child controls.
 
11248
        </short>
 
11249
        <seealso>
 
11250
          <link id="TWinControl.NotifyControls"/>
 
11251
        </seealso>
 
11252
      </element>
 
11253
      <element name="TWinControl.BroadCast.ToAllMessage">
 
11254
        <short>The message to send.</short>
 
11255
      </element>
 
11256
      <!-- procedure Visibility: public -->
 
11257
      <element name="TWinControl.NotifyControls">
 
11258
        <short>Sends a message to all child controls.
 
11259
        </short>
 
11260
        <descr/>
 
11261
        <errors/>
 
11262
        <seealso>
 
11263
          <link id="TWinControl.BroadCast"/>
 
11264
        </seealso>
 
11265
      </element>
 
11266
      <element name="TWinControl.NotifyControls.Msg">
 
11267
        <short>The message ID.</short>
 
11268
      </element>
 
11269
      <!-- procedure Visibility: public -->
 
11270
      <element name="TWinControl.DefaultHandler">
 
11271
        <short>Handles all messages that the control doesn't fully handle itself.
 
11272
        </short>
 
11273
        <descr>
 
11274
          <p>This implementation sends the message to the widget's message handler.
 
11275
          </p>
 
11276
          <p>Override this method to implement your own message handling.
 
11277
            If the message Result is nonzero, the message already has been handled;
 
11278
            otherwise set the Result to nonzero (depending on the message ID),
 
11279
            when the message has been handled.
 
11280
          </p>
 
11281
        </descr>
 
11282
        <errors/>
 
11283
        <seealso>
 
11284
          <link id="#rtl.System.TObject.DefaultHandler">TObject.DefaultHandler</link>
 
11285
        </seealso>
 
11286
      </element>
 
11287
      <element name="TWinControl.DefaultHandler.AMessage">
 
11288
        <short>The message to process.</short>
 
11289
      </element>
 
11290
      <!-- function Visibility: public -->
 
11291
      <element link="#LCL.Controls.TControl.GetTextLen" name="TWinControl.GetTextLen"/>
 
11292
      <element name="TWinControl.GetTextLen.Result">
 
11293
        <short/>
 
11294
      </element>
 
11295
      <!-- procedure Visibility: public -->
 
11296
      <element name="TWinControl.Invalidate">
 
11297
        <short>Schedule an repaint request.
 
11298
        </short>
 
11299
        <descr>This implementation invokes the Invalidate method of the widget.
 
11300
        </descr>
 
11301
        <errors/>
 
11302
        <seealso/>
 
11303
      </element>
 
11304
      <!-- procedure Visibility: public -->
 
11305
      <element name="TWinControl.AddControl">
 
11306
        <short>Tell widgetset to add Handle object to parent's Handle object.
 
11307
        </short>
 
11308
        <descr/>
 
11309
        <errors/>
 
11310
        <seealso/>
 
11311
      <notes><note>?</note>
 
11312
        </notes>
 
11313
      </element>
 
11314
      <!-- procedure Visibility: public -->
 
11315
      <element name="TWinControl.InsertControl">
 
11316
        <short>Insert control into Controls[].
 
11317
        </short>
 
11318
      </element>
 
11319
      <element name="TWinControl.InsertControl.AControl">
 
11320
        <short>The control to insert.</short>
 
11321
      </element>
 
11322
      <element name="TWinControl.InsertControl.Index">
 
11323
        <short>Insert at index (optional).</short>
 
11324
      </element>
 
11325
      <!-- procedure Visibility: public -->
 
11326
      <element name="TWinControl.RemoveControl">
 
11327
        <short>Remove control from Controls[].</short>
 
11328
        <descr/>
 
11329
        <errors/>
 
11330
        <seealso/>
 
11331
      </element>
 
11332
      <element name="TWinControl.RemoveControl.AControl">
 
11333
        <short>The control to remove.</short>
 
11334
      </element>
 
11335
      <!-- procedure Visibility: public -->
 
11336
      <element link="#LCL.Controls.TControl.Repaint" name="TWinControl.Repaint"/>
 
11337
      <!-- procedure Visibility: protected -->
 
11338
      <element link="#LCL.Controls.TControl.Update" name="TWinControl.Update"/>
 
11339
      <!-- procedure Visibility: public -->
 
11340
      <element name="TWinControl.SetFocus">
 
11341
        <descr/>
 
11342
        <errors/>
 
11343
        <seealso/>
 
11344
      </element>
 
11345
      <!-- procedure Visibility: public -->
 
11346
      <element name="TWinControl.FlipChildren">
 
11347
        <short>Flip children horizontally. That means mirroring the Left position and anchoring.
 
11348
        </short>
 
11349
        <descr>Child controls arranged in left-to-right order appear in right-to-left order after flipping.
 
11350
          All anchors are adjusted accordingly.
 
11351
        </descr>
 
11352
        <errors/>
 
11353
        <seealso>
 
11354
          <link id="TWinControl.DoFlipChildren"/>
 
11355
        </seealso>
 
11356
      </element>
 
11357
      <element name="TWinControl.FlipChildren.AllLevels">
 
11358
        <short>Flip recursive?</short>
 
11359
      </element>
 
11360
      <!-- procedure Visibility: public -->
 
11361
      <element link="TWinControl.ChangeScale" name="TWinControl.ScaleBy"/>
 
11362
      <element name="TWinControl.ScaleBy.Multiplier">
 
11363
        <short/>
 
11364
      </element>
 
11365
      <element name="TWinControl.ScaleBy.Divider">
 
11366
        <short/>
 
11367
      </element>
 
11368
      <!-- function Visibility: public -->
 
11369
      <element name="TWinControl.GetDockCaption">
 
11370
        <short>Returns the caption for the docked control.</short>
 
11371
      </element>
 
11372
      <element name="TWinControl.GetDockCaption.Result">
 
11373
        <short/>
 
11374
      </element>
 
11375
      <element name="TWinControl.GetDockCaption.AControl">
 
11376
        <short/>
 
11377
      </element>
 
11378
      <!-- procedure Visibility: public -->
 
11379
      <element name="TWinControl.UpdateDockCaption">
 
11380
        <short>Updates the Caption to reflect the names of the docked clients.</short>
 
11381
        <descr>
 
11382
          <p>Called when this is a hostdocksite and either the list of docked clients have changed, or one of their captions.</p>
 
11383
          <p>When a control is currently being undocked, but still is in the DockClients list, Exclude is set to this control.</p>
 
11384
        </descr>
 
11385
        <errors/>
 
11386
        <seealso/>
 
11387
      </element>
 
11388
      <element name="TWinControl.UpdateDockCaption.Exclude">
 
11389
        <short>Control to exclude from the DockCaption.</short>
 
11390
      </element>
 
11391
      <!-- procedure Visibility: public -->
 
11392
      <element name="TWinControl.GetTabOrderList">
 
11393
        <short>Fill the list with all TabStop controls, recursing into child controls.</short>
 
11394
        <descr/>
 
11395
        <errors/>
 
11396
        <seealso/>
 
11397
      </element>
 
11398
      <element name="TWinControl.GetTabOrderList.List">
 
11399
        <short>The list to which the controls shall be added.</short>
 
11400
      </element>
 
11401
      <!-- function Visibility: public -->
 
11402
      <element name="TWinControl.HandleAllocated">
 
11403
        <short>Check whether a widget has been assigned to this control.
 
11404
        </short>
 
11405
        <descr/>
 
11406
        <errors/>
 
11407
        <seealso/>
 
11408
      </element>
 
11409
      <element name="TWinControl.HandleAllocated.Result">
 
11410
        <short>True when a widget exists (Handle is not Nil).</short>
 
11411
      </element>
 
11412
      <!-- function Visibility: protected -->
 
11413
      <element link="#LCL.Controls.TControl.ParentHandlesAllocated" name="TWinControl.ParentHandlesAllocated"/>
 
11414
      <element name="TWinControl.ParentHandlesAllocated.Result">
 
11415
        <short/>
 
11416
      </element>
 
11417
      <!-- procedure Visibility: public -->
 
11418
      <element name="TWinControl.HandleNeeded">
 
11419
        <short>Call this method when your code requires a valid Handle for this control.
 
11420
        </short>
 
11421
        <descr>
 
11422
          <p>An attempt is made to create a widget, when not already done.</p>
 
11423
          <remark>In certain situations it may be impossible to create a widget right now!</remark>
 
11424
        </descr>
 
11425
        <errors/>
 
11426
        <seealso/>
 
11427
      </element>
 
11428
      <!-- function Visibility: public -->
 
11429
      <element name="TWinControl.BrushCreated">
 
11430
        <short>Has a <link id="TWinControl.Brush">Brush</link>
 
11431
          been created for this control?</short>
 
11432
        <descr/>
 
11433
        <errors/>
 
11434
        <seealso/>
 
11435
      </element>
 
11436
      <element name="TWinControl.BrushCreated.Result">
 
11437
        <short>True when a Brush has been created.</short>
 
11438
      </element>
 
11439
      <!-- procedure Visibility: public -->
 
11440
      <element name="TWinControl.EraseBackground">
 
11441
        <short>Fills the entire control with the designed background color and pattern.
 
11442
        </short>
 
11443
        <descr>
 
11444
          <p>This method can be called during Paint requests only, which provide an valid DC.
 
11445
          </p>
 
11446
          <p>The background may be transparent or non-rectangular as well!
 
11447
          </p>
 
11448
        </descr>
 
11449
        <errors/>
 
11450
        <seealso/>
 
11451
      <notes><note>?</note>
 
11452
        </notes>
 
11453
      </element>
 
11454
      <element name="TWinControl.EraseBackground.DC">
 
11455
        <short>The device context to use; may be clipped to a certain shape.</short>
 
11456
      <notes><note>?</note>
 
11457
        </notes>
 
11458
      </element>
 
11459
      <!-- function Visibility: public -->
 
11460
      <element name="TWinControl.IntfUTF8KeyPress">
 
11461
        <short>Called by the interface after the navigation and specials keys are handled;
 
11462
          i.e. after KeyDown but before KeyPress.
 
11463
        </short>
 
11464
        <descr>Essentially expands an repeat count into multiple keystrokes,
 
11465
          but not for SysKeys.
 
11466
        </descr>
 
11467
        <errors/>
 
11468
        <seealso/>
 
11469
      <notes><note>?</note>
 
11470
        </notes>
 
11471
      </element>
 
11472
      <element name="TWinControl.IntfUTF8KeyPress.Result">
 
11473
        <short>True when multiple keystrokes have been processed.</short>
 
11474
      </element>
 
11475
      <element name="TWinControl.IntfUTF8KeyPress.UTF8Key">
 
11476
        <short>The UTF-8 encoding of the character.</short>
 
11477
      </element>
 
11478
      <element name="TWinControl.IntfUTF8KeyPress.RepeatCount">
 
11479
        <short>Must be greater than zero, the exact value is ignored</short>
 
11480
      <notes><note>?</note>
 
11481
        </notes>
 
11482
      </element>
 
11483
      <element name="TWinControl.IntfUTF8KeyPress.SystemKey">
 
11484
        <short>Must be False, else nothing happens.</short>
 
11485
      <notes><note>?</note>
 
11486
        </notes>
 
11487
      </element>
 
11488
      <!-- procedure Visibility: public -->
 
11489
      <element name="TWinControl.PaintTo">
 
11490
        <short>Paints only when a widget exists.</short>
 
11491
        <descr/>
 
11492
        <errors/>
 
11493
        <seealso/>
 
11494
      <notes><note>what?</note>
 
11495
        </notes>
 
11496
      </element>
 
11497
      <element name="TWinControl.PaintTo.DC">
 
11498
        <short/>
 
11499
      </element>
 
11500
      <element name="TWinControl.PaintTo.X">
 
11501
        <short/>
 
11502
      </element>
 
11503
      <element name="TWinControl.PaintTo.Y">
 
11504
        <short/>
 
11505
      </element>
 
11506
      <element name="TWinControl.PaintTo.ACanvas">
 
11507
        <short/>
 
11508
      </element>
 
11509
      <!-- procedure Visibility: public -->
 
11510
      <element name="TWinControl.SetShape">
 
11511
        <short>Specifies the (non-rectangular) shape of the widget.
 
11512
        </short>
 
11513
        <descr/>
 
11514
        <errors/>
 
11515
        <seealso/>
 
11516
      </element>
 
11517
      <element name="TWinControl.SetShape.AShape">
 
11518
        <short/>
 
11519
      </element>
 
11520
      <!-- property Visibility: protected -->
 
11521
      <element name="TWinControl.BorderStyle">
 
11522
        <short>Allows to show a border (line) around the control,
 
11523
        </short>
 
11524
        <seealso>
 
11525
          <link id="TWinControl.BorderWidth"/>
 
11526
        </seealso>
 
11527
      </element>
 
11528
      <!-- property Visibility: public -->
 
11529
      <element name="TWinControl.BorderWidth">
 
11530
        <short>Width of the Border around the control; default is zero.
 
11531
        </short>
 
11532
        <seealso>
 
11533
          <link id="TWinControl.BorderStyle"/>
 
11534
        </seealso>
 
11535
      </element>
 
11536
      <!-- property Visibility: public -->
 
11537
      <element name="TWinControl.BoundsLockCount">
 
11538
        <short>For internal use: When greater zero, updates of the BoundsRect are blocked.
 
11539
        </short>
 
11540
      </element>
 
11541
      <!-- property Visibility: public -->
 
11542
      <element name="TWinControl.Brush">
 
11543
        <short>The Brush used to paint the background of the control.
 
11544
        </short>
 
11545
        <seealso>
 
11546
          <link id="#lcl.graphics.TBrush"/>
 
11547
        </seealso>
 
11548
      </element>
 
11549
      <!-- property Visibility: public -->
 
11550
      <element name="TWinControl.CachedClientHeight">
 
11551
        <short>The intended ClientHeight, as sent to the widget.
 
11552
        </short>
 
11553
      </element>
 
11554
      <!-- property Visibility: public -->
 
11555
      <element name="TWinControl.CachedClientWidth">
 
11556
        <short>The intended ClientWidth, as sent to the widget.
 
11557
        </short>
 
11558
      </element>
 
11559
      <!-- property Visibility: public -->
 
11560
      <element name="TWinControl.ChildSizing">
 
11561
        <short>Parameters for child control arrangement and spacing.
 
11562
        </short>
 
11563
        <seealso>
 
11564
          <link id="#lcl.Controls.TControlChildSizing"/>
 
11565
        </seealso>
 
11566
      </element>
 
11567
      <!-- property Visibility: public -->
 
11568
      <element name="TWinControl.ControlCount">
 
11569
        <short>The number of immediate child controls.
 
11570
        </short>
 
11571
        <seealso>
 
11572
          <link id="TWinControl.Controls"/>
 
11573
        </seealso>
 
11574
      </element>
 
11575
      <!-- property Visibility: public -->
 
11576
      <element name="TWinControl.Controls">
 
11577
        <short>The indexed list of immediate child controls.</short>
 
11578
        <descr>The index also indicates the Z-order of the children, zero for topmost
 
11579
        </descr>
 
11580
        <seealso>
 
11581
          <link id="TWinControl.ControlCount"/>
 
11582
        </seealso>
 
11583
      <notes><note>?</note>
 
11584
        </notes>
 
11585
      </element>
 
11586
      <element name="TWinControl.Controls.Index">
 
11587
        <short>Index of the requested control.</short>
 
11588
      </element>
 
11589
      <!-- property Visibility: public -->
 
11590
      <element name="TWinControl.DefWndProc">
 
11591
        <short>The default WndProc on Windows widgetset and platforms.
 
11592
        </short>
 
11593
      <notes><note>Usage?</note>
 
11594
        </notes>
 
11595
      </element>
 
11596
      <!-- property Visibility: public -->
 
11597
      <element name="TWinControl.DockClientCount">
 
11598
        <short>The number of clients docked into this control.</short>
 
11599
        <descr>
 
11600
          <p>The docked controls can be accessed in<link id="TWinControl.DockClients">DockClients[]</link>.</p>
 
11601
          <p>
 
11602
            <var>DockClientCount</var> is equivalent to DockClients.Count, but handles the special case when DockClients is Nil.</p>
 
11603
        </descr>
 
11604
        <seealso>
 
11605
          <link id="TWinControl.DockClients"/>
 
11606
        </seealso>
 
11607
      </element>
 
11608
      <!-- property Visibility: public -->
 
11609
      <element name="TWinControl.DockClients">
 
11610
        <short>The indexed list of controls docked into this control.</short>
 
11611
        <seealso>
 
11612
          <link id="TWinControl.DockClientCount"/>
 
11613
        </seealso>
 
11614
      </element>
 
11615
      <element name="TWinControl.DockClients.Index">
 
11616
        <short>Index of the requested docked client.</short>
 
11617
      </element>
 
11618
      <!-- property Visibility: public -->
 
11619
      <element name="TWinControl.DockManager">
 
11620
        <short>The docking layout manager for this control.</short>
 
11621
        <descr>
 
11622
          <p>A docksite can be managed (using an DockManager) or unmanaged (positioning docked controls in the event handlers).
 
11623
            The DockManager determines the placement of docked controls,
 
11624
            by setting DropOnControl and DropAlign before the drop,
 
11625
            and by resizing and positioning the control when it's dropped.</p>
 
11626
          <p>A DockManager is used only when UseDockManager also is True.
 
11627
            Setting UseDockManager to True creates an DockManager of the DefaultDockManagerClass for this docksite, if none was previously installed.</p>
 
11628
          <p>An unmanaged docksite, without an DockManager,
 
11629
            can handle the placement of dropped controls in the OnDockOver and OnDockDrop event handlers.</p>
 
11630
        </descr>
 
11631
        <seealso>
 
11632
          <link id="TWinControl.UseDockManager"/>
 
11633
          <link id="TWinControl.DockSite"/>
 
11634
          <link id="TWinControl.OnDockDrop"/>
 
11635
          <link id="TWinControl.OnDockOver"/>
 
11636
          <link id="TDockManager"/>
 
11637
        </seealso>
 
11638
      </element>
 
11639
      <!-- property Visibility: public -->
 
11640
      <element name="TWinControl.DockSite">
 
11641
        <short>Allows to drag-dock other controls into this control.
 
11642
        </short>
 
11643
        <descr>
 
11644
          <p>A DockSite reacts on controls dragged over this control,
 
11645
            signals acceptance and where a dragged control would be dropped.
 
11646
          </p>
 
11647
          <remark>A DockSite should initially be empty, not containing any child controls.
 
11648
          </remark>
 
11649
        </descr>
 
11650
        <seealso>
 
11651
          <link id="TWinControl.DockManager"/>
 
11652
          <link id="TWinControl.UseDockManager"/>
 
11653
        </seealso>
 
11654
      </element>
 
11655
      <!-- property Visibility: public -->
 
11656
      <element name="TWinControl.DoubleBuffered">
 
11657
        <short>Allows to reduce flicker in the painting of the control.</short>
 
11658
        <descr>
 
11659
          <p>Paint requests typically are buffered in the message queue.
 
11660
            When a paint message arrives, all elements of the control are drawn onto the screen,
 
11661
            according to their type, style, state and content.
 
11662
          </p>
 
11663
          <p>This can cause flicker, when stacked controls wipe out preceding paintings,
 
11664
            e.g. when unchanged text is erased from the screen before it is painted again,
 
11665
            when it takes some time to retrieve the text of list entries,
 
11666
            or wrapping long text at the current control boundaries.
 
11667
            Owner-drawing also can cause noticeable flicker.
 
11668
          </p>
 
11669
          <p>To reduce such flicker, DoubleBuffered controls use a buffer bitmap
 
11670
            into which all painting is redirected.
 
11671
            When the bitmap has been updated, a paint request is queued for the control.
 
11672
            When that paint request is received again,
 
11673
            the prepared bitmap is output in one fast BitBlt transfer, eliminating any flicker.
 
11674
          </p>
 
11675
          <p>All this happens automatically, when DoubleBuffered is set to True,
 
11676
            no further changes are required in application or custom control code.
 
11677
          </p>
 
11678
        </descr>
 
11679
      </element>
 
11680
      <!-- property Visibility: public -->
 
11681
      <element name="TWinControl.Handle">
 
11682
        <short>A reference to the widget, associated with this control.
 
11683
        </short>
 
11684
      </element>
 
11685
      <!-- property Visibility: public -->
 
11686
      <element name="TWinControl.IsResizing">
 
11687
        <short>Check IsResizing and drop or delay changes to the control,
 
11688
          until the new size has been determined.
 
11689
        </short>
 
11690
      </element>
 
11691
      <element name="TWinControl.OnAlignInsertBefore">
 
11692
        <short>Handler for custom-aligned child controls,
 
11693
          determines the order of control placement.
 
11694
        </short>
 
11695
      </element>
 
11696
      <element name="TWinControl.OnAlignPosition">
 
11697
        <short>Handler for custom-aligned child controls,
 
11698
          determines the position of the child control.
 
11699
        </short>
 
11700
      </element>
 
11701
      <!-- property Visibility: public -->
 
11702
      <element name="TWinControl.OnDockDrop">
 
11703
        <short>Notification handler for the drop of a control to be docked.</short>
 
11704
      </element>
 
11705
      <!-- property Visibility: public -->
 
11706
      <element name="TWinControl.OnDockOver">
 
11707
        <short>Event handler for moves of a control over this docksite.
 
11708
          Determines acceptance or rejection of an possible drop.
 
11709
        </short>
 
11710
      </element>
 
11711
      <!-- property Visibility: public -->
 
11712
      <element name="TWinControl.OnEnter">
 
11713
        <short>Handler for control receiving the focus.
 
11714
        </short>
 
11715
      </element>
 
11716
      <!-- property Visibility: public -->
 
11717
      <element name="TWinControl.OnExit">
 
11718
        <short>Handler for control loosing the focus.
 
11719
          This is a good place for checking the finished user input.
 
11720
        </short>
 
11721
      </element>
 
11722
      <!-- property Visibility: protected -->
 
11723
      <element name="TWinControl.OnGetDockCaption">
 
11724
        <short>This handler can provide a special DockCaption,
 
11725
          different from the Caption default.
 
11726
        </short>
 
11727
        <descr/>
 
11728
        <seealso/>
 
11729
      </element>
 
11730
      <!-- property Visibility: protected -->
 
11731
      <element name="TWinControl.OnGetSiteInfo">
 
11732
        <short>Provides information about the DockSite.
 
11733
        </short>
 
11734
        <descr>
 
11735
          <p>The handler can adjust the InfluenceRect,
 
11736
            within which mouse moves are recognized by this control.
 
11737
          </p>
 
11738
          <p>The handler also can deny any drops, depending on the type of the dragged control.
 
11739
          </p>
 
11740
          <p>This event occurs before OnDockOver.
 
11741
          </p>
 
11742
        </descr>
 
11743
        <seealso>
 
11744
          <link id="TWinControl.OnDockOver"/>
 
11745
        </seealso>
 
11746
      </element>
 
11747
      <!-- property Visibility: public -->
 
11748
      <element name="TWinControl.OnKeyDown">
 
11749
        <short>Handler for
 
11750
          keyboard key pressed.
 
11751
        </short>
 
11752
        <descr>
 
11753
          <p>This handler can filter keys, for special use in e.g. non-textual controls.
 
11754
          </p>
 
11755
          <p>The handler receives all keystrokes, including control and other non-visual keys.
 
11756
            Keys are encoded as <b>virtual</b> keys, with separate active modifier keys.
 
11757
          </p>
 
11758
          <p>Text input instead should be checked in an OnKeyPress handler.
 
11759
          </p>
 
11760
        </descr>
 
11761
        <seealso>
 
11762
          <link id="TWinControl.OnKeyUp"/>
 
11763
          <link id="TWinControl.OnKeyPress"/>
 
11764
        </seealso>
 
11765
      </element>
 
11766
      <!-- property Visibility: public -->
 
11767
      <element name="TWinControl.OnKeyPress">
 
11768
        <short>Handler for a character entered by the user.
 
11769
        </short>
 
11770
        <descr>
 
11771
          <p>This handler only receives characters, not control or other special keycodes.
 
11772
            Control keys should be handled by an OnKeyDown handler instead.
 
11773
          </p>
 
11774
          <p>The handler can convert the character into a different one.
 
11775
          </p>
 
11776
          <remark>We recommend you to use OnUTF8KeyPress to prevent data loss.
 
11777
            Characters are converted from UTF8 to the system encoding in OnKeyPressEvent,
 
11778
            with possible loss of characters outside the Ansi codepage.
 
11779
          </remark>
 
11780
        </descr>
 
11781
        <seealso>
 
11782
          <link id="TWinControl.OnKeyDown"/>
 
11783
          <link id="TWinControl.OnUTF8KeyPress"/>
 
11784
        </seealso>
 
11785
      </element>
 
11786
      <!-- property Visibility: public -->
 
11787
      <element name="TWinControl.OnKeyUp">
 
11788
        <short>Handler for
 
11789
          keyboard key released.
 
11790
        </short>
 
11791
        <descr>
 
11792
          <p>Unlike OnKeyDown, this event occurs only once for auto-repeated keys.
 
11793
          </p>
 
11794
          <p>For details see <link id="TWinControl.OnKeyDown"/>.
 
11795
          </p>
 
11796
        </descr>
 
11797
        <seealso>
 
11798
          <link id="TWinControl.OnKeyDown"/>
 
11799
          <link id="TWinControl.OnKeyPress"/>
 
11800
        </seealso>
 
11801
      </element>
 
11802
      <!-- property Visibility: public -->
 
11803
      <element name="TWinControl.OnUnDock">
 
11804
        <short>Event handler for control being undocked from this DockSite.</short>
 
11805
        <descr>
 
11806
          <p>The handler can disallow undocking.
 
11807
          </p>
 
11808
        </descr>
 
11809
      </element>
 
11810
      <!-- property Visibility: public -->
 
11811
      <element name="TWinControl.OnUTF8KeyPress">
 
11812
        <short>Handler for a character entered by the user.
 
11813
        </short>
 
11814
        <descr>
 
11815
          <p>This handler only receives characters, not control or other special keycodes.
 
11816
            Control keys should be handled by an OnKeyDown handler instead.
 
11817
          </p>
 
11818
          <p>The handler can convert the character into a different one.
 
11819
          </p>
 
11820
          <p>While <link id="TWinControl.OnKeyPress">OnKeyPress</link>
 
11821
            only receives Ansi characters,
 
11822
            with possible loss of characters outside the Ansi codepage,
 
11823
            the OnUTF8KeyPress handler receives the UTF-8 character code.
 
11824
          </p>
 
11825
        </descr>
 
11826
        <seealso>
 
11827
          <link id="TWinControl.OnKeyDown"/>
 
11828
          <link id="TWinControl.OnKeyPress"/>
 
11829
        </seealso>
 
11830
      </element>
 
11831
      <!-- property Visibility: public -->
 
11832
      <element name="TWinControl.ParentWindow">
 
11833
        <short>The Handle of the parent widget.</short>
 
11834
        <descr/>
 
11835
        <seealso/>
 
11836
      <notes><note>Usage?</note>
 
11837
        </notes>
 
11838
      </element>
 
11839
      <!-- property Visibility: public -->
 
11840
      <element name="TWinControl.Showing">
 
11841
        <short>Cached widget visibility, not necessarily in sync with the widget.
 
11842
        </short>
 
11843
        <descr/>
 
11844
        <seealso/>
 
11845
      </element>
 
11846
      <!-- property Visibility: public -->
 
11847
      <element name="TWinControl.TabOrder">
 
11848
        <short>Determines the sequence of controls, reachable when the user presses the Tab key.
 
11849
        </short>
 
11850
        <descr/>
 
11851
        <seealso>
 
11852
          <link id="TWinControl.TabStop"/>
 
11853
        </seealso>
 
11854
      </element>
 
11855
      <!-- property Visibility: public -->
 
11856
      <element name="TWinControl.TabStop">
 
11857
        <short>Allows the user to navigate to this control, by pressing the Tab key.
 
11858
        </short>
 
11859
        <descr/>
 
11860
        <seealso>
 
11861
          <link id="TWinControl.TabOrder"/>
 
11862
        </seealso>
 
11863
      </element>
 
11864
      <!-- property Visibility: public -->
 
11865
      <element name="TWinControl.UseDockManager">
 
11866
        <short>Determines whether a DockManager is used for this DockSite.
 
11867
        </short>
 
11868
        <descr>
 
11869
          <p>When this property becomes True, and DockSite also is True,
 
11870
            a DockManager is created automatically.
 
11871
          </p>
 
11872
          <p>When False an eventually existing DockManager is ignored.
 
11873
          </p>
 
11874
          <p>If you want to use an special DockManager,
 
11875
            install it before setting UseDockManager to True.
 
11876
          </p>
 
11877
        </descr>
 
11878
        <seealso>
 
11879
          <link id="TWinControl.DockSite"/>
 
11880
          <link id="TWinControl.DockManager"/>
 
11881
          <link id="TWinControl.CreateDockManager"/>
 
11882
        </seealso>
 
11883
      </element>
 
11884
      <!-- property Visibility: public -->
 
11885
      <element name="TWinControl.VisibleDockClientCount">
 
11886
        <short>The number of visible docked controls.</short>
 
11887
        <seealso>
 
11888
          <link id="TWinControl.DockClientCount"/>
 
11889
          <link id="TWinControl.DockClients"/>
 
11890
        </seealso>
 
11891
      </element>
 
11892
      <!-- property Visibility: protected -->
 
11893
      <element name="TWinControl.WindowHandle">
 
11894
        <short>For internal use: allows direct access to Handle, bypassing any getter/setter methods.
 
11895
        </short>
 
11896
        <descr/>
 
11897
        <seealso/>
 
11898
      </element>
 
11899
      <!-- object Visibility: default -->
 
11900
      <element name="TGraphicControl">
 
11901
        <short>
 
11902
          <var>TGraphicControl</var> is the base class for all lightweight controls.</short>
 
11903
        <descr>
 
11904
          <p>
 
11905
            <var>TGraphicControl</var> supports simple lightweight controls
 
11906
            that do not need the ability to accept keyboard input or contain other controls.
 
11907
          </p>
 
11908
          <p>If you want to accept keyboard input, or need to support child controls,
 
11909
            use a <var>TCustomControl</var> instead.
 
11910
          </p>
 
11911
          <p>Since lightweight controls do not wrap GUI widgets,
 
11912
            they use fewer resources than controls based on
 
11913
            <var>TWinControl</var>.
 
11914
          </p>
 
11915
          <p>
 
11916
            <var>TGraphicControl</var> provides a
 
11917
            
 
11918
            
 
11919
            <var>Canvas</var> property for access to the control's drawing surface
 
11920
            and a virtual 
 
11921
            
 
11922
            <var>Paint</var> method and an 
 
11923
            
 
11924
            <var>OnPaint</var> handler,
 
11925
            called in response to paint requests received by the parent control.
 
11926
          </p>
 
11927
          <p>Override the Paint method or supply your own OnPaint handler,
 
11928
            to do the actual drawing of the control.
 
11929
          </p>
 
11930
        </descr>
 
11931
        <seealso>
 
11932
          <link id="#lcl.Controls.TCustomControl"/>
 
11933
          <link id="TGraphicControl.Paint"/>
 
11934
          <link id="TGraphicControl.OnPaint"/>
 
11935
          <link id="#lcl.Graphics.TCanvas"/>
 
11936
        </seealso>
 
11937
      </element>
 
11938
      <!-- variable Visibility: private -->
 
11939
      <element link="TGraphicControl.Canvas" name="TGraphicControl.FCanvas"/>
 
11940
      <element link="TGraphicControl.OnPaint" name="TGraphicControl.FOnPaint"/>
 
11941
      <!-- procedure Visibility: private -->
 
11942
      <element name="TGraphicControl.WMPaint">
 
11943
        <short>Event handler for paint messages.</short>
 
11944
      </element>
 
11945
      <element name="TGraphicControl.WMPaint.Message">
 
11946
        <short/>
 
11947
      </element>
 
11948
      <!-- procedure Visibility: protected -->
 
11949
      <element link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass" name="TGraphicControl.WSRegisterClass"/>
 
11950
      <element link="#LCL.Controls.TControl.FontChanged" name="TGraphicControl.FontChanged"/>
 
11951
      <element name="TGraphicControl.FontChanged.Sender">
 
11952
        <short/>
 
11953
      </element>
 
11954
      <!-- procedure Visibility: protected -->
 
11955
      <element name="TGraphicControl.Paint">
 
11956
        <short>Override this method with your own painting code.
 
11957
        </short>
 
11958
        <descr>The default implementation invokes the OnPaint handler.
 
11959
        </descr>
 
11960
        <seealso>
 
11961
          <link id="TGraphicControl.OnPaint"/>
 
11962
        </seealso>
 
11963
      </element>
 
11964
      <!-- procedure Visibility: protected -->
 
11965
      <element link="#LCL.Controls.TControl.DoOnChangeBounds" name="TGraphicControl.DoOnChangeBounds"/>
 
11966
      <!-- procedure Visibility: protected -->
 
11967
      <element name="TGraphicControl.DoOnParentHandleDestruction"/>
 
11968
      <!-- procedure Visibility: public -->
 
11969
      <element name="TGraphicControl.Update"/>
 
11970
      <!-- constructor Visibility: public -->
 
11971
      <element name="TGraphicControl.Create"/>
 
11972
      <element name="TGraphicControl.Create.AOwner"/>
 
11973
      <!-- destructor Visibility: public -->
 
11974
      <element name="TGraphicControl.Destroy"/>
 
11975
      <!-- property Visibility: public -->
 
11976
      <element name="TGraphicControl.Canvas">
 
11977
        <short>A clipped window into the parent Canvas.</short>
 
11978
        <descr>
 
11979
          <p>Don't paint on the entire Canvas!
 
11980
            Instead use the dimensions of the <var>TGraphicControl</var>
 
11981
            stored in the <var>ClientRect</var>.
 
11982
          </p>
 
11983
          <p>If you ask for the <var>Canvas.Width</var> or <var>Canvas.Height</var>,
 
11984
            you are actually getting the Parent control's Canvas dimensions.
 
11985
          </p>
 
11986
        </descr>
 
11987
        <seealso>
 
11988
          <link id="TControl.ClientRect"/>
 
11989
          <link id="TControl.ClientWidth"/>
 
11990
          <link id="TControl.ClientHeight"/>
 
11991
          <link id="#lcl.Graphics.TCanvas">TCanvas</link>
 
11992
          <link id="TControl.BoundsRect"/>
 
11993
        </seealso>
 
11994
      </element>
 
11995
      <!-- property Visibility: public -->
 
11996
      <element name="TGraphicControl.OnPaint">
 
11997
        <short>Supply your own OnPaint handler for painting the control.
 
11998
        </short>
 
11999
        <seealso>
 
12000
          <link id="TGraphicControl.Paint"/>
 
12001
        </seealso>
 
12002
      </element>
 
12003
      <!-- object Visibility: default -->
 
12004
      <element name="TCustomControl">
 
12005
        <short>The base class for windowed controls which paint themselves.
 
12006
        </short>
 
12007
        <descr>
 
12008
          <p>In contrast to TGraphicControl,
 
12009
            a TCustomControl can accept keyboard input (get the Focus)
 
12010
            and can have child controls.
 
12011
          </p>
 
12012
          <p>Override the Paint method or supply your own OnPaint handler,
 
12013
            to do the actual drawing of the control.
 
12014
          </p>
 
12015
        </descr>
 
12016
        <seealso>
 
12017
          <link id="TWinControl"/>
 
12018
          <link id="TGraphicControl"/>
 
12019
        </seealso>
 
12020
      </element>
 
12021
      <!-- variable Visibility: private -->
 
12022
      <element link="TCustomControl.Canvas" name="TCustomControl.FCanvas"/>
 
12023
      <element link="TCustomControl.OnPaint" name="TCustomControl.FOnPaint"/>
 
12024
      <element link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass" name="TCustomControl.WSRegisterClass"/>
 
12025
      <!-- procedure Visibility: protected -->
 
12026
      <element name="TCustomControl.WMPaint">
 
12027
        <short>Event handler for paint messages.</short>
 
12028
      </element>
 
12029
      <element name="TCustomControl.WMPaint.Message">
 
12030
        <short/>
 
12031
      </element>
 
12032
      <!-- procedure Visibility: public -->
 
12033
      <element link="#LCL.Controls.TWinControl.DestroyWnd" name="TCustomControl.DestroyWnd"/>
 
12034
      <!-- procedure Visibility: protected -->
 
12035
      <element link="#LCL.Controls.TWinControl.PaintWindow" name="TCustomControl.PaintWindow">
 
12036
        <short>The Paint handler plug-in, intercepting paint requests.</short>
 
12037
        <descr>PaintWindow prepares the Canvas for painting,
 
12038
          and invokes the Paint method to do the actual painting.
 
12039
        </descr>
 
12040
        <seealso>
 
12041
          <link id="TWinControl.PaintWindow"/>
 
12042
        </seealso>
 
12043
      </element>
 
12044
      <element name="TCustomControl.PaintWindow.DC">
 
12045
        <short>The Device Context in which to paint.</short>
 
12046
      </element>
 
12047
      <!-- procedure Visibility: protected -->
 
12048
      <element link="#LCL.Controls.TControl.FontChanged" name="TCustomControl.FontChanged"/>
 
12049
      <element name="TCustomControl.FontChanged.Sender">
 
12050
        <short/>
 
12051
      </element>
 
12052
      <!-- procedure Visibility: protected -->
 
12053
      <element link="#LCL.Controls.TControl.SetColor" name="TCustomControl.SetColor"/>
 
12054
      <element name="TCustomControl.SetColor.Value">
 
12055
        <short/>
 
12056
      </element>
 
12057
      <!-- procedure Visibility: public -->
 
12058
      <element name="TCustomControl.Paint">
 
12059
        <short>Override this method in your derived class with your own paint handler.
 
12060
        </short>
 
12061
      </element>
 
12062
      <!-- constructor Visibility: public -->
 
12063
      <element name="TCustomControl.Create"/>
 
12064
      <element name="TCustomControl.Create.AOwner"/>
 
12065
      <!-- destructor Visibility: public -->
 
12066
      <element name="TCustomControl.Destroy"/>
 
12067
      <!-- property Visibility: public -->
 
12068
      <element link="#LCL.Controls.TWinControl.BorderStyle" name="TCustomControl.BorderStyle"/>
 
12069
      <!-- property Visibility: public -->
 
12070
      <element name="TCustomControl.Canvas">
 
12071
        <short>The drawing surface for the control,
 
12072
          see <link id="#lcl.Graphics.TCanvas">TCanvas</link> for details.
 
12073
        </short>
 
12074
        <descr/>
 
12075
        <seealso>
 
12076
          <link id="#lcl.Graphics.TCanvas">TCanvas</link>
 
12077
        </seealso>
 
12078
      </element>
 
12079
      <!-- property Visibility: public -->
 
12080
      <element name="TCustomControl.OnPaint">
 
12081
        <short>Supply your own OnPaint handler for painting the control.
 
12082
        </short>
 
12083
        <seealso>
 
12084
          <link id="TCustomControl.Paint"/>
 
12085
        </seealso>
 
12086
      </element>
 
12087
      <!-- object Visibility: default -->
 
12088
      <element link="TDragImageList" name="TImageList"/>
 
12089
      <!-- property Visibility: published -->
 
12090
      <element link="#lcl.ImgList.TCustomImageList.AllocBy" name="TImageList.AllocBy"/>
 
12091
      <element link="#LCL.ImgList.TCustomImageList.BkColor" name="TImageList.BkColor"/>
 
12092
      <element link="#lcl.ImgList.TCustomImageList.BlendColor" name="TImageList.BlendColor"/>
 
12093
      <element link="#LCL.ImgList.TCustomImageList.DrawingStyle" name="TImageList.DrawingStyle"/>
 
12094
      <element link="#LCL.ImgList.TCustomImageList.Height" name="TImageList.Height"/>
 
12095
      <element link="#LCL.ImgList.TCustomImageList.ImageType" name="TImageList.ImageType"/>
 
12096
      <element link="#LCL.ImgList.TCustomImageList.Masked" name="TImageList.Masked"/>
 
12097
      <element link="#LCL.ImgList.TCustomImageList.OnChange" name="TImageList.OnChange"/>
 
12098
      <element link="#LCL.ImgList.TCustomImageList.ShareImages" name="TImageList.ShareImages"/>
 
12099
      <element link="#LCL.ImgList.TCustomImageList.Width" name="TImageList.Width"/>
 
12100
      <!-- object Visibility: default -->
 
12101
      <element name="TControlPropertyStorage">
 
12102
        <short/>
 
12103
        <descr/>
 
12104
        <errors/>
 
12105
        <seealso/>
 
12106
      <notes><note>?</note>
 
12107
        </notes>
 
12108
      </element>
 
12109
      <!-- procedure Visibility: protected -->
 
12110
      <element name="TControlPropertyStorage.GetPropertyList">
 
12111
        <short>Parses the <link id="TControl.SessionProperties"/> string
 
12112
          into the given list.
 
12113
        </short>
 
12114
        <descr/>
 
12115
        <errors/>
 
12116
        <seealso/>
 
12117
      </element>
 
12118
      <element name="TControlPropertyStorage.GetPropertyList.List">
 
12119
        <short/>
 
12120
      </element>
 
12121
      <!-- object Visibility: default -->
 
12122
      <element name="TDockZone">
 
12123
        <short>Represents an node in an <link id="#lcl.Controls.TDockTree">TDockTree</link>.</short>
 
12124
        <descr>
 
12125
          <p>It encapsulates a dock zone, containing either other zones or a single control.
 
12126
          </p>
 
12127
          <p>This implementation is specific to <link id="TDockTree"/>/LDockTree. Every DockManager can (should!) use its own class instead.
 
12128
          </p>
 
12129
        </descr>
 
12130
      </element>
 
12131
      <!-- variable Visibility: private -->
 
12132
      <element link="TDockZone.Bounds" name="TDockZone.FBounds"/>
 
12133
      <element link="TDockZone.ChildControl" name="TDockZone.FChildControl"/>
 
12134
      <element link="TDockZone.ChildCount" name="TDockZone.FChildCount"/>
 
12135
      <element link="TDockZone.FirstChild" name="TDockZone.FFirstChildZone"/>
 
12136
      <element link="TDockZone.NextSibling" name="TDockZone.FNextSibling"/>
 
12137
      <element link="TDockZone.Orientation" name="TDockZone.FOrientation"/>
 
12138
      <element link="TDockZone.Parent" name="TDockZone.FParentZone"/>
 
12139
      <element link="TDockZone.PrevSibling" name="TDockZone.FPrevSibling"/>
 
12140
      <element link="TDockZone.Tree" name="TDockZone.FTree"/>
 
12141
      <!-- function Visibility: private -->
 
12142
      <element link="TDockZone.Height" name="TDockZone.GetHeight"/>
 
12143
      <element name="TDockZone.GetHeight.Result">
 
12144
        <short/>
 
12145
      </element>
 
12146
      <!-- function Visibility: private -->
 
12147
      <element link="TDockZone.Left" name="TDockZone.GetLeft"/>
 
12148
      <element name="TDockZone.GetLeft.Result">
 
12149
        <short/>
 
12150
      </element>
 
12151
      <!-- function Visibility: private -->
 
12152
      <element link="TDockZone.LimitBegin" name="TDockZone.GetLimitBegin"/>
 
12153
      <element name="TDockZone.GetLimitBegin.Result">
 
12154
        <short/>
 
12155
      </element>
 
12156
      <!-- function Visibility: private -->
 
12157
      <element link="TDockZone.LimitSize" name="TDockZone.GetLimitSize"/>
 
12158
      <element name="TDockZone.GetLimitSize.Result">
 
12159
        <short/>
 
12160
      </element>
 
12161
      <!-- function Visibility: private -->
 
12162
      <element link="TDockZone.Top" name="TDockZone.GetTop"/>
 
12163
      <element name="TDockZone.GetTop.Result">
 
12164
        <short/>
 
12165
      </element>
 
12166
      <!-- function Visibility: private -->
 
12167
      <element link="TDockZone.Visible" name="TDockZone.GetVisible"/>
 
12168
      <element name="TDockZone.GetVisible.Result">
 
12169
        <short/>
 
12170
      </element>
 
12171
      <!-- function Visibility: private -->
 
12172
      <element name="TDockZone.GetVisibleChildCount">
 
12173
        <short>The number of visible children.</short>
 
12174
        <descr/>
 
12175
        <errors/>
 
12176
        <seealso>
 
12177
          <link id="TDockZone.Visible"/>
 
12178
        </seealso>
 
12179
      </element>
 
12180
      <element name="TDockZone.GetVisibleChildCount.Result">
 
12181
        <short/>
 
12182
      </element>
 
12183
      <!-- function Visibility: private -->
 
12184
      <element link="TDockZone.Width" name="TDockZone.GetWidth"/>
 
12185
      <element name="TDockZone.GetWidth.Result">
 
12186
        <short/>
 
12187
      </element>
 
12188
      <!-- function Visibility: private -->
 
12189
      <element name="TDockZone.GetNextVisibleZone">
 
12190
        <short>The next visible zone.</short>
 
12191
        <descr/>
 
12192
        <errors/>
 
12193
        <seealso>
 
12194
          <link id="TDockZone.Visible"/>
 
12195
        </seealso>
 
12196
      </element>
 
12197
      <element name="TDockZone.GetNextVisibleZone.Result">
 
12198
        <short>The zone, or Nil if none found.</short>
 
12199
      </element>
 
12200
      <!-- constructor Visibility: public -->
 
12201
      <element name="TDockZone.Create"/>
 
12202
      <element name="TDockZone.Create.TheTree">
 
12203
        <short>The dock tree to which this zone belongs.</short>
 
12204
      </element>
 
12205
      <element name="TDockZone.Create.TheChildControl">
 
12206
        <short>The control in this zone (may be Nil).</short>
 
12207
      </element>
 
12208
      <!-- function Visibility: public -->
 
12209
      <element name="TDockZone.FindZone">
 
12210
        <short>Returns the Dockzone containing the given control.</short>
 
12211
        <descr/>
 
12212
        <errors/>
 
12213
        <seealso/>
 
12214
      </element>
 
12215
      <element name="TDockZone.FindZone.Result">
 
12216
        <short>The zone containing AControl as ChildControl.</short>
 
12217
      </element>
 
12218
      <element name="TDockZone.FindZone.AControl">
 
12219
        <short/>
 
12220
      </element>
 
12221
      <!-- procedure Visibility: public -->
 
12222
      <element name="TDockZone.AddAsFirstChild">
 
12223
        <short>Adds the given zone as the first child.</short>
 
12224
        <descr/>
 
12225
        <errors/>
 
12226
        <seealso/>
 
12227
      </element>
 
12228
      <element name="TDockZone.AddAsFirstChild.NewChildZone">
 
12229
        <short>The zone to add.</short>
 
12230
      </element>
 
12231
      <!-- procedure Visibility: public -->
 
12232
      <element name="TDockZone.AddAsLastChild">
 
12233
        <short>Adds the given zone as the last child.</short>
 
12234
        <descr/>
 
12235
        <errors/>
 
12236
        <seealso/>
 
12237
      </element>
 
12238
      <element name="TDockZone.AddAsLastChild.NewChildZone">
 
12239
        <short>The zone to add.</short>
 
12240
      </element>
 
12241
      <!-- procedure Visibility: public -->
 
12242
      <element name="TDockZone.ReplaceChild">
 
12243
        <short>Replace the
 
12244
          <var>OldChild</var> zone by
 
12245
          <var>NewChild</var>.
 
12246
        </short>
 
12247
        <descr/>
 
12248
        <errors/>
 
12249
        <seealso/>
 
12250
      </element>
 
12251
      <element name="TDockZone.ReplaceChild.OldChild">
 
12252
        <short>The zone to unlink.</short>
 
12253
      </element>
 
12254
      <element name="TDockZone.ReplaceChild.NewChild">
 
12255
        <short>The zone to link in place of OldChild.</short>
 
12256
      </element>
 
12257
      <!-- function Visibility: public -->
 
12258
      <element name="TDockZone.GetLastChild">
 
12259
        <short>The last child zone.</short>
 
12260
        <descr/>
 
12261
        <errors/>
 
12262
        <seealso/>
 
12263
      </element>
 
12264
      <element name="TDockZone.GetLastChild.Result">
 
12265
        <short/>
 
12266
      </element>
 
12267
      <!-- function Visibility: public -->
 
12268
      <element name="TDockZone.GetIndex">
 
12269
        <short>Calculates the index of the zone within its parent zone.</short>
 
12270
        <descr/>
 
12271
        <errors/>
 
12272
        <seealso/>
 
12273
      </element>
 
12274
      <element name="TDockZone.GetIndex.Result">
 
12275
        <short/>
 
12276
      </element>
 
12277
      <!-- procedure Visibility: public -->
 
12278
      <element name="TDockZone.Remove">
 
12279
        <short>Unlinks the given child zone.</short>
 
12280
        <descr/>
 
12281
        <errors/>
 
12282
        <seealso/>
 
12283
      </element>
 
12284
      <element name="TDockZone.Remove.ChildZone">
 
12285
        <short/>
 
12286
      </element>
 
12287
      <element name="TDockZone.AddSibling">
 
12288
        <short>Inserts NewZone as preceding or following sibling.</short>
 
12289
        <descr/>
 
12290
      </element>
 
12291
      <element name="TDockZone.AddSibling.NewZone">
 
12292
        <short>The zone to add.</short>
 
12293
      </element>
 
12294
      <element name="TDockZone.AddSibling.InsertAt">
 
12295
        <short>How to add the zone.</short>
 
12296
      </element>
 
12297
      <!-- property Visibility: public -->
 
12298
      <element name="TDockZone.NextSibling">
 
12299
        <short>The next sibling zone.</short>
 
12300
        <descr/>
 
12301
        <seealso/>
 
12302
      </element>
 
12303
      <!-- property Visibility: public -->
 
12304
      <element name="TDockZone.PrevSibling">
 
12305
        <short>The preceding sibling zone.</short>
 
12306
        <descr/>
 
12307
        <seealso/>
 
12308
      </element>
 
12309
      <!-- function Visibility: public -->
 
12310
      <element name="TDockZone.FirstVisibleChild">
 
12311
        <short>The first visible child zone.</short>
 
12312
        <descr/>
 
12313
        <errors/>
 
12314
        <seealso>
 
12315
          <link id="TDockZone.Visible"/>
 
12316
        </seealso>
 
12317
      </element>
 
12318
      <element name="TDockZone.FirstVisibleChild.Result">
 
12319
        <short/>
 
12320
      </element>
 
12321
      <!-- function Visibility: public -->
 
12322
      <element name="TDockZone.NextVisible">
 
12323
        <short>The next visible zone.</short>
 
12324
        <descr/>
 
12325
        <errors/>
 
12326
        <seealso>
 
12327
          <link id="TDockZone.Visible"/>
 
12328
        </seealso>
 
12329
      </element>
 
12330
      <element name="TDockZone.NextVisible.Result">
 
12331
        <short/>
 
12332
      </element>
 
12333
      <!-- function Visibility: public -->
 
12334
      <element name="TDockZone.PrevVisible">
 
12335
        <short>The preceding visible zone.</short>
 
12336
        <descr/>
 
12337
        <errors/>
 
12338
        <seealso>
 
12339
          <link id="TDockZone.Visible"/>
 
12340
        </seealso>
 
12341
      </element>
 
12342
      <element name="TDockZone.PrevVisible.Result">
 
12343
        <short/>
 
12344
      </element>
 
12345
      <!-- property Visibility: public -->
 
12346
      <element name="TDockZone.Tree">
 
12347
        <short>The dock tree of which this dock zone is a part.</short>
 
12348
        <descr/>
 
12349
        <seealso/>
 
12350
      </element>
 
12351
      <!-- property Visibility: public -->
 
12352
      <element name="TDockZone.ChildControl">
 
12353
        <short>The control docked in this zone.</short>
 
12354
        <descr>A zone can contain nothing, a control, or child zones.
 
12355
        </descr>
 
12356
        <seealso/>
 
12357
      </element>
 
12358
      <!-- property Visibility: public -->
 
12359
      <element name="TDockZone.ChildCount">
 
12360
        <short>The number of child zones.</short>
 
12361
        <descr/>
 
12362
        <seealso/>
 
12363
      </element>
 
12364
      <!-- property Visibility: public -->
 
12365
      <element name="TDockZone.FirstChild">
 
12366
        <short>The first child zone.</short>
 
12367
        <descr/>
 
12368
        <seealso/>
 
12369
      </element>
 
12370
      <!-- property Visibility: public -->
 
12371
      <element name="TDockZone.Height">
 
12372
        <short>The height of the zone.</short>
 
12373
        <descr/>
 
12374
        <seealso/>
 
12375
      </element>
 
12376
      <element link="TDockZone.Height" name="TDockZone.SetHeight"/>
 
12377
      <element name="TDockZone.SetHeight.AValue">
 
12378
        <short/>
 
12379
      </element>
 
12380
      <!-- property Visibility: public -->
 
12381
      <element name="TDockZone.Left">
 
12382
        <short>The left coordinate of the zone.</short>
 
12383
        <descr/>
 
12384
        <seealso/>
 
12385
      </element>
 
12386
      <element link="TDockZone.Left" name="TDockZone.SetLeft"/>
 
12387
      <element name="TDockZone.SetLeft.AValue">
 
12388
        <short/>
 
12389
      </element>
 
12390
      <!-- property Visibility: public -->
 
12391
      <element name="TDockZone.LimitBegin">
 
12392
        <short>The free coordinate of the DockZone (Left or Top).</short>
 
12393
        <descr/>
 
12394
        <seealso/>
 
12395
      </element>
 
12396
      <element link="TDockZone.LimitBegin" name="TDockZone.SetLimitBegin"/>
 
12397
      <element name="TDockZone.SetLimitBegin.AValue">
 
12398
        <short/>
 
12399
      </element>
 
12400
      <!-- property Visibility: public -->
 
12401
      <element name="TDockZone.LimitSize">
 
12402
        <short>The free size of the DockZone (Width or Height).</short>
 
12403
        <descr/>
 
12404
        <seealso/>
 
12405
      </element>
 
12406
      <element link="TDockZone.LimitSize" name="TDockZone.SetLimitSize"/>
 
12407
      <element name="TDockZone.SetLimitSize.AValue">
 
12408
        <short/>
 
12409
      </element>
 
12410
      <!-- property Visibility: public -->
 
12411
      <element link="TDockOrientation" name="TDockZone.Orientation">
 
12412
        <short>Whether docking is oriented vertically, horizontally, in pages, or not at all</short>
 
12413
        <descr>
 
12414
          <ul>
 
12415
            <li>doNoOrient: zone contains a TControl and no child zones.</li>
 
12416
            <li>doHorizontal: zone's children are stacked top-to-bottom.</li>
 
12417
            <li>doVertical: zone's children are arranged left-to-right.</li>
 
12418
            <li>doPages: zone's children are pages arranged left-to-right.</li>
 
12419
          </ul>
 
12420
        </descr>
 
12421
        <seealso/>
 
12422
      </element>
 
12423
      <!-- property Visibility: public -->
 
12424
      <element name="TDockZone.Parent">
 
12425
        <short>The parent zone in the DockTree.</short>
 
12426
        <descr/>
 
12427
        <seealso/>
 
12428
      </element>
 
12429
      <!-- property Visibility: public -->
 
12430
      <element name="TDockZone.Top">
 
12431
        <short>The top coordinate of this zone.</short>
 
12432
        <descr/>
 
12433
        <seealso/>
 
12434
      </element>
 
12435
      <element link="TDockZone.Top" name="TDockZone.SetTop"/>
 
12436
      <element name="TDockZone.SetTop.AValue">
 
12437
        <short/>
 
12438
      </element>
 
12439
      <!-- property Visibility: public -->
 
12440
      <element name="TDockZone.Visible">
 
12441
        <short>A zone is visible if it contains a visible control, or if any child zone is visible.
 
12442
        </short>
 
12443
        <descr/>
 
12444
        <seealso>
 
12445
          <link id="TDockZone.VisibleChildCount"/>
 
12446
        </seealso>
 
12447
      </element>
 
12448
      <!-- property Visibility: public -->
 
12449
      <element name="TDockZone.VisibleChildCount">
 
12450
        <short>The number of visible child zones.</short>
 
12451
        <descr/>
 
12452
        <seealso/>
 
12453
      </element>
 
12454
      <!-- property Visibility: public -->
 
12455
      <element name="TDockZone.Width">
 
12456
        <short>The width of this zone.</short>
 
12457
        <descr/>
 
12458
        <seealso/>
 
12459
      </element>
 
12460
      <element link="TDockZone.Width" name="TDockZone.SetWidth"/>
 
12461
      <element name="TDockZone.SetWidth.AValue">
 
12462
        <short/>
 
12463
      </element>
 
12464
      <!-- "class of" type Visibility: default -->
 
12465
      <element name="TDockZoneClass">
 
12466
        <short>Class of <link id="TDockZone"/>.</short>
 
12467
      </element>
 
12468
      <!-- procedure type Visibility: default -->
 
12469
      <element name="TForEachZoneProc">
 
12470
        <short>The type of an ForEachZone callback procedure, currently unused.
 
12471
        </short>
 
12472
        <descr/>
 
12473
        <seealso/>
 
12474
      <notes><note>unused?</note>
 
12475
        </notes>
 
12476
      </element>
 
12477
      <element name="TForEachZoneProc.Zone">
 
12478
        <short>The iterated zone.
 
12479
        </short>
 
12480
      </element>
 
12481
      <!-- enumeration type Visibility: default -->
 
12482
      <element name="TDockTreeFlag">
 
12483
        <short/>
 
12484
        <descr/>
 
12485
        <seealso/>
 
12486
      <notes><note>?</note>
 
12487
        </notes>
 
12488
      </element>
 
12489
      <!-- enumeration value Visibility: default -->
 
12490
      <element name="TDockTreeFlag.dtfUpdateAllNeeded">
 
12491
        <short/>
 
12492
      <notes><note>?</note>
 
12493
        </notes>
 
12494
      </element>
 
12495
      <!-- set type Visibility: default -->
 
12496
      <element link="TDockTreeFlag" name="TDockTreeFlags"/>
 
12497
      <!-- object Visibility: default -->
 
12498
      <element name="TDockTree">
 
12499
        <short>A docking manager for tree-style layouts.</short>
 
12500
        <descr>
 
12501
          <p>A tree-style layout is organized in layers of a specific (horizontal or vertical) orientation.
 
12502
            Every node in the tree is either a container for other nodes,
 
12503
            or represents a zone with a single docked control.
 
12504
            All child zones of an node have the same DockOrientation.
 
12505
          </p>
 
12506
          <p>The following documentation is copied from the Controls unit.
 
12507
            It is of historical interest only, since it effectively describes the AnchorDocking,
 
12508
            implemented in TCustomAnchoredDockManager.
 
12509
            AnchorDocking is not related to visual drag-dock procedures,
 
12510
            it merely is an attempt to implement just an layout manager.
 
12511
          <br/>[todo: make this description an topic]
 
12512
          </p>
 
12513
          <remark>The TLazDockTree implementation never was finished,
 
12514
            due to problems with the anchor "docking" mechanism.
 
12515
            Use the EasyDockManager (examples/dockmanager) instead.</remark>
 
12516
          <pre>This is an abstract class. A real implementation is e.g. in ldocktree.pas.
 
12517
 
 
12518
    Docking means here: Combining several windows to one. A window can here be
 
12519
    a TCustomForm or a floating control (undocked) or a TDockForm.
 
12520
    A window can be docked to another to the left, right, top, bottom or "into".
 
12521
    The docking source window will be resized, to fit to the docking target
 
12522
    window.
 
12523
 
 
12524
    Example1: Docking "A" (source window) left to "B" (target window)
 
12525
    
 
12526
       +---+    +----+
 
12527
       | A | -&gt; | B  |
 
12528
       +---+    |    |
 
12529
                +----+
 
12530
      Result: A new docktree will be created. Height of "A" will be resized to
 
12531
              the height of "B".
 
12532
              A splitter will be inserted between "A" and "B".
 
12533
              And all three are children of the newly created TLazDockForm of the
 
12534
              newly created TDockTree.
 
12535
      
 
12536
       +------------+
 
12537
       |+---+|+----+|
 
12538
       || A ||| B  ||
 
12539
       ||   |||    ||
 
12540
       |+---+|+----+|
 
12541
       +------------+
 
12542
 
 
12543
      If "A" or "B" were floating controls, the floating dock sites are freed.
 
12544
      If "A" or "B" were forms, their decorations (title bars and borders) are
 
12545
      replaced by docked decorations.
 
12546
      If "A" had a TDockTree, it is freed and its child dockzones are merged to
 
12547
      the docktree of "B". Analog for docking "C" left to "A":
 
12548
      
 
12549
       +------------------+
 
12550
       |+---+|+---+|+----+|
 
12551
       || C ||| A ||| B  ||
 
12552
       ||   |||   |||    ||
 
12553
       |+---+|+---+|+----+|
 
12554
       +------------------+
 
12555
       
 
12556
 
 
12557
      
 
12558
    Example2: Docking A into B
 
12559
                +-----+
 
12560
       +---+    |     |
 
12561
       | A | ---+-&gt; B |
 
12562
       +---+    |     |
 
12563
                +-----+
 
12564
 
 
12565
      Result: A new docktree will be created. "A" will be resized to the size
 
12566
              of "B". Both will be put into a TLazDockPages control which is the
 
12567
              child of the newly created TDockTree.
 
12568
              
 
12569
       +-------+
 
12570
       |[B][A] |
 
12571
       |+-----+|
 
12572
       ||     ||
 
12573
       || A   ||
 
12574
       ||     ||
 
12575
       |+-----+|
 
12576
       +-------+
 
12577
 
 
12578
    Every DockZone has siblings and children. Siblings can either be
 
12579
    - horizontally (left to right, splitter),
 
12580
    - vertically (top to bottom, splitter)
 
12581
    - or upon each other (as notebook pages).
 
12582
 
 
12583
 
 
12584
    InsertControl - undock control and dock it into the dock site. For example
 
12585
                    dock Form1 left to a Form2:
 
12586
                    InsertControl(Form1,alLeft,Form2);
 
12587
                    To dock "into", into a TDockPage, use Align=alCustom.
 
12588
    PositionDockRect - calculates where a control would be placed, if it would
 
12589
                       be docked via InsertControl.
 
12590
    RemoveControl - removes a control from the dock site.
 
12591
 
 
12592
    GetControlBounds - TODO for Delphi compatibility
 
12593
    ResetBounds - TODO for Delphi compatibility
 
12594
    SetReplacingControl - TODO for Delphi compatibility
 
12595
    PaintSite - TODO for Delphi compatibility
 
12596
 
 
12597
</pre>
 
12598
        </descr>
 
12599
        <seealso>
 
12600
          <link id="#lcl.Controls.TDockManager"/>
 
12601
        </seealso>
 
12602
      </element>
 
12603
      <!-- variable Visibility: private -->
 
12604
      <element name="TDockTree.FBorderWidth">
 
12605
        <short>The width of the border around a dock zone.</short>
 
12606
        <descr/>
 
12607
        <seealso/>
 
12608
      </element>
 
12609
      <!-- variable Visibility: private -->
 
12610
      <element link="TDockTree.DockSite" name="TDockTree.FDockSite"/>
 
12611
      <element link="TDockTree.DockZoneClass" name="TDockTree.FDockZoneClass"/>
 
12612
      <!-- variable Visibility: private -->
 
12613
      <element name="TDockTree.FFlags">
 
12614
        <short/>
 
12615
        <descr/>
 
12616
        <seealso/>
 
12617
      <notes><note>?</note>
 
12618
        </notes>
 
12619
      </element>
 
12620
      <!-- variable Visibility: private -->
 
12621
      <element link="TDockTree.RootZone" name="TDockTree.FRootZone"/>
 
12622
      <element link="TDockTree.BeginUpdate" name="TDockTree.FUpdateCount"/>
 
12623
      <!-- procedure Visibility: private -->
 
12624
      <element link="TDockTree.DockSite" name="TDockTree.SetDockSite"/>
 
12625
      <element name="TDockTree.SetDockSite.AValue">
 
12626
        <short/>
 
12627
      </element>
 
12628
      <!-- property Visibility: public -->
 
12629
      <element name="TDockTree.RootZone">
 
12630
        <short>The root zone of the DockTree.</short>
 
12631
        <descr/>
 
12632
        <seealso/>
 
12633
      </element>
 
12634
      <element link="#LCL.Controls.TDockManager.MouseMessage" name="TDockTree.MouseMessage"/>
 
12635
      <!-- procedure Visibility: private -->
 
12636
      <element name="TDockTree.DeleteZone">
 
12637
        <short>Destroys the zone and its child zones.</short>
 
12638
        <descr/>
 
12639
        <errors/>
 
12640
        <seealso/>
 
12641
      </element>
 
12642
      <element name="TDockTree.DeleteZone.Zone">
 
12643
        <short/>
 
12644
      </element>
 
12645
      <!-- procedure Visibility: protected -->
 
12646
      <element name="TDockTree.AdjustDockRect">
 
12647
        <short>Adjusts the zone rectangle for AControl.</short>
 
12648
        <descr>
 
12649
          <p>ARect initially describes the dockzone into which the control is docked.
 
12650
            From that area the zone decoration is excluded, so that ARect describes the area reserved for the docked control.</p>
 
12651
          <p>AdjustDockRect is not part of the general docking model.
 
12652
            It can implemented and used for any purpose in a dock tree manager.
 
12653
            Most docking managers will replace it by a method with more arguments, that allow to identify the zone and its properties immediately.</p>
 
12654
        </descr>
 
12655
        <errors/>
 
12656
        <seealso/>
 
12657
      </element>
 
12658
      <element name="TDockTree.AdjustDockRect.AControl">
 
12659
        <short/>
 
12660
      </element>
 
12661
      <element name="TDockTree.AdjustDockRect.ARect">
 
12662
        <short/>
 
12663
      </element>
 
12664
      <!-- procedure Visibility: protected -->
 
12665
      <element link="#LCL.Controls.TDockManager.BeginUpdate" name="TDockTree.BeginUpdate"/>
 
12666
      <!-- procedure Visibility: protected -->
 
12667
      <element link="#LCL.Controls.TDockManager.EndUpdate" name="TDockTree.EndUpdate"/>
 
12668
      <!-- procedure Visibility: protected -->
 
12669
      <element link="#LCL.Controls.TDockManager.GetControlBounds" name="TDockTree.GetControlBounds"/>
 
12670
      <element name="TDockTree.GetControlBounds.AControl">
 
12671
        <short/>
 
12672
      </element>
 
12673
      <element name="TDockTree.GetControlBounds.ControlBounds">
 
12674
        <short/>
 
12675
      </element>
 
12676
      <!-- function Visibility: protected -->
 
12677
      <element name="TDockTree.HitTest">
 
12678
        <short>Returns the control and the part of the dockzone, at the given coordinates.
 
12679
        </short>
 
12680
        <descr/>
 
12681
        <errors/>
 
12682
        <seealso/>
 
12683
      </element>
 
12684
      <element name="TDockTree.HitTest.Result">
 
12685
        <short>The docked control.</short>
 
12686
      </element>
 
12687
      <element name="TDockTree.HitTest.MousePos">
 
12688
        <short>The client coordinates.</short>
 
12689
      <notes><note>?</note>
 
12690
        </notes>
 
12691
      </element>
 
12692
      <element name="TDockTree.HitTest.HTFlag">
 
12693
        <short>Returns the zone part at MousePos.</short>
 
12694
      </element>
 
12695
      <!-- procedure Visibility: protected -->
 
12696
      <element name="TDockTree.InsertControl">
 
12697
        <short>Positions <var>DropCtl</var> relative <var>Control</var>, using the alignment specified by <var>InsertAt.</var>
 
12698
        </short>
 
12699
        <descr>
 
12700
          <p>InsertControl determines the layout and appearance of the just docked control, forcing a repaint of the container control if necessary.</p>
 
12701
          <p>When SetReplacingControl has been called with a non-Nil Control before, the dropped control only should replace that control.</p>
 
12702
          <p>A tree docking manager organizes the docksite into layers of horizontol or vertical orientation.
 
12703
            As long as no more than one control is docked into a docksite, the tree has no orientation at all.
 
12704
            The second docked control determines the orientation of the docksite and the dock tree.
 
12705
            All further drops are either isogonal (in direction of the zone orientation) or orthogonal (opposite to the zone orientation).
 
12706
            On an isogonal drop a new leaf zone is created for the dropped control, as a sibling of the already existing child zones.
 
12707
            On an orthogonal drop the zone containing the DropControl becomes the root of another subtree, whose initial members are the leaf zones for Control and DropCtl.</p>
 
12708
          <p>One value of InsertAt (alCustom) is reserved for notebook docking, where DropCtl is replaced by a tabbed notebook, and Control and DropCtl are moved into pages of the notebook.
 
12709
            The notebook is a docksite of its own, further drops into the notebook are handled by the notebook itself, the DockManager of the host docksite is not involved.</p>
 
12710
        </descr>
 
12711
        <errors/>
 
12712
        <seealso>
 
12713
          <link id="TDockManager.RemoveControl"/>
 
12714
        </seealso>
 
12715
      </element>
 
12716
      <element name="TDockTree.InsertControl.AControl">
 
12717
        <short>The control beneath which to place DropControl.</short>
 
12718
      </element>
 
12719
      <element name="TDockTree.InsertControl.InsertAt">
 
12720
        <short>How to insert DropControl.</short>
 
12721
      </element>
 
12722
      <element name="TDockTree.InsertControl.DropControl">
 
12723
        <short>The control to add.</short>
 
12724
      </element>
 
12725
      <element name="TDockTree.DumpLayout">
 
12726
        <short>Stores the layout in an file.</short>
 
12727
      </element>
 
12728
      <element name="TDockTree.DumpLayout.FileName">
 
12729
        <short/>
 
12730
      </element>
 
12731
      <!-- procedure Visibility: protected -->
 
12732
      <element link="TDockManager.LoadFromStream" name="TDockTree.LoadFromStream"/>
 
12733
      <element name="TDockTree.LoadFromStream.SrcStream">
 
12734
        <short/>
 
12735
      </element>
 
12736
      <!-- procedure Visibility: public -->
 
12737
      <element link="TDockManager.MessageHandler" name="TDockTree.MessageHandler"/>
 
12738
      <element name="TDockTree.MessageHandler.Sender">
 
12739
        <short/>
 
12740
      </element>
 
12741
      <element name="TDockTree.MessageHandler.Message">
 
12742
        <short/>
 
12743
      </element>
 
12744
      <!-- procedure Visibility: protected -->
 
12745
      <element name="TDockTree.PaintDockFrame">
 
12746
        <short>Paints the dock header of the zone containing AControl.</short>
 
12747
        <descr/>
 
12748
        <errors/>
 
12749
        <seealso/>
 
12750
      </element>
 
12751
      <element name="TDockTree.PaintDockFrame.ACanvas">
 
12752
        <short/>
 
12753
      </element>
 
12754
      <element name="TDockTree.PaintDockFrame.AControl">
 
12755
        <short/>
 
12756
      </element>
 
12757
      <element name="TDockTree.PaintDockFrame.ARect">
 
12758
        <short/>
 
12759
      </element>
 
12760
      <!-- procedure Visibility: protected -->
 
12761
      <element link="TDockManager.PositionDockRect" name="TDockTree.PositionDockRect"/>
 
12762
      <element name="TDockTree.PositionDockRect.AClient">
 
12763
        <short/>
 
12764
      </element>
 
12765
      <element name="TDockTree.PositionDockRect.DropCtl">
 
12766
        <short/>
 
12767
      </element>
 
12768
      <element name="TDockTree.PositionDockRect.DropAlign">
 
12769
        <short/>
 
12770
      </element>
 
12771
      <element name="TDockTree.PositionDockRect.DockRect">
 
12772
        <short/>
 
12773
      </element>
 
12774
      <!-- procedure Visibility: protected -->
 
12775
      <element link="TDockManager.RemoveControl" name="TDockTree.RemoveControl"/>
 
12776
      <element name="TDockTree.RemoveControl.AControl">
 
12777
        <short/>
 
12778
      </element>
 
12779
      <!-- procedure Visibility: protected -->
 
12780
      <element link="TDockManager.SaveToStream" name="TDockTree.SaveToStream"/>
 
12781
      <element name="TDockTree.SaveToStream.DestStream">
 
12782
        <short/>
 
12783
      </element>
 
12784
      <!-- procedure Visibility: protected -->
 
12785
      <element link="TDockManager.SetReplacingControl" name="TDockTree.SetReplacingControl"/>
 
12786
      <element name="TDockTree.SetReplacingControl.AControl">
 
12787
        <short/>
 
12788
      </element>
 
12789
      <!-- procedure Visibility: protected -->
 
12790
      <element link="TDockManager.ResetBounds" name="TDockTree.ResetBounds"/>
 
12791
      <element name="TDockTree.ResetBounds.Force">
 
12792
        <short/>
 
12793
      </element>
 
12794
      <!-- procedure Visibility: protected -->
 
12795
      <element name="TDockTree.UpdateAll">
 
12796
        <short>
 
12797
        </short>
 
12798
        <descr/>
 
12799
        <errors/>
 
12800
        <seealso/>
 
12801
      <notes><note>to do what?</note>
 
12802
        </notes>
 
12803
      </element>
 
12804
      <!-- property Visibility: protected -->
 
12805
      <element name="TDockTree.DockSite">
 
12806
        <short>The parent control whose docked clients are managed.
 
12807
        </short>
 
12808
        <descr/>
 
12809
        <seealso/>
 
12810
      </element>
 
12811
      <!-- constructor Visibility: public -->
 
12812
      <element name="TDockTree.Create"/>
 
12813
      <element name="TDockTree.Create.TheDockSite">
 
12814
        <short>The window control to be managed.</short>
 
12815
      </element>
 
12816
      <!-- destructor Visibility: public -->
 
12817
      <element name="TDockTree.Destroy"/>
 
12818
      <!-- procedure Visibility: public -->
 
12819
      <element link="#LCL.Controls.TDockManager.PaintSite" name="TDockTree.PaintSite"/>
 
12820
      <element name="TDockTree.PaintSite.DC">
 
12821
        <short/>
 
12822
      </element>
 
12823
      <!-- property Visibility: public -->
 
12824
      <element name="TDockTree.DockZoneClass">
 
12825
        <short>The class of all dock zones in this tree.</short>
 
12826
        <descr/>
 
12827
        <seealso/>
 
12828
      </element>
 
12829
      <!-- procedure Visibility: protected -->
 
12830
      <element link="TDockTree.DockZoneClass" name="TDockTree.SetDockZoneClass"/>
 
12831
      <element name="TDockTree.SetDockZoneClass.AValue">
 
12832
        <short/>
 
12833
      </element>
 
12834
      <!-- object Visibility: default -->
 
12835
      <element name="TMouse">
 
12836
        <short>Some properties of the Mouse.</short>
 
12837
        <descr>Contains information about current mouse position,
 
12838
          whether messages are captured by a window,
 
12839
          whether it is dragging an object,
 
12840
          and how far the mouse must move before a control starts dragging.</descr>
 
12841
      </element>
 
12842
      <!-- variable Visibility: default -->
 
12843
      <element link="TMouse.Capture" name="TMouse.FCapture"/>
 
12844
      <element name="TMouse.FDragImmediate"/>
 
12845
      <element name="TMouse.FDragThreshold"/>
 
12846
      <element name="TMouse.FWheelScrollLines"/>
 
12847
      <!-- procedure Visibility: default -->
 
12848
      <element link="TMouse.Capture" name="TMouse.SetCapture"/>
 
12849
      <element name="TMouse.SetCapture.Value">
 
12850
        <short/>
 
12851
      </element>
 
12852
      <!-- function Visibility: default -->
 
12853
      <element link="TMouse.Capture" name="TMouse.GetCapture"/>
 
12854
      <element name="TMouse.GetCapture.Result">
 
12855
        <short/>
 
12856
      </element>
 
12857
      <!-- function Visibility: default -->
 
12858
      <element link="TMouse.CursorPos" name="TMouse.GetCursorPos"/>
 
12859
      <element name="TMouse.GetCursorPos.Result">
 
12860
        <short/>
 
12861
      </element>
 
12862
      <!-- procedure Visibility: private -->
 
12863
      <element link="TMouse.CursorPos" name="TMouse.SetCursorPos"/>
 
12864
      <element name="TMouse.SetCursorPos.AValue">
 
12865
        <short/>
 
12866
      </element>
 
12867
      <!-- function Visibility: private -->
 
12868
      <element link="TMouse.WheelScrollLines" name="TMouse.GetWheelScrollLines"/>
 
12869
      <element name="TMouse.GetWheelScrollLines.Result">
 
12870
        <short/>
 
12871
      </element>
 
12872
      <!-- function Visibility: private -->
 
12873
      <element link="TMouse.DragImmediate" name="TMouse.GetDragImmediate"/>
 
12874
      <element name="TMouse.GetDragImmediate.Result">
 
12875
        <short/>
 
12876
      </element>
 
12877
      <!-- procedure Visibility: private -->
 
12878
      <element link="TMouse.DragImmediate" name="TMouse.SetDragImmediate"/>
 
12879
      <element name="TMouse.SetDragImmediate.AValue">
 
12880
        <short/>
 
12881
      </element>
 
12882
      <!-- function Visibility: private -->
 
12883
      <element link="TMouse.DragThreshold" name="TMouse.GetDragThreshold"/>
 
12884
      <element name="TMouse.GetDragThreshold.Result">
 
12885
        <short/>
 
12886
      </element>
 
12887
      <!-- procedure Visibility: private -->
 
12888
      <element link="TMouse.DragThreshold" name="TMouse.SetDragThreshold"/>
 
12889
      <element name="TMouse.SetDragThreshold.AValue">
 
12890
        <short/>
 
12891
      </element>
 
12892
      <!-- function Visibility: default -->
 
12893
      <element link="TMouse.IsDragging" name="TMouse.GetIsDragging"/>
 
12894
      <element name="TMouse.GetIsDragging.Result">
 
12895
        <short/>
 
12896
      </element>
 
12897
      <!-- constructor Visibility: public -->
 
12898
      <element name="TMouse.Create"/>
 
12899
      <!-- destructor Visibility: public -->
 
12900
      <element name="TMouse.Destroy"/>
 
12901
      <!-- property Visibility: public -->
 
12902
      <element name="TMouse.Capture">
 
12903
        <short>Handle of the capturing control.</short>
 
12904
        <descr/>
 
12905
      </element>
 
12906
      <!-- property Visibility: public -->
 
12907
      <element name="TMouse.CursorPos">
 
12908
        <short>The screen position of the cursor.</short>
 
12909
        <descr/>
 
12910
      </element>
 
12911
      <!-- property Visibility: public -->
 
12912
      <element name="TMouse.DragImmediate">
 
12913
        <short>Does dragging start immediately (True), or only after a mouse move?</short>
 
12914
        <descr/>
 
12915
      </element>
 
12916
      <!-- property Visibility: public -->
 
12917
      <element name="TMouse.DragThreshold">
 
12918
        <short>The minimum distance the mouse must move before dragging starts (in delayed mode).</short>
 
12919
        <descr>Default is 5 pixels</descr>
 
12920
      </element>
 
12921
      <!-- property Visibility: public -->
 
12922
      <element name="TMouse.IsDragging">
 
12923
        <short>True while dragging an object.
 
12924
        </short>
 
12925
        <descr/>
 
12926
        <seealso/>
 
12927
      </element>
 
12928
      <!-- property Visibility: public -->
 
12929
      <element name="TMouse.WheelScrollLines">
 
12930
        <short>The number of lines to scroll with every notch of the mouse wheel.
 
12931
        </short>
 
12932
        <descr/>
 
12933
        <seealso/>
 
12934
      </element>
 
12935
      <!-- function Visibility: default -->
 
12936
      <element link="FindControlAtPosition" name="FindDragTarget">
 
12937
        <short>Get control at screen position.</short>
 
12938
        <descr>Disabled controls <b>should</b> be excluded, but are not due to an bug in FindControlAtPosition.</descr>
 
12939
        <errors/>
 
12940
        <seealso/>
 
12941
      </element>
 
12942
      <element name="FindDragTarget.Result">
 
12943
        <short>The control at Position; Nil if none.</short>
 
12944
      </element>
 
12945
      <element name="FindDragTarget.Position">
 
12946
        <short>The screen position.</short>
 
12947
      </element>
 
12948
      <element name="FindDragTarget.AllowDisabled">
 
12949
        <short>Also find disabled controls, if True.</short>
 
12950
      </element>
 
12951
      <!-- function Visibility: default -->
 
12952
      <element name="FindControlAtPosition">
 
12953
        <short>Get control at screen position.</short>
 
12954
        <descr>When AllowDisabled is True, also a disabled control will be found. In the current implementation AllowDisabled is ignored (assumed to be True).
 
12955
          First a window at the given screen position is searched,
 
12956
          then a control within it.
 
12957
        </descr>
 
12958
        <errors/>
 
12959
        <seealso/>
 
12960
      </element>
 
12961
      <element name="FindControlAtPosition.Result">
 
12962
        <short>The control at Position; Nil if none.</short>
 
12963
      </element>
 
12964
      <element name="FindControlAtPosition.Position">
 
12965
        <short>The screen position.</short>
 
12966
      </element>
 
12967
      <element name="FindControlAtPosition.AllowDisabled">
 
12968
        <short>Also find disabled controls, if True.</short>
 
12969
      </element>
 
12970
      <!-- function Visibility: default -->
 
12971
      <element name="FindLCLWindow">
 
12972
        <short>Find the window and its owning control at the given screen coordinates.</short>
 
12973
        <descr/>
 
12974
        <errors/>
 
12975
        <seealso/>
 
12976
      </element>
 
12977
      <element name="FindLCLWindow.Result">
 
12978
        <short>The control at the ScreenPos; Nil if none was found.</short>
 
12979
      </element>
 
12980
      <element name="FindLCLWindow.ScreenPos">
 
12981
        <short/>
 
12982
      </element>
 
12983
      <!-- function Visibility: default -->
 
12984
      <element name="FindControl">
 
12985
        <short>Return the TWinControl of the given Handle.</short>
 
12986
        <descr>
 
12987
          <p>The result is very interface specific. Use FindOwnerControl when Handle may be a non-TWinControl handle.</p>
 
12988
        </descr>
 
12989
        <seealso>
 
12990
          <link id="FindOwnerControl"/>
 
12991
        </seealso>
 
12992
      </element>
 
12993
      <element name="FindControl.Result">
 
12994
        <short/>
 
12995
      </element>
 
12996
      <element name="FindControl.Handle">
 
12997
        <short/>
 
12998
      </element>
 
12999
      <!-- function Visibility: default -->
 
13000
      <element name="FindOwnerControl">
 
13001
        <short>Returns the TWinControl for the given Handle; the parent control for a non-TWinControl Handle.</short>
 
13002
        <descr>
 
13003
          <p>Handle can also be a child handle (of a TControl), in which case the returned control is the parent of the desired control. Parent, not Owner as suggested by the function name!</p>
 
13004
          <p>[Remark] The function recursively tries GetParent(Handle), so the result depends on the implementation (meaning) of a parent handle.</p>
 
13005
        </descr>
 
13006
      <notes><note>?</note>
 
13007
        </notes>
 
13008
      </element>
 
13009
      <element name="FindOwnerControl.Result">
 
13010
        <short/>
 
13011
      </element>
 
13012
      <element name="FindOwnerControl.Handle">
 
13013
        <short/>
 
13014
      </element>
 
13015
      <!-- function Visibility: default -->
 
13016
      <element name="FindLCLControl">
 
13017
        <short>Returns the TControl that currently is visible at a screen position.
 
13018
        </short>
 
13019
        <descr>The result is not reliable during resizing.
 
13020
        </descr>
 
13021
        <errors/>
 
13022
        <seealso/>
 
13023
      </element>
 
13024
      <element name="FindLCLControl.Result">
 
13025
        <short/>
 
13026
      </element>
 
13027
      <element name="FindLCLControl.ScreenPos">
 
13028
        <short/>
 
13029
      </element>
 
13030
      <!-- function Visibility: default -->
 
13031
      <element link="#LCL.LCLProc.SendApplicationMessage" name="SendAppMessage"/>
 
13032
      <element name="SendAppMessage.Result">
 
13033
        <short/>
 
13034
      </element>
 
13035
      <element name="SendAppMessage.Msg">
 
13036
        <short/>
 
13037
      </element>
 
13038
      <element name="SendAppMessage.WParam">
 
13039
        <short/>
 
13040
      </element>
 
13041
      <element name="SendAppMessage.LParam">
 
13042
        <short/>
 
13043
      </element>
 
13044
      <!-- procedure Visibility: default -->
 
13045
      <element name="MoveWindowOrg">
 
13046
        <short/>
 
13047
        <descr/>
 
13048
        <errors/>
 
13049
        <seealso/>
 
13050
      <notes><note>?</note>
 
13051
        </notes>
 
13052
      </element>
 
13053
      <element name="MoveWindowOrg.dc">
 
13054
        <short/>
 
13055
      </element>
 
13056
      <element name="MoveWindowOrg.X">
 
13057
        <short/>
 
13058
      </element>
 
13059
      <element name="MoveWindowOrg.Y">
 
13060
        <short/>
 
13061
      </element>
 
13062
      <!-- procedure Visibility: default -->
 
13063
      <element name="RecreateWnd">
 
13064
        <short>Create the widget for a TWinControl</short>
 
13065
        <descr>
 
13066
          <p>This function was originally member of TWincontrol.
 
13067
          </p>
 
13068
          <p>From a VCL point of view that made perfectly sense
 
13069
            since the VCL knows when a win32 widget has to be recreated when properties have changed.
 
13070
          </p>
 
13071
          <p>The LCL however doesn't know, the widgetset does.
 
13072
            To avoid old VCL behaviour and to provide a central function to the widgetset, it is moved here.
 
13073
          </p>
 
13074
        </descr>
 
13075
        <errors/>
 
13076
        <seealso/>
 
13077
      <notes><note>?</note>
 
13078
        </notes>
 
13079
      </element>
 
13080
      <element name="RecreateWnd.AWinControl">
 
13081
        <short/>
 
13082
      </element>
 
13083
      <!-- procedure Visibility: default -->
 
13084
      <element name="SetCaptureControl">
 
13085
        <short>Set the mouse capture to AWinControl or its child at the given coordinates</short>
 
13086
        <descr/>
 
13087
        <errors/>
 
13088
        <seealso/>
 
13089
      <notes><note>?</note>
 
13090
        </notes>
 
13091
      </element>
 
13092
      <element name="SetCaptureControl.Control">
 
13093
        <short/>
 
13094
      </element>
 
13095
      <element name="SetCaptureControl.AWinControl">
 
13096
        <short/>
 
13097
      </element>
 
13098
      <element name="SetCaptureControl.Position">
 
13099
        <short/>
 
13100
      </element>
 
13101
      <!-- function Visibility: default -->
 
13102
      <element name="GetCaptureControl">
 
13103
        <short>Returns the current capturing TControl.
 
13104
        </short>
 
13105
        <descr>Note: For the interface only a Handle = TWinControl can capture.
 
13106
          The LCL extends this to allow TControl capture the mouse.
 
13107
        </descr>
 
13108
        <errors/>
 
13109
        <seealso/>
 
13110
      </element>
 
13111
      <element name="GetCaptureControl.Result">
 
13112
        <short/>
 
13113
      </element>
 
13114
      <!-- procedure Visibility: default -->
 
13115
      <element name="CancelDrag">
 
13116
        <short/>
 
13117
        <descr/>
 
13118
        <errors/>
 
13119
        <seealso/>
 
13120
      </element>
 
13121
      <!-- procedure Visibility: default -->
 
13122
      <element name="DragDone">
 
13123
        <short>[Delphi compatible, dropped!]</short>
 
13124
        <descr/>
 
13125
        <errors/>
 
13126
        <seealso/>
 
13127
      <notes><note>Delphi compatible, dropped!</note>
 
13128
        </notes>
 
13129
      </element>
 
13130
      <element name="DragDone.Drop">
 
13131
        <short/>
 
13132
      </element>
 
13133
      <!-- function Visibility: default -->
 
13134
      <element name="CursorToString">
 
13135
        <short>Returns a string for the name of the cursor as identified by an integer constant</short>
 
13136
        <descr>Calls CursorToIdent to find correct entry in look-up table</descr>
 
13137
        <errors/>
 
13138
        <seealso>
 
13139
          <link id="#lcl.Controls.CursorToIdent"/>
 
13140
        </seealso>
 
13141
      </element>
 
13142
      <element name="CursorToString.Result">
 
13143
        <short>Returns a string with the name of the cursor type corresponding to the integer constant</short>
 
13144
      </element>
 
13145
      <element name="CursorToString.Cursor">
 
13146
        <short/>
 
13147
      </element>
 
13148
      <!-- function Visibility: default -->
 
13149
      <element name="StringToCursor">
 
13150
        <short>
 
13151
          <var>StringToCursor</var> - returns the cursor value corresponding to the name supplied</short>
 
13152
        <descr>
 
13153
          <p>
 
13154
            <var>StringToCursor</var> - returns the cursor value corresponding to the name supplied</p>
 
13155
          <p>Finds the numeric cursor value corresponding to the name <var>S</var> in the cursor look-up table</p>
 
13156
        </descr>
 
13157
      </element>
 
13158
      <element name="StringToCursor.Result">
 
13159
        <short>The numeric cursor value from the look-up table</short>
 
13160
      </element>
 
13161
      <element name="StringToCursor.S">
 
13162
        <short>The name of the cursor for which the numeric value is sought</short>
 
13163
      </element>
 
13164
      <!-- procedure Visibility: default -->
 
13165
      <element name="GetCursorValues">
 
13166
        <short/>
 
13167
        <descr/>
 
13168
        <errors/>
 
13169
        <seealso/>
 
13170
      </element>
 
13171
      <element name="GetCursorValues.Proc">
 
13172
        <short/>
 
13173
      </element>
 
13174
      <!-- function Visibility: default -->
 
13175
      <element name="CursorToIdent">
 
13176
        <short>Uses look-up table to find cursor identifier corresponding to integer cursor constant</short>
 
13177
        <descr/>
 
13178
        <errors/>
 
13179
        <seealso/>
 
13180
      </element>
 
13181
      <element name="CursorToIdent.Result">
 
13182
        <short>Returns true if a valid entry is found in the look-up table</short>
 
13183
      </element>
 
13184
      <element name="CursorToIdent.Cursor">
 
13185
        <short/>
 
13186
      </element>
 
13187
      <element name="CursorToIdent.Ident">
 
13188
        <short/>
 
13189
      </element>
 
13190
      <!-- function Visibility: default -->
 
13191
      <element name="IdentToCursor">
 
13192
        <short>Searches the Cursor name table for the given cursor name; returns True if found.</short>
 
13193
        <descr>If found, the cursor value (handle) is returned in <var>Cursor</var>.</descr>
 
13194
      <notes><note>?</note>
 
13195
        </notes>
 
13196
      </element>
 
13197
      <element name="IdentToCursor.Result">
 
13198
        <short>Returns True if a valid entry was found in the look-up table.</short>
 
13199
      </element>
 
13200
      <element name="IdentToCursor.Ident">
 
13201
        <short>The name of the cursor for which the numeric value is sought.</short>
 
13202
      </element>
 
13203
      <element name="IdentToCursor.Cursor">
 
13204
        <short>The numeric value of the named cursor.</short>
 
13205
      </element>
 
13206
      <!-- function Visibility: default -->
 
13207
      <element name="GetKeyShiftState">
 
13208
        <short/>
 
13209
        <descr/>
 
13210
        <errors/>
 
13211
        <seealso/>
 
13212
      </element>
 
13213
      <element name="GetKeyShiftState.Result">
 
13214
        <short/>
 
13215
      </element>
 
13216
      <!-- procedure Visibility: default -->
 
13217
      <element name="AdjustBorderSpace">
 
13218
        <short>Adjust space round border of this control</short>
 
13219
        <descr>
 
13220
          <p>RemainingClientRect: remaining clientrect without CurBorderSpace</p>
 
13221
          <p>CurBorderSpace: current borderspace around RemainingClientRect</p>
 
13222
          <p>Left, Top, Right, Bottom: apply these borderspaces to CurBorderSpace</p>
 
13223
          <p>CurBorderSpace will be set to the maximum of CurBorderSpace and Left, Top, Right, Bottom.</p>
 
13224
          <p>RemainingClientRect will shrink.</p>
 
13225
          <p>RemainingClientRect will not shrink to negative size.</p>
 
13226
        </descr>
 
13227
        <errors/>
 
13228
        <seealso/>
 
13229
      </element>
 
13230
      <element name="AdjustBorderSpace.RemainingClientRect">
 
13231
        <short/>
 
13232
      </element>
 
13233
      <element name="AdjustBorderSpace.CurBorderSpace">
 
13234
        <short/>
 
13235
      </element>
 
13236
      <element name="AdjustBorderSpace.Left">
 
13237
        <short/>
 
13238
      </element>
 
13239
      <element name="AdjustBorderSpace.Top">
 
13240
        <short/>
 
13241
      </element>
 
13242
      <element name="AdjustBorderSpace.Right">
 
13243
        <short/>
 
13244
      </element>
 
13245
      <element name="AdjustBorderSpace.Bottom">
 
13246
        <short/>
 
13247
      </element>
 
13248
      <element name="AdjustBorderSpace.Space">
 
13249
        <short/>
 
13250
      </element>
 
13251
      <!-- function Visibility: default -->
 
13252
      <element name="IsColorDefault">
 
13253
        <short/>
 
13254
        <descr/>
 
13255
        <errors/>
 
13256
        <seealso/>
 
13257
      </element>
 
13258
      <element name="IsColorDefault.Result">
 
13259
        <short/>
 
13260
      </element>
 
13261
      <element name="IsColorDefault.AControl">
 
13262
        <short/>
 
13263
      </element>
 
13264
      <!-- function Visibility: default -->
 
13265
      <element name="BidiFlipAlignment">
 
13266
        <short/>
 
13267
        <descr/>
 
13268
        <errors/>
 
13269
        <seealso/>
 
13270
      </element>
 
13271
      <element name="BidiFlipAlignment.Result">
 
13272
        <short/>
 
13273
      </element>
 
13274
      <element name="BidiFlipAlignment.Alignment">
 
13275
        <short/>
 
13276
      </element>
 
13277
      <element name="BidiFlipAlignment.Flip">
 
13278
        <short/>
 
13279
      </element>
 
13280
      <!-- function Visibility: default -->
 
13281
      <element name="BidiFlipAnchors">
 
13282
        <short/>
 
13283
        <descr/>
 
13284
        <errors/>
 
13285
        <seealso/>
 
13286
      </element>
 
13287
      <element name="BidiFlipAnchors.Result">
 
13288
        <short/>
 
13289
      </element>
 
13290
      <element name="BidiFlipAnchors.Control">
 
13291
        <short/>
 
13292
      </element>
 
13293
      <element name="BidiFlipAnchors.Flip">
 
13294
        <short/>
 
13295
      </element>
 
13296
      <!-- function Visibility: default -->
 
13297
      <element name="BidiFlipRect">
 
13298
        <short/>
 
13299
        <descr/>
 
13300
        <errors/>
 
13301
        <seealso/>
 
13302
      </element>
 
13303
      <element name="BidiFlipRect.Result">
 
13304
        <short/>
 
13305
      </element>
 
13306
      <element name="BidiFlipRect.Rect">
 
13307
        <short/>
 
13308
      </element>
 
13309
      <element name="BidiFlipRect.ParentRect">
 
13310
        <short/>
 
13311
      </element>
 
13312
      <element name="BidiFlipRect.Flip">
 
13313
        <short/>
 
13314
      </element>
 
13315
      <!-- procedure Visibility: default -->
 
13316
      <element name="ChangeBiDiModeAlignment">
 
13317
        <short/>
 
13318
        <descr/>
 
13319
        <errors/>
 
13320
        <seealso/>
 
13321
      </element>
 
13322
      <element name="ChangeBiDiModeAlignment.Alignment">
 
13323
        <short/>
 
13324
      </element>
 
13325
      <!-- procedure Visibility: default -->
 
13326
      <element name="Register">
 
13327
        <short>Register the components provided by this unit or package, so that they can be instantiated.</short>
 
13328
        <descr>Also can be used to register the controls required by an application.</descr>
 
13329
        <seealso>
 
13330
          <link id="#rtl.classes.registercomponents"/>
 
13331
        </seealso>
 
13332
      <notes><note>?</note>
 
13333
        </notes>
 
13334
      </element>
 
13335
      <!-- constant Visibility: default -->
 
13336
      <element name="fsSurface">
 
13337
        <short/>
 
13338
        <descr/>
 
13339
        <seealso/>
 
13340
      </element>
 
13341
      <!-- constant Visibility: default -->
 
13342
      <element name="fsBorder">
 
13343
        <short/>
 
13344
        <descr/>
 
13345
        <seealso/>
 
13346
      </element>
 
13347
      <!-- constant Visibility: default -->
 
13348
      <element name="bvNone">
 
13349
        <short/>
 
13350
        <descr/>
 
13351
        <seealso/>
 
13352
      </element>
 
13353
      <!-- constant Visibility: default -->
 
13354
      <element name="bvLowered">
 
13355
        <short/>
 
13356
        <descr/>
 
13357
        <seealso/>
 
13358
      </element>
 
13359
      <!-- constant Visibility: default -->
 
13360
      <element name="bvRaised">
 
13361
        <short/>
 
13362
        <descr/>
 
13363
        <seealso/>
 
13364
      </element>
 
13365
      <!-- constant Visibility: default -->
 
13366
      <element name="bvSpace">
 
13367
        <short/>
 
13368
        <descr/>
 
13369
        <seealso/>
 
13370
      </element>
 
13371
      <!-- set type Visibility: default -->
 
13372
      <element name="TCaptureMouseButtons">
 
13373
        <short/>
 
13374
        <descr/>
 
13375
        <seealso/>
 
13376
      </element>
 
13377
      <!-- pointer type Visibility: default -->
 
13378
      <element name="PHintInfo">
 
13379
        <short/>
 
13380
        <descr/>
 
13381
        <seealso/>
 
13382
      </element>
 
13383
      <!-- record type Visibility: default -->
 
13384
      <element name="THintInfo">
 
13385
        <short/>
 
13386
        <descr/>
 
13387
        <seealso/>
 
13388
      </element>
 
13389
      <!-- variable Visibility: default -->
 
13390
      <element name="THintInfo.HintControl">
 
13391
        <short/>
 
13392
        <descr/>
 
13393
        <seealso/>
 
13394
      </element>
 
13395
      <!-- variable Visibility: default -->
 
13396
      <element name="THintInfo.HintWindowClass">
 
13397
        <short/>
 
13398
        <descr/>
 
13399
        <seealso/>
 
13400
      </element>
 
13401
      <!-- variable Visibility: default -->
 
13402
      <element name="THintInfo.HintPos">
 
13403
        <short/>
 
13404
        <descr/>
 
13405
        <seealso/>
 
13406
      </element>
 
13407
      <!-- variable Visibility: default -->
 
13408
      <element name="THintInfo.HintMaxWidth">
 
13409
        <short/>
 
13410
        <descr/>
 
13411
        <seealso/>
 
13412
      </element>
 
13413
      <!-- variable Visibility: default -->
 
13414
      <element name="THintInfo.HintColor">
 
13415
        <short/>
 
13416
        <descr/>
 
13417
        <seealso/>
 
13418
      </element>
 
13419
      <!-- variable Visibility: default -->
 
13420
      <element name="THintInfo.CursorRect">
 
13421
        <short/>
 
13422
        <descr/>
 
13423
        <seealso/>
 
13424
      </element>
 
13425
      <!-- variable Visibility: default -->
 
13426
      <element name="THintInfo.CursorPos">
 
13427
        <short/>
 
13428
        <descr/>
 
13429
        <seealso/>
 
13430
      </element>
 
13431
      <!-- variable Visibility: default -->
 
13432
      <element name="THintInfo.ReshowTimeout">
 
13433
        <short/>
 
13434
        <descr/>
 
13435
        <seealso/>
 
13436
      </element>
 
13437
      <!-- variable Visibility: default -->
 
13438
      <element name="THintInfo.HideTimeout">
 
13439
        <short/>
 
13440
        <descr/>
 
13441
        <seealso/>
 
13442
      </element>
 
13443
      <!-- variable Visibility: default -->
 
13444
      <element name="THintInfo.HintStr">
 
13445
        <short/>
 
13446
        <descr/>
 
13447
        <seealso/>
 
13448
      </element>
 
13449
      <!-- variable Visibility: default -->
 
13450
      <element name="THintInfo.HintData">
 
13451
        <short/>
 
13452
        <descr/>
 
13453
        <seealso/>
 
13454
      </element>
 
13455
      <!-- procedure type Visibility: default -->
 
13456
      <element name="TGetDockCaptionEvent">
 
13457
        <short/>
 
13458
        <descr/>
 
13459
        <seealso/>
 
13460
      </element>
 
13461
      <element name="TGetDockCaptionEvent.Sender">
 
13462
        <short/>
 
13463
      </element>
 
13464
      <element name="TGetDockCaptionEvent.AControl">
 
13465
        <short/>
 
13466
      </element>
 
13467
      <element name="TGetDockCaptionEvent.ACaption">
 
13468
        <short/>
 
13469
      </element>
 
13470
      <element link="TDragManager" name="TDragManagerDefault">
 
13471
        <short>Implementation of TDragManager.</short>
 
13472
      </element>
 
13473
      <!-- object Visibility: default -->
 
13474
      <element name="TDragManager">
 
13475
        <short>The abstract base class for managing the dragging of controls (to be dropped or docked).</short>
 
13476
        <descr>
 
13477
          <p>This is the OO version of the Delphi drag manager, implemented in TDragManagerDefault.</p>
 
13478
          <remark>The registered dock sites should be stored in a persistent list, not in a DragManager instance.</remark>
 
13479
          <p>[entire review DoDi 2010-02-16]</p>
 
13480
        </descr>
 
13481
        <errors/>
 
13482
        <seealso/>
 
13483
      </element>
 
13484
      <!-- variable Visibility: private -->
 
13485
      <element name="TDragManager.FDragImmediate">
 
13486
        <short/>
 
13487
        <descr/>
 
13488
        <seealso/>
 
13489
      </element>
 
13490
      <!-- variable Visibility: private -->
 
13491
      <element name="TDragManager.FDragThreshold">
 
13492
        <short/>
 
13493
        <descr/>
 
13494
        <seealso/>
 
13495
      </element>
 
13496
      <!-- procedure Visibility: protected -->
 
13497
      <element name="TDragManager.KeyUp">
 
13498
        <short>Handler for keyboard key released.</short>
 
13499
        <descr>When the Ctrl key is released, a drop is enabled again.</descr>
 
13500
        <errors/>
 
13501
        <seealso/>
 
13502
      </element>
 
13503
      <element name="TDragManager.KeyUp.Key">
 
13504
        <short/>
 
13505
      </element>
 
13506
      <element name="TDragManager.KeyUp.Shift">
 
13507
        <short/>
 
13508
      </element>
 
13509
      <!-- procedure Visibility: protected -->
 
13510
      <element name="TDragManager.KeyDown">
 
13511
        <short>Handler for keyboard key pressed.</short>
 
13512
        <descr>
 
13513
          <p>When (and while) the Ctrl key is pressed, dropping is disabled.</p>
 
13514
          <p>The Esc key aborts the current dragging operation immediately.</p>
 
13515
        </descr>
 
13516
        <errors/>
 
13517
        <seealso/>
 
13518
      </element>
 
13519
      <element name="TDragManager.KeyDown.Key">
 
13520
        <short/>
 
13521
      </element>
 
13522
      <element name="TDragManager.KeyDown.Shift">
 
13523
        <short/>
 
13524
      </element>
 
13525
      <!-- procedure Visibility: protected -->
 
13526
      <element name="TDragManager.CaptureChanged">
 
13527
        <short>Aborts the dragging operation, when the capturing control really has changed.</short>
 
13528
        <descr/>
 
13529
        <errors/>
 
13530
        <seealso/>
 
13531
      </element>
 
13532
      <element name="TDragManager.CaptureChanged.OldCaptureControl">
 
13533
        <short/>
 
13534
      </element>
 
13535
      <!-- procedure Visibility: protected -->
 
13536
      <element name="TDragManager.MouseMove">
 
13537
        <short>Generates the visual feedback when the mouse moves.</short>
 
13538
        <descr/>
 
13539
        <errors/>
 
13540
        <seealso/>
 
13541
      </element>
 
13542
      <element name="TDragManager.MouseMove.Shift">
 
13543
        <short/>
 
13544
      </element>
 
13545
      <element name="TDragManager.MouseMove.X">
 
13546
        <short/>
 
13547
      </element>
 
13548
      <element name="TDragManager.MouseMove.Y">
 
13549
        <short/>
 
13550
      </element>
 
13551
      <!-- procedure Visibility: protected -->
 
13552
      <element name="TDragManager.MouseUp">
 
13553
        <short>Ends dragging.</short>
 
13554
        <descr/>
 
13555
        <errors/>
 
13556
        <seealso/>
 
13557
      </element>
 
13558
      <element name="TDragManager.MouseUp.Button">
 
13559
        <short/>
 
13560
      </element>
 
13561
      <element name="TDragManager.MouseUp.Shift">
 
13562
        <short/>
 
13563
      </element>
 
13564
      <element name="TDragManager.MouseUp.X">
 
13565
        <short/>
 
13566
      </element>
 
13567
      <element name="TDragManager.MouseUp.Y">
 
13568
        <short/>
 
13569
      </element>
 
13570
      <!-- procedure Visibility: protected -->
 
13571
      <element name="TDragManager.MouseDown">
 
13572
        <short>Nop.</short>
 
13573
        <descr/>
 
13574
        <errors/>
 
13575
        <seealso/>
 
13576
      </element>
 
13577
      <element name="TDragManager.MouseDown.Button">
 
13578
        <short/>
 
13579
      </element>
 
13580
      <element name="TDragManager.MouseDown.Shift">
 
13581
        <short/>
 
13582
      </element>
 
13583
      <element name="TDragManager.MouseDown.X">
 
13584
        <short/>
 
13585
      </element>
 
13586
      <element name="TDragManager.MouseDown.Y">
 
13587
        <short/>
 
13588
      </element>
 
13589
      <!-- constructor Visibility: public -->
 
13590
      <element name="TDragManager.Create">
 
13591
        <short>Initializes the Delphi default dragging parameters.</short>
 
13592
        <descr>
 
13593
          <p>The Delphi VCL sets DragImmediate=True and DragThreshold=5.</p>
 
13594
          <remark>A docking operation never should start immediately.</remark>
 
13595
        </descr>
 
13596
        <errors/>
 
13597
      </element>
 
13598
      <element name="TDragManager.Create.TheOwner">
 
13599
        <short/>
 
13600
      </element>
 
13601
      <!-- function Visibility: public -->
 
13602
      <element name="TDragManager.IsDragging">
 
13603
        <short>Check if dragging is in progress.</short>
 
13604
        <descr/>
 
13605
        <errors/>
 
13606
        <seealso/>
 
13607
      </element>
 
13608
      <element name="TDragManager.IsDragging.Result">
 
13609
        <short>True if dragging.</short>
 
13610
      </element>
 
13611
      <!-- function Visibility: public -->
 
13612
      <element name="TDragManager.Dragging">
 
13613
        <short>True if the specified control is being dragged.</short>
 
13614
        <descr/>
 
13615
        <errors/>
 
13616
        <seealso/>
 
13617
      </element>
 
13618
      <element name="TDragManager.Dragging.Result">
 
13619
        <short/>
 
13620
      </element>
 
13621
      <element name="TDragManager.Dragging.AControl">
 
13622
        <short/>
 
13623
      </element>
 
13624
      <!-- procedure Visibility: public -->
 
13625
      <element name="TDragManager.RegisterDockSite">
 
13626
        <short>Adds the control to the list of registered docking sites.</short>
 
13627
        <descr>
 
13628
          <remark>This should become a class method, maintaining the list of registered docking sites outside any DragManager instance.</remark>
 
13629
        </descr>
 
13630
        <errors/>
 
13631
        <seealso/>
 
13632
      </element>
 
13633
      <element name="TDragManager.RegisterDockSite.Site">
 
13634
        <short>The DockSite to register.</short>
 
13635
      </element>
 
13636
      <element name="TDragManager.RegisterDockSite.DoRegister">
 
13637
        <short>True for adding, False for removing the site.</short>
 
13638
      </element>
 
13639
      <!-- procedure Visibility: public -->
 
13640
      <element name="TDragManager.DragStart">
 
13641
        <short>Starts dragging a control.</short>
 
13642
        <descr>A DragObject must be created, depending on the Control.DragKind.
 
13643
          The mouse has to be captured, and visual feedback must be initialized.</descr>
 
13644
        <errors/>
 
13645
        <seealso/>
 
13646
      </element>
 
13647
      <element name="TDragManager.DragStart.AControl">
 
13648
        <short>The control that initiates the drag operation.</short>
 
13649
      </element>
 
13650
      <element name="TDragManager.DragStart.AImmediate">
 
13651
        <short>False when dragging should start only when the mouse is moved (delayed).</short>
 
13652
      </element>
 
13653
      <element name="TDragManager.DragStart.AThreshold">
 
13654
        <short>How much the mouse must move before delayed dragging starts.</short>
 
13655
      </element>
 
13656
      <!-- procedure Visibility: public -->
 
13657
      <element name="TDragManager.DragMove">
 
13658
        <short>Updates the visual dragging feedback.</short>
 
13659
        <descr/>
 
13660
        <errors/>
 
13661
        <seealso/>
 
13662
      </element>
 
13663
      <element name="TDragManager.DragMove.APosition">
 
13664
        <short>Mouse position in <b>screen</b> coordinates.</short>
 
13665
      </element>
 
13666
      <!-- procedure Visibility: public -->
 
13667
      <element name="TDragManager.DragStop">
 
13668
        <short>Ends dragging.</short>
 
13669
        <descr>
 
13670
          <p>The visual feedback is reset.</p>
 
13671
          <p>All related controls are notified of the outcome of the operation (drop, dock, abort).</p>
 
13672
          <p>Finally all temporary objects are destroyed.</p>
 
13673
        </descr>
 
13674
        <errors/>
 
13675
        <seealso/>
 
13676
      </element>
 
13677
      <element name="TDragManager.DragStop.ADrop">
 
13678
        <short>False when dragging was aborted.</short>
 
13679
      </element>
 
13680
      <!-- property Visibility: public -->
 
13681
      <element name="TDragManager.DragImmediate">
 
13682
        <short>Start dragging immediately, on MouseDown?</short>
 
13683
        <descr>This is the default value for e.g. BeginDrag.</descr>
 
13684
        <seealso/>
 
13685
      </element>
 
13686
      <!-- property Visibility: public -->
 
13687
      <element name="TDragManager.DragThreshold">
 
13688
        <short>The threshold amount by which the mouse must move before delayed dragging starts. (default 5 pixels)</short>
 
13689
        <seealso/>
 
13690
      </element>
 
13691
      <element name="TDragDockCommon.SendDragMessage">
 
13692
        <short>sends to AControl a drag message at specified position for nominated object; returns an integer Result for success</short>
 
13693
      </element>
 
13694
      <element name="TDragDockCommon.SendCmDragMsg">
 
13695
        <short>
 
13696
          <var>SendCmDragMsg</var> - sends to DragTarget a drag message at specified position for nominated object; returns True for success</short>
 
13697
        <descr>The Result is used to select the DragCursor (deny/accept drop).</descr>
 
13698
      </element>
 
13699
      <element name="TDockPerformer.DragMove.FindDockSiteAtPosition">
 
13700
        <short>Find a DockSite under the current mouse position.</short>
 
13701
        <descr>
 
13702
          <p>The list of registered docksites is searched. Sites are excluded when they are invisible or disabled, or when the site is (a child of) the dragged control.</p>
 
13703
          <p>The Z-order of the docksites should be taken into account. Currently the first site found is returned.</p>
 
13704
        </descr>
 
13705
      </element>
 
13706
      <element name="TDockPerformer.DragMove.GetDropControl">
 
13707
        <short>Determine the target control within the target DockSite.</short>
 
13708
        <descr>
 
13709
          <p>Do nothing (return Nil) unless a DockManager is installed in the target site and something has already been docked.</p>
 
13710
          <p>When the dragged control is the only client of the docksite, Nil is returned.</p>
 
13711
          <p>[ToDo: The check for an drop of a control onto itself should be done in every case, after the target control has been determined.]</p>
 
13712
        </descr>
 
13713
      </element>
 
13714
      <!-- enumeration type Visibility: default -->
 
13715
      <element name="TControlCellAlign">
 
13716
        <short>Modes for aligning a control in a table cell.</short>
 
13717
        <descr/>
 
13718
        <seealso/>
 
13719
      </element>
 
13720
      <!-- enumeration value Visibility: default -->
 
13721
      <element name="TControlCellAlign.ccaFill">
 
13722
        <short/>
 
13723
      <notes><note>?</note>
 
13724
        </notes>
 
13725
      </element>
 
13726
      <!-- enumeration value Visibility: default -->
 
13727
      <element name="TControlCellAlign.ccaLeftTop">
 
13728
        <short/>
 
13729
      <notes><note>?</note>
 
13730
        </notes>
 
13731
      </element>
 
13732
      <!-- enumeration value Visibility: default -->
 
13733
      <element name="TControlCellAlign.ccaRightBottom">
 
13734
        <short/>
 
13735
      <notes><note>?</note>
 
13736
        </notes>
 
13737
      </element>
 
13738
      <!-- enumeration value Visibility: default -->
 
13739
      <element name="TControlCellAlign.ccaCenter">
 
13740
        <short/>
 
13741
      <notes><note>?</note>
 
13742
        </notes>
 
13743
      </element>
 
13744
      <!-- set type Visibility: default -->
 
13745
      <element link="TControlCellAlign" name="TControlCellAligns"/>
 
13746
      <!-- enumeration type Visibility: default -->
 
13747
      <element name="TAnchorSideChangeOperation">
 
13748
        <short>Operations in <link id="TControl.ForeignAnchorSideChanged"/>.</short>
 
13749
        <descr/>
 
13750
        <seealso/>
 
13751
      </element>
 
13752
      <element name="TAnchorSideChangeOperation.ascoAdd">
 
13753
        <short>AnchorSide added.</short>
 
13754
      </element>
 
13755
      <element name="TAnchorSideChangeOperation.ascoRemove">
 
13756
        <short>AnchorSide removed.</short>
 
13757
      </element>
 
13758
      <element name="TAnchorSideChangeOperation.ascoChangeSide">
 
13759
        <short>AnchorSide changed.</short>
 
13760
      </element>
 
13761
      <!-- enumeration type Visibility: default -->
 
13762
      <element name="TChildControlResizeStyle">
 
13763
        <short>Modes for resizing child controls.</short>
 
13764
        <descr/>
 
13765
        <seealso/>
 
13766
      </element>
 
13767
      <element name="TChildControlResizeStyle.crsAnchorAligning">
 
13768
        <short>Using <link id="TControl.Anchors"/> (Delphi compatible).</short>
 
13769
      </element>
 
13770
      <element name="TChildControlResizeStyle.crsScaleChilds">
 
13771
        <short>Scale children, keep space between children fixed.</short>
 
13772
      </element>
 
13773
      <element name="TChildControlResizeStyle.crsHomogenousChildResize">
 
13774
        <short>Enlarge children equally, i.e. by the same amount of pixels.</short>
 
13775
      </element>
 
13776
      <element name="TChildControlResizeStyle.crsHomogenousSpaceResize">
 
13777
        <short>Enlarge space between children equally.</short>
 
13778
      </element>
 
13779
      <!-- enumeration type Visibility: default -->
 
13780
      <element name="TControlChildrenLayout">
 
13781
        <short>Modes for wrapping controls.</short>
 
13782
        <descr/>
 
13783
        <seealso/>
 
13784
      </element>
 
13785
      <element name="TControlChildrenLayout.cclNone">
 
13786
        <short>No wrapping</short>
 
13787
      <notes><note>?</note>
 
13788
        </notes>
 
13789
      </element>
 
13790
      <element name="TControlChildrenLayout.cclLeftToRightThenTopToBottom">
 
13791
        <short>Arrange in rows If BiDiMode not bdLeftToRight then it becomes RightToLeft.</short>
 
13792
      <notes><note>?</note>
 
13793
        </notes>
 
13794
      </element>
 
13795
      <element name="TControlChildrenLayout.cclTopToBottomThenLeftToRight">
 
13796
        <short>Arrange in columns</short>
 
13797
      <notes><note>?</note>
 
13798
        </notes>
 
13799
      </element>
 
13800
      <!-- enumeration type Visibility: default -->
 
13801
      <element name="TControlAtPosFlag">
 
13802
        <short>Flags for finding a control at given (client) position.</short>
 
13803
        <descr>capfAllowDisabled: include disabled controls.
 
13804
          capfAllowWinControls: do not find WinControls if False.
 
13805
          capfOnlyClientAreas: hit client areas only.
 
13806
          capfRecursive: search into child controls.
 
13807
          capfHasScrollOffset: scroll offset is already included in the coordinates.
 
13808
        </descr>
 
13809
        <seealso>
 
13810
          <link id="TWinControl.ControlAtPos"/>
 
13811
        </seealso>
 
13812
      </element>
 
13813
      <!-- enumeration value Visibility: default -->
 
13814
      <element name="TControlAtPosFlag.capfAllowDisabled">
 
13815
        <short>If set: include disabled controls.</short>
 
13816
      </element>
 
13817
      <!-- enumeration value Visibility: default -->
 
13818
      <element name="TControlAtPosFlag.capfAllowWinControls">
 
13819
        <short>If set: include TWinControls, in addition to TControls.</short>
 
13820
      </element>
 
13821
      <!-- enumeration value Visibility: default -->
 
13822
      <element name="TControlAtPosFlag.capfOnlyClientAreas">
 
13823
        <short>If set: hit client areas only.</short>
 
13824
      </element>
 
13825
      <!-- enumeration value Visibility: default -->
 
13826
      <element name="TControlAtPosFlag.capfRecursive">
 
13827
        <short>If set: recurse into grand children.</short>
 
13828
      </element>
 
13829
      <!-- enumeration value Visibility: default -->
 
13830
      <element name="TControlAtPosFlag.capfHasScrollOffset">
 
13831
        <short>If set: scroll offset is already included in the coordinates.</short>
 
13832
      </element>
 
13833
      <!-- set type Visibility: default -->
 
13834
      <element link="TControlAtPosFlag" name="TControlAtPosFlags"/>
 
13835
      <!-- function Visibility: default -->
 
13836
      <element name="DbgS">
 
13837
        <short>Converts items of several data types into strings, for debug output.</short>
 
13838
        <descr/>
 
13839
        <errors>[The parameters should have unique names, for every type]</errors>
 
13840
        <seealso/>
 
13841
      </element>
 
13842
      <element name="DbgS.Result">
 
13843
        <short>The string representing the given parameter(s).</short>
 
13844
      </element>
 
13845
      <element name="DbgS.a">
 
13846
        <short/>
 
13847
      </element>
 
13848
      <element name="DbgS.Anchors">
 
13849
        <short/>
 
13850
      </element>
 
13851
      <element name="DbgS.Side">
 
13852
        <short/>
 
13853
      </element>
 
13854
      <element name="DbgS.p">
 
13855
        <short/>
 
13856
      </element>
 
13857
      <element name="DbgS.Phases">
 
13858
        <short>All elements in this set will be shown as a comma-separated list.</short>
 
13859
      </element>
 
13860
      <!-- function Visibility: default -->
 
13861
      <element name="operator :=(Variant): TCaption">
 
13862
        <short/>
 
13863
        <descr/>
 
13864
        <errors/>
 
13865
        <seealso/>
 
13866
      <notes><note>?</note>
 
13867
        </notes>
 
13868
      </element>
 
13869
      <element name="operator :=(Variant): TCaption.Result">
 
13870
        <short/>
 
13871
      <notes><note>?</note>
 
13872
        </notes>
 
13873
      </element>
 
13874
      <element name="operator :=(Variant): TCaption.AVariant">
 
13875
        <short/>
 
13876
      <notes><note>?</note>
 
13877
        </notes>
 
13878
      </element>
 
13879
      <!-- Variables go here -->
 
13880
      <!-- variable Visibility: implementation -->
 
13881
      <element name="CaptureControl">
 
13882
        <short>Hidden reference to the currently capturing control.</short>
 
13883
        <descr>The interface knows, which TWinControl has the capture.
 
13884
          This stores what child control of this TWinControl has actually the capture.
 
13885
        </descr>
 
13886
        <seealso/>
 
13887
      </element>
 
13888
      <!-- variable Visibility: default -->
 
13889
      <element name="DefaultDockManagerClass">
 
13890
        <short>The default DockManager to create for a DockSite.</short>
 
13891
        <descr/>
 
13892
        <seealso/>
 
13893
      </element>
 
13894
      <!-- variable Visibility: default -->
 
13895
      <element name="DockSplitterClass">
 
13896
        <short/>
 
13897
        <descr/>
 
13898
        <seealso/>
 
13899
      <notes><note>?</note>
 
13900
        </notes>
 
13901
      </element>
 
13902
      <!-- variable Visibility: default -->
 
13903
      <element link="TDragManager" name="DragManager">
 
13904
        <short>The current DragManager (always TDragManagerDefault).</short>
 
13905
        <descr>A DragManager can be implemented only in the Controls unit,
 
13906
          because it must access private elements of the other classes,
 
13907
          declared in this unit.
 
13908
        </descr>
 
13909
        <seealso/>
 
13910
      </element>
 
13911
      <!-- variable Visibility: default -->
 
13912
      <element name="Mouse">
 
13913
        <short>The global Mouse object.</short>
 
13914
        <descr/>
 
13915
        <seealso/>
 
13916
      </element>
 
13917
      <!-- variable Visibility: default -->
 
13918
      <element name="NewStyleControls">
 
13919
        <short/>
 
13920
        <descr/>
 
13921
        <seealso/>
 
13922
      <notes><note>?</note>
 
13923
        </notes>
 
13924
      </element>
 
13925
      <!-- Topics go here -->
 
13926
      <topic name="AutoSize">
 
13927
        <short>
 
13928
          <var>AutoSize</var> - boolean property that permits the size of a control to be adjusted automatically</short>
 
13929
        <descr>
 
13930
          <p>[deverses an review!!!]
 
13931
            <var>AutoSize</var> is a boolean property found in many classes; it permits the size of a control to be adjusted automatically to accommodate differences in the text or graphic contained therein, and allows most efficient use of available space</p>
 
13932
          <p>Many controls call  <link id="#lcl.Controls.TControl.DoAutoSize">TControl.DoAutoSize</link> to perform the actual auto-sizing. </p>
 
13933
          <p>IMPORTANT: Many Delphi controls override this method and many call this method directly after setting some properties.</p>
 
13934
          <p>During handle creation not all interfaces can create complete Device Contexts which are needed to calculate things like text size.</p>
 
13935
          <p>That's why you should always call <link id="#lcl.Controls.TControl.AdjustSize">AdjustSize</link> instead of <var>DoAutoSize</var>.</p>
 
13936
          <p>
 
13937
            <var>TControl.AdjustSize</var> calls 
 
13938
            
 
13939
            
 
13940
            <var>DoAutoSize</var> in a smart fashion.</p>
 
13941
          <p>During loading and handle creation the calls are delayed.</p>
 
13942
          <p>This method initially does the same as <link id="#lcl.Controls.TWinControl.DoAutoSize">TWinControl.DoAutoSize</link>.  But since <var>DoAutoSize</var> is commonly overriden by descendant components,  it is not useful to perform all tests, which can result in too much overhead. To reduce this the LCL calls <var>AdjustSize</var> instead.</p>
 
13943
          <p>When setting <var>AutoSize</var> = true the LCL autosizes the control in width and height. This is one of the most complex parts of the LCL, because the result depends on nearly a hundred properties. Let's start simple:</p>
 
13944
          <p>The LCL will only autosize the Width or Height if it is free to resize. In other words - the width is not autosized if:</p>
 
13945
          <ul>
 
13946
            <li>the left and right side is anchored. You can anchor the sides with the <var>Anchors</var> property or by setting the <var>Align</var> property to <var>alTop</var>, <var>alBottom</var> or <var>alClient</var>
 
13947
            </li>
 
13948
            <li>the Width and Height are bound by the <var>Constraints</var> properties. The Contraints can also be overriden by the widgetset. For example the winapi does not allow resizing the height of a combobox. And the gtk widgetset does not allow resizing the width of a vertical scrollbar</li>
 
13949
          </ul>
 
13950
          <p>The new size is calculated by the protected method <link id="#lcl.Controls.TControl.CalculatePreferredSize">TControl.CalculatePreferredSize</link>.
 
13951
            This method asks the widgetset for an appropriate Width and Height. For example a <var>TButton</var> has preferred Width and Height. A <var>TComboBox</var> has only a preferred Height. The preferred Width is returned as 0 and so the LCL does not autosize the Width - it keeps the width unaltered. Finally a <var>TMemo</var> has no preferred Width or Height. Therefore AutoSize has no effect on a TMemo.</p>
 
13952
          <p>Some controls override this method. For example the <var>TGraphicControl</var> descendants like <var>TLabel</var> have no window handle and so cannot query the widgetset. They must calculate their preferred Width and Height themselves.</p>
 
13953
          <p>The widgetsets must override the <var>GetPreferredSize</var> method for each widget class that has a preferred size (Width or Height or both).</p>
 
13954
          <p>
 
13955
            <b>Parent.AutoSize</b>
 
13956
          </p>
 
13957
          <p>The above described the simple explanation. The real algorithm provides far more possibilities and is therefore far more complex.</p>
 
13958
          <p>
 
13959
            <b>Properties / Methods</b>
 
13960
          </p>
 
13961
          <ul>
 
13962
            <li>Left</li>
 
13963
            <li>Top</li>
 
13964
          </ul>
 
13965
          <p>If <var>Parent</var> is not nil then <var>Left, Top</var> are the pixel distance to the top, left pixel of the parent's client area (not scrolled). Remember the client area is always without the frame and scrollbars of the parent. For Delphi users: Some VCL controls like TGroupbox define the client area as the whole control including the frame and some not - the LCL is more consistent, and therefore Delphi incompatible. Left and Top can be negative or bigger than the client area. Some widgetsets define a minimum/maximum somewhere around 10.000 or more.</p>
 
13966
          <p>When the client area is scrolled the Left and Top are kept unchanged. </p>
 
13967
          <p>During resizing/moving Left and Top are not always in sync with the coordinates of the Handle object.</p>
 
13968
          <p>If Parent=nil then Left, Top depend on the widgetset and the window manager. Till Lazarus 0.9.25 this is typically the screen coordinate of the left,top of the client area of the form. This is Delphi incompatible. It is planned to change this to the Left, Top of the window.</p>
 
13969
          <p>Hint:</p>
 
13970
          <p>Each time you change Left and Top the LCL moves instantly. If you want to change both Left and Top use instead:</p>
 
13971
          <code>with Button1 do
 
13972
    SetBounds(NewLeft,NewTop,Width,Height);
 
13973
          </code>
 
13974
          <ul>
 
13975
            <li>Width</li>
 
13976
            <li>Height</li>
 
13977
          </ul>
 
13978
          <p>The Size in pixels must not be negative, and most widgetsets do not allow Width=0 and/or Height=0. Some controls on some platforms define a bigger minimum constraint. Instead of sizing a control to Width=0 and/or Height=0, set Visible=false. During resizing/moving Width and Height are not always in sync with the size of the Handle object.</p>
 
13979
          <ul>
 
13980
            <li>BoundsRect</li>
 
13981
          </ul>
 
13982
          <p>Same as Bounds(Left,Top,Width,Height).</p>
 
13983
          <p>Common newbie mistake:</p>
 
13984
          <code>BoundsRect.Left:=3; // WRONG: common newbie mistake
 
13985
</code>
 
13986
          <p>This has no effect, because reading BoundsRect is a function. It creates a temporary TRect on the stack.</p>
 
13987
          <ul>
 
13988
            <li>ClientRect</li>
 
13989
          </ul>
 
13990
          <p>Left and Top are always 0,0. Width and Height are the visible size in pixels of the client area. Remember the client area is without the frame and without scrollbars. In a scrollable client area the logical client area can be bigger than the visible.</p>
 
13991
          <ul>
 
13992
            <li>ClientOrigin</li>
 
13993
          </ul>
 
13994
          <p>Returns the screen coordinate of the top left coordinate 0,0 of the client area. Note that this value is the position as stored in the interface and is not always in sync with the LCL. When a control is moved, the LCL sets the bounds to the desired position and sends a move message to the interface. It is up to the interface to handle moves instantly or queued.</p>
 
13995
          <ul>
 
13996
            <li>LCLIntf.GetClientBounds</li>
 
13997
          </ul>
 
13998
          <p>Returns the client bounds of a control. Like ClientRect, but Left and Top are the pixel distances to the control's left, top. For example on a TGroupBox the Left, Top are the width and height of the left and top frame border. Scrolling has no effect on GetClientBounds.</p>
 
13999
          <ul>
 
14000
            <li>LCLIntf.GetWindowRect</li>
 
14001
          </ul>
 
14002
          <p>After the call, ARect will be the control area in screen coordinates. That means, Left and Top will be the screen coordinate of the TopLeft pixel of the Handle object and Right and Bottom will be the screen coordinate of the BottomRight pixel.</p>
 
14003
          <ul>
 
14004
            <li>FBaseBoundsLock: integer</li>
 
14005
          </ul>
 
14006
          <p>Increased/Decreased by LockBaseBounds/UnlockBaseBounds.
 
14007
            Used to keep FBaseBounds during SetBounds calls.</p>
 
14008
          <ul>
 
14009
            <li>FBaseParentClientSize: TPoint</li>
 
14010
          </ul>
 
14011
          <p>The Parent.ClientRect size valid for the FBaseBounds.
 
14012
            FBaseBounds and FBaseParentClientSize are used to calculate the distance for
 
14013
            akRight (akBottom).
 
14014
            When the parent is resized, the LCL knows what distance to keep.</p>
 
14015
          <ul>
 
14016
            <li>FBoundsRectForNewParent: TRect</li>
 
14017
          </ul>
 
14018
          <p>When changing the Parent of a control the Handle is recreated and many
 
14019
            things can happen. Especially for docking forms the process is too
 
14020
            unreliable. Therefore the BoundsRect is saved. The VCL uses a similar
 
14021
            mechanism.</p>
 
14022
          <ul>
 
14023
            <li>FLastDoChangeBounds: TRect</li>
 
14024
          </ul>
 
14025
          <p>Used to avoid calling OnChangeBounds with the same coordinates. This reduces
 
14026
            user defined autosizing.</p>
 
14027
          <ul>
 
14028
            <li>FLastResizeClientHeight: integer</li>
 
14029
            <li>FLastResizeClientWidth: integer</li>
 
14030
            <li>FLastResizeHeight: integer</li>
 
14031
            <li>FLastResizeWidth: integer</li>
 
14032
          </ul>
 
14033
          <p>Used to avoid calling OnResize with the same coordinates. This reduces user
 
14034
            defined autosizing.</p>
 
14035
          <ul>
 
14036
            <li>FLoadedClientSize: TPoint</li>
 
14037
          </ul>
 
14038
          <p>During loading many things are delayed and many things are set and worse: in
 
14039
            the wrong order. That's why SetClientWidth/SetClientHeight calls are stored
 
14040
            and set at end of loading again.
 
14041
            This way the LCL can restore the distances (e.g. akRight) used during
 
14042
            designing.</p>
 
14043
          <ul>
 
14044
            <li>FReadBounds: TRect</li>
 
14045
          </ul>
 
14046
          <p>Same as FLoadedClientSize, but for SetLeft, SetTop, SetWidth, SetHeight.</p>
 
14047
          <ul>
 
14048
            <li>procedure SetBoundsRectForNewParent(const AValue: TRect);</li>
 
14049
          </ul>
 
14050
          <p>Used to set FBoundsRectForNewParent. See above.</p>
 
14051
          <ul>
 
14052
            <li>procedure SetInitialBounds(aLeft, aTop, aWidth, aHeight: integer); virtual;</li>
 
14053
          </ul>
 
14054
          <p>A smart version of SetBounds, reducing overhead during creation and loading.</p>
 
14055
          <ul>
 
14056
            <li>procedure UpdateBaseBounds(StoreBounds, StoreParentClientSize, UseLoadedValues: boolean); virtual;</li>
 
14057
          </ul>
 
14058
          <p>Commit current bounds to base bounds.</p>
 
14059
          <ul>
 
14060
            <li>procedure SetClientHeight(Value: Integer);</li>
 
14061
            <li>procedure SetClientSize(Value: TPoint);</li>
 
14062
            <li>procedure SetClientWidth(Value: Integer);  </li>
 
14063
          </ul>
 
14064
          <p>Exists for Delphi compatibility too. Resizes the control, to get the wanted ClientRect size.</p>
 
14065
          <ul>
 
14066
            <li>procedure ChangeBounds(ALeft, ATop, AWidth, AHeight: integer); virtual;</li>
 
14067
          </ul>
 
14068
          <p>This is the internal SetBounds.
 
14069
            Applies constraints, updates base bounds, calls OnChangeBound, OnResize,
 
14070
            locks bounds.</p>
 
14071
          <ul>
 
14072
            <li>procedure DoSetBounds(ALeft, ATop, AWidth, AHeight: integer); virtual;</li>
 
14073
          </ul>
 
14074
          <p>This really sets the FLeft, FTop, FWidth, FHeight private variables.</p>
 
14075
          <ul>
 
14076
            <li>procedure SetBounds(aLeft, aTop, aWidth, aHeight: integer); virtual;</li>
 
14077
          </ul>
 
14078
          <p>This is the standard procedure overriden by many Delphi controls. TWinControl overrides it too. </p>
 
14079
          <p>Ignores calls when bounds are locked; lock the FBoundsRealized to avoid overhead to the interface during auto sizing.</p>
 
14080
          <p>ChangeBounds is not locked this way.</p>
 
14081
          <ul>
 
14082
            <li>Function GetClientOrigin: TPoint; virtual;</li>
 
14083
          </ul>
 
14084
          <p>Screen coordinate of Left, Top of client area.</p>
 
14085
          <ul>
 
14086
            <li>Function GetClientRect: TRect; virtual;</li>
 
14087
          </ul>
 
14088
          <p>Size of client area. (always Left=0, Top=0)</p>
 
14089
          <ul>
 
14090
            <li>Function GetScrolledClientRect: TRect; virtual;</li>
 
14091
          </ul>
 
14092
          <p>Visible client area in ClientRect.</p>
 
14093
          <ul>
 
14094
            <li>function GetChildsRect(Scrolled: boolean): TRect; virtual;</li>
 
14095
          </ul>
 
14096
          <p>Returns the Client rectangle relative to the control's Left, Top.
 
14097
            If Scrolled is true, the rectangle is moved by the current scrolling values
 
14098
            (for an example see TScrollingWincontrol).</p>
 
14099
          <ul>
 
14100
            <li>function GetClientScrollOffset: TPoint; virtual;</li>
 
14101
          </ul>
 
14102
          <p>Returns the scrolling offset of the client area.</p>
 
14103
          <ul>
 
14104
            <li>function GetControlOrigin: TPoint; virtual;</li>
 
14105
          </ul>
 
14106
          <p>Returns the screen coordinate of the topleft coordinate 0,0 of the control area. (The topleft pixel of the control on the screen)
 
14107
            Note that this value is the position as stored in the interface and is not always in sync with the LCL.
 
14108
            When a control is moved, the LCL sets the bounds to the wanted position
 
14109
            and sends a move message to the interface.
 
14110
            It is up to the interface to handle moves instantly or queued.</p>
 
14111
        </descr>
 
14112
      <notes><note>deverses an review!!!</note>
 
14113
        </notes>
 
14114
      </topic>
 
14115
      <topic name="Control coordinates">
 
14116
        <short>The coordinates of a control can be specified or retrieved in various ways.</short>
 
14117
        <descr>
 
14118
          <p>The following description applies to members of TControl and TWinControl.</p>
 
14119
          <p>Every control has an origin (Top, Left) and extent (Width, Height). The origin is relative to its Parent control (client coordinates) or,
 
14120
            for floating controls (forms) with Parent=Nil, relative to the screen.</p>
 
14121
          <p>The BoundsRect describes the TopLeft and BottomRight coordinates of the control, relative to its Parent.</p>
 
14122
          <p>The BoundsRectForNewParent holds the new coordinates, to be used when the Parent of the control is changed later.</p>
 
14123
          <p>The ClientRect describes the internal (client) area of a container control (TWinControl), excluding borders. Its Top and Left are always zero.
 
14124
            In a TScrollingWinControl...</p>
 
14125
          <p>BaseBounds holds the designed Bounds, to be used e.g. when a scale factor is set later.</p>
 
14126
          <p>GetControlOrigin returns the origin in screen coordinates. These values are not always in sync with the true screen position, managed by the widgetset.</p>
 
14127
          <p>ScreenToClient returns the client coordinates of an point given in the screen coordinates, i.e. the coordinates relative to the control's client origin.</p>
 
14128
          <p>ClientToScreen returns the screen coordinats for an point in client coordinates.</p>
 
14129
        </descr>
 
14130
      <notes><note>?</note><note>right?</note>
 
14131
        </notes>
 
14132
      </topic>
 
14133
      <topic name="Anchoring Controls">
 
14134
        <short>How multiple controls can be aligned and resized together, at runtime.</short>
 
14135
        <descr>
 
14136
          <p>The tree-style layout of a form allows to specify table-style areas,
 
14137
            with a common width or height of all controls in the same area (using container controls like e.g. TPanel).
 
14138
          </p>
 
14139
          <p>Delphi introduced control anchoring to the sides of the Parent control.
 
14140
            This means when a control in a form has Anchors[akRight]=True,
 
14141
            its right side keeps its distance from the right side of its Parent,
 
14142
            when its Parent is resized.
 
14143
          </p>
 
14144
          <p>The default anchors [akLeft,akTop] keep every control anchored to the origin (TopLeft) of their Parent control (of form).
 
14145
            This will cause controls to disappear when the form is shrinked,
 
14146
            or the user has to scroll through the form's client area.
 
14147
          </p>
 
14148
          <p>When a control shall e.g. use the available space, left over to its right,
 
14149
            Anchors=[akLeft,akRight] will result in a variable-width control.
 
14150
          </p>
 
14151
          <p>The Align property allows to stack controls at their Parent's sides,
 
14152
            e.g. all controls with Align=alTop are stacked at the top of their Parent.
 
14153
            The remaining space in the Parent can be occupied by a single control,
 
14154
            of Align=alClient.
 
14155
          </p>
 
14156
          <p>Both Anchors and Align are tightly coupled, changing one property will affect the other one.
 
14157
            This is harmless in so far, as the IDE (form designer) keeps all adjustments in sync, free of conflicts.
 
14158
          </p>
 
14159
          <p>Some people found this approved layout method too restrictive, and too complicated to use,
 
14160
            and now LCL controls <b>also</b> can be anchored <b>freely</b> to each other.
 
14161
            This layout management is traditionally referred to as "Anchor Docking", even if it is not related to docking at all.
 
14162
          </p>
 
14163
          <remark>This freedom requires that the GUI designer is responsible for consistent anchor specifications,
 
14164
            which do not result in unresolvable cyclic references or other contradictions.
 
14165
          </remark>
 
14166
          <p>Anchor docking allows to anchor every side of a control to an arbitrary side of another control,
 
14167
            i.e. the left side of an Edit control can be anchored to the right side of its associated Label.
 
14168
          </p>
 
14169
          <code>Example1
 
14170
    --------
 
14171
      If you want to have the top of B the same as the top of C:
 
14172
       +-----+  +-----+
 
14173
       |  B  |  |  C  |
 
14174
       |     |  +-----+
 
14175
       +-----+
 
14176
      use
 
14177
        B.AnchorSide[akTop].Control:=C;
 
14178
        B.AnchorSide[akTop].Side:=asrTop;
 
14179
          </code>
 
14180
          <p>When you want to have a gap between both controls,
 
14181
            set e.g. B.Borderspacing.Right to the desired amount.
 
14182
            Setting C.Borderspacing.Left will have the same effect, and both can be used together;
 
14183
            the resulting gap then reflects the maximum value of both properties.
 
14184
          </p>
 
14185
          <p>BorderSpacing is in effect even for controls without special anchoring,
 
14186
            when AutoSize is used.
 
14187
          </p>
 
14188
          <p>Anchor docking also allows to center a control relative to another control.
 
14189
          </p>
 
14190
          <code>Example2
 
14191
    --------
 
14192
      For centering A relative to B:
 
14193
            +-------+
 
14194
      +---+ |       |
 
14195
      | A | |   B   |
 
14196
      +---+ |       |
 
14197
            +-------+
 
14198
      use
 
14199
        A.AnchorSide[akTop].Side:=asrCenter;
 
14200
        A.AnchorSide[akTop].Control:=B;
 
14201
      Or use this, it's equivalent:
 
14202
        A.AnchorSide[akBottom].Side:=asrCenter;
 
14203
        A.AnchorSide[akBottom].Control:=B;
 
14204
          </code>
 
14205
          <p>TControlChildSizing and TControlChildrenLayout offers additional means for aligning and separating controls.
 
14206
          </p>
 
14207
          <p/>
 
14208
        </descr>
 
14209
      <notes><note>?</note><note>todo!?</note>
 
14210
        </notes>
 
14211
      </topic>
 
14212
      <element name="TWinControl.AutoSizeDelayedHandle">
 
14213
        <short>Returns true if AutoSize should be skipped / delayed because of its handle.</short>
 
14214
      </element>
 
14215
    <element name="TLazAccessibleObject.GetEnumerator"><short>Default enumerator for the children</short>
 
14216
      </element>
 
14217
    </module>
 
14218
    <!-- Controls -->
 
14219
  </package>
 
14220
</fpdoc-descriptions>