paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-19 22:49:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - definintions for some Types and functions in Controls.xml

Browse Source 
git-svn-id: trunk@15384 -
This commit is contained in:
kirkpatc 2008-06-11 08:27:31 +00:00
parent 194a5e0b3c
commit 7d7b6535ae
1 changed files with 128 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

214
docs/xml/lcl/controls.xml
View File

@ -213,15 +213,11 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- "type" alias type Visibility: default -->
<element name="TDate">
<short/>
<descr/>
<seealso/>
<short>Date expressed in the encoded date-time type</short>
</element>
<!-- "type" alias type Visibility: default -->
<element name="TTime">
<short/>
<descr/>
<seealso/>
<short>Time of day expressed in the encoded date-time type</short>
</element>
<!-- record type Visibility: default -->
<element name="TCMMouseWheel">
@ -310,9 +306,7 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- enumeration type Visibility: default -->
<element name="TAlign">
<short>TAlign - the available options for aligning a Control</short>
<descr/>
<seealso/>
<short>TAlign - enumerated type listing the available options for aligning a Control</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TAlign.alNone">
@ -344,15 +338,19 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- set type Visibility: default -->
<element name="TAlignSet">
<short/>
<descr/>
<seealso/>
<short>Set of options of type TAlign defining possible ways of aligning</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TAnchorKind">
<short/>
<descr/>
<seealso/>
<short>Enumerated type listing the possible positions for alignment of a control</short>
<descr>
<printshort id="TAnchorKind"/>
<pre>akTop,
akLeft,
akRight,
akBottom
</pre>
</descr>
</element>
<!-- enumeration value Visibility: default -->
<element name="TAnchorKind.akTop">
@ -372,9 +370,7 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- set type Visibility: default -->
<element name="TAnchors">
<short/>
<descr/>
<seealso/>
<short>Set of possible anchor positions</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TAnchorSideReference">
@ -414,15 +410,12 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- alias type Visibility: default -->
<element name="TCaption">
<short/>
<descr/>
<seealso/>
<short>A string type for the caption of a control: may be translated</short>
</element>
<!-- range type Visibility: default -->
<element name="TCursor">
<short/>
<descr/>
<seealso/>
<short>
<var>TCursor</var> - integer type defining range of values for cursor</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TFormStyle">
@ -482,9 +475,7 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- range type Visibility: default -->
<element name="TBorderStyle">
<short/>
<descr/>
<seealso/>
<short>A subset of TFormBorderStyle, listing only the styles available to a control that is not a form</short>
</element>
<!-- alias type Visibility: default -->
<element name="TControlBorderStyle">
@ -744,7 +735,7 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- enumeration type Visibility: default -->
<element name="TControlStyleType">
<short>TControlStyleType - describes features of the Control</short>
<short>TControlStyleType - enumerated type describing features of the Control</short>
<descr>
<pre>Enumerated type comprising:
csAcceptsControls, // can have children in the designer
@ -776,7 +767,6 @@ mrLast=mrYesToAll=10</descr>
csNoDesignSelectable, // control can not be selected at design time
csOwnedChildsSelectable // child controls owned by this control are selectable in the designer</pre>
</descr>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TControlStyleType.csAcceptsControls">
@ -884,9 +874,7 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- set type Visibility: default -->
<element name="TControlStyle">
<short/>
<descr/>
<seealso/>
<short>Set of permissible control styles</short>
</element>
<!-- constant Visibility: default -->
<element name="csMultiClicks">
@ -896,9 +884,23 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- enumeration type Visibility: default -->
<element name="TControlStateType">
<short>TControlStateType - describes possible states (status) of Control</short>
<descr/>
<seealso/>
<short>TControlStateType - an enumerated type listing the possible states (status) of Control</short>
<descr>
<p>Enumerated type comprising</p>
<pre>csLButtonDown,
csClicked,
csPalette,
csReadingState,
csAlignmentNeeded,
csFocusing,
csCreating,
csPaintCopy,
csCustomPaint,
csDestroyingHandle,
csDocking,
csVisibleSetInLoading
</pre>
</descr>
</element>
<!-- enumeration value Visibility: default -->
<element name="TControlStateType.csLButtonDown">
@ -950,9 +952,7 @@ mrLast=mrYesToAll=10</descr>
</element>
<!-- set type Visibility: default -->
<element name="TControlState">
<short/>
<descr/>
<seealso/>
<short>Set of permissible Control States</short>
</element>
<!-- object Visibility: default -->
<element name="TControlCanvas">
@ -4660,7 +4660,8 @@ mrLast=mrYesToAll=10</descr>
<element name="TControl.AutoSizeCanStart">
<short>
<var>AutoSizeCanStart</var>
- checks whether <var>DoAutoSize </var>is permitted to start</short>
- checks whether
<var>DoAutoSize </var>is permitted to start</short>
<descr>
<pre>{------------------------------------------------------------------------------
function TControl.AutoSizeCanStart: boolean;
@ -4783,7 +4784,8 @@ mrLast=mrYesToAll=10</descr>
<p>
<var>TWinControl</var>
overrides this and asks the interface for theme dependent values.
See <link id="#lcl.Controls.TWinControl.CalculatePreferredSize">TWinControl.CalculatePreferredSize</link> for more information.</p>
See
<link id="#lcl.Controls.TWinControl.CalculatePreferredSize">TWinControl.CalculatePreferredSize</link> for more information.</p>
<p>WithThemeSpace: If true, adds space for stacking.</p>
<p>For example: <var>TRadioButton</var> has a minimum size. But for stacking multiple TRadioButtons there should be
some space around. This space is theme dependent, so the parameter is passed to the widgetset.</p>
@ -5564,32 +5566,46 @@ mrLast=mrYesToAll=10</descr>
<!-- procedure Visibility: protected -->
<element name="TControl.Click">
<short>
<var>Click</var> - a procedure that allows the programmer to simulate a mouse click over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnClick"/> event</short>
<var>Click</var> - a procedure that allows the programmer to simulate a mouse click over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnClick"/> event</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.DblClick">
<short>
<var>DblClick</var> - a procedure that allows the programmer to simulate a mouse double-click over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnDblClick"/> event</short>
<var>DblClick</var> - a procedure that allows the programmer to simulate a mouse double-click over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnDblClick"/> event</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.TripleClick">
<short>
<var>TripleClick</var> - a procedure that allows the programmer to simulate a mouse triple-click over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnTripleClick"/> event</short>
<var>TripleClick</var> - a procedure that allows the programmer to simulate a mouse triple-click over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnTripleClick"/> event</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.QuadClick">
<short>
<var>QuadClick</var> - a procedure that allows the programmer to simulate a mouse quadruple-click over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnQuadClick"/> event</short>
<var>QuadClick</var> - a procedure that allows the programmer to simulate a mouse quadruple-click over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnQuadClick"/> event</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.MouseDown">
<short>
<var>MouseDown</var> - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnMouseDown"/> event</short>
<var>MouseDown</var> - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseDown"/> event</short>
<descr>
<p>
<var>MouseDown</var> - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnMouseDown"/> event</p>
<var>MouseDown</var> - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseDown"/> event</p>
<p>
<var>Button</var> specifies which mouse button; <var>Shift</var> signifies whether Ctrl, Shift or Alt keys are also pressed; <var>X, Y</var> show mouse position</p>
<var>Button</var> specifies which mouse button;
<var>Shift</var> signifies whether Ctrl, Shift or Alt keys are also pressed;
<var>X, Y</var> show mouse position</p>
</descr>
<errors/>
<seealso/>
@ -5613,12 +5629,17 @@ mrLast=mrYesToAll=10</descr>
<!-- procedure Visibility: protected -->
<element name="TControl.MouseMove">
<short>
<var>MouseMove</var> - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnMouseMove"/> event</short>
<var>MouseMove</var> - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseMove"/> event</short>
<descr>
<p>
<var>MouseMove</var> - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnMouseMove"/> event</p>
<var>MouseMove</var> - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseMove"/> event</p>
<p>
<var>Shift</var> signifies whether Ctrl, Shift or Alt keys are also pressed; <var>X, Y</var> show mouse position</p>
<var>Shift</var> signifies whether Ctrl, Shift or Alt keys are also pressed;
<var>X, Y</var> show mouse position</p>
</descr>
<errors/>
<seealso/>
@ -5638,12 +5659,18 @@ mrLast=mrYesToAll=10</descr>
<!-- procedure Visibility: protected -->
<element name="TControl.MouseUp">
<short>
<var>MouseUp</var> - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnMouseUp"/> event</short>
<var>MouseUp</var> - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseUp"/> event</short>
<descr>
<p>
<var>MouseUp</var> - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same <var>Action</var> as that associated with the <link id="OnMouseUp"/> event</p>
<var>MouseUp</var> - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseUp"/> event</p>
<p>
<var>Button</var> specifies which mouse button; <var>Shift</var> signifies whether Ctrl, Shift or Alt keys are also pressed; <var>X, Y</var> show mouse position</p>
<var>Button</var> specifies which mouse button;
<var>Shift</var> signifies whether Ctrl, Shift or Alt keys are also pressed;
<var>X, Y</var> show mouse position</p>
</descr>
<errors/>
<seealso/>
@ -5667,7 +5694,9 @@ mrLast=mrYesToAll=10</descr>
<!-- procedure Visibility: protected -->
<element name="TControl.MouseEnter">
<short>
<var>MouseEnter</var> - a procedure that allows the programmer to simulate a mouse entering the control, and initiates the same <var>Action</var> as that associated with the <link id="OnMouseEnter"/> event</short>
<var>MouseEnter</var> - a procedure that allows the programmer to simulate a mouse entering the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseEnter"/> event</short>
<descr/>
<errors/>
<seealso/>
@ -5675,7 +5704,9 @@ mrLast=mrYesToAll=10</descr>
<!-- procedure Visibility: protected -->
<element name="TControl.MouseLeave">
<short>
<var>MouseLeave</var> - a procedure that allows the programmer to simulate a mouse leaving the control, and initiates the same <var>Action</var> as that associated with the <link id="OnMouseLeave"/> event</short>
<var>MouseLeave</var> - a procedure that allows the programmer to simulate a mouse leaving the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseLeave"/> event</short>
<descr/>
<errors/>
<seealso/>
@ -5750,7 +5781,8 @@ mrLast=mrYesToAll=10</descr>
<element name="TControl.AssignTo">
<short>
<var>AssignTo </var>
- copies some of its properties to another control (<var>Dest</var>)</short>
- copies some of its properties to another control (
<var>Dest</var>)</short>
</element>
<!-- argument Visibility: default -->
<element name="TControl.AssignTo.Dest">
@ -5934,7 +5966,8 @@ mrLast=mrYesToAll=10</descr>
<element name="TControl.ParentFormHandleInitialized">
<short>
<var>ParentFormHandleInitialized </var>
- called by <var>ChildHandlesCreated</var> of parent form</short>
- called by
<var>ChildHandlesCreated</var> of parent form</short>
<descr>
<p>The form is a real connection to the target screen.</p>
<p>For example, the gtk under X gathers some screen information, but not before form creation. </p>
@ -6344,7 +6377,8 @@ mrLast=mrYesToAll=10</descr>
<element name="TControl.ManualFloat">
<short>
<var>ManualFloat</var>
- the opposite of <var>ManualDock</var>, allows operator to Float a control</short>
- the opposite of
<var>ManualDock</var>, allows operator to Float a control</short>
<descr>
<pre>function TControl.ManualFloat(TheScreenRect: TRect;
KeepDockSiteSize: Boolean = true): Boolean;
@ -6406,12 +6440,14 @@ mrLast=mrYesToAll=10</descr>
<element name="TControl.AdjustSize">
<short>
<var>AdjustSize</var>
- Smart way to <var>DoAutoSize</var>
- Smart way to
<var>DoAutoSize</var>
</short>
<descr>
<p>
<var>TControl.AdjustSize</var>
calls <var>DoAutoSize</var> in a smart fashion.</p>
calls
<var>DoAutoSize</var> in a smart fashion.</p>
<p>During loading and handle creation the calls are delayed.</p>
<p>This method initially does the same as <var>TWinControl.DoAutoSize</var>. 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>
</descr>
@ -6585,7 +6621,8 @@ mrLast=mrYesToAll=10</descr>
<p>
<var>TWinControl</var>
overrides this and asks the interface for theme dependent values.
See <link id="#lcl.Controls.TWinControl.CalculatePreferredSize">TWinControl.CalculatePreferredSize</link> for more information.</p>
See
<link id="#lcl.Controls.TWinControl.CalculatePreferredSize">TWinControl.CalculatePreferredSize</link> for more information.</p>
</descr>
</element>
<!-- argument Visibility: default -->
@ -7581,9 +7618,7 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
</element>
<!-- range type Visibility: default -->
<element name="TBorderWidth">
<short/>
<descr/>
<seealso/>
<short>Integer type defining width of the border of a control</short>
</element>
<!-- procedure type Visibility: default -->
<element name="TGetChildProc">
@ -9605,7 +9640,8 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<!-- procedure Visibility: protected -->
<element name="TWinControl.KeyDown">
<short>
<var>KeyDown</var> - emulate the action of pressing the specified key (makes <var>OnKeyDown</var> respond)</short>
<var>KeyDown</var> - emulate the action of pressing the specified key (makes
<var>OnKeyDown</var> respond)</short>
<descr/>
<errors/>
<seealso/>
@ -9662,7 +9698,8 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<!-- procedure Visibility: protected -->
<element name="TWinControl.KeyUp">
<short>
<var>KeyUp</var> - emulates the action of a key being released (makes <var>OnKeyUp</var> respond)</short>
<var>KeyUp</var> - emulates the action of a key being released (makes
<var>OnKeyUp</var> respond)</short>
<descr/>
<errors/>
<seealso/>
@ -10105,8 +10142,7 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<!-- property Visibility: public -->
<element name="TWinControl.BorderWidth">
<short>Property to determine width of the window's border</short>
<descr>// properties which are supported by all descendants<br/>
<br/>Either reads a flag to find the width or sets the width. <br/>Default is set to zero.</descr>
<descr>// properties which are supported by all descendants<br/><br/>Either reads a flag to find the width or sets the width. <br/>Default is set to zero.</descr>
</element>
<!-- property Visibility: public -->
<element name="TWinControl.BoundsLockCount">
@ -10383,7 +10419,8 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<!-- function Visibility: public -->
<element name="TWinControl.ControlAtPos">
<short>
<var>ControlAtPos</var> - the identity of the control located at the specified point <var>Pos</var>
<var>ControlAtPos</var> - the identity of the control located at the specified point
<var>Pos</var>
</short>
<descr/>
<errors/>
@ -10679,7 +10716,8 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<!-- procedure Visibility: public -->
<element name="TWinControl.BroadCast">
<short>
<var>BroadCast</var> - send <var>ToAllMessage</var> to all recipients</short>
<var>BroadCast</var> - send
<var>ToAllMessage</var> to all recipients</short>
<descr/>
<errors/>
<seealso/>
@ -10691,7 +10729,8 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<!-- procedure Visibility: public -->
<element name="TWinControl.NotifyControls">
<short>
<var>NotifyControls</var> - send <var>Msg </var>(a message) to all controls</short>
<var>NotifyControls</var> - send
<var>Msg </var>(a message) to all controls</short>
<descr/>
<errors/>
<seealso/>
@ -10951,7 +10990,9 @@ need the ability to accept keyboard input or contain other controls. </p>
<p>Since lightweight controls do not wrap GUI screen objects, they are faster and use fewer resources than controls based on <var>TWinControl</var>.</p>
<p>
<var>TGraphicControl</var>
provides a <var>Canvas</var> property for access to the control's drawing surface and a virtual <var>Paint</var> method called in response to paint requests received by the parent control.</p>
provides a
<var>Canvas</var> property for access to the control's drawing surface and a virtual
<var>Paint</var> method called in response to paint requests received by the parent control.</p>
</descr>
<seealso>
<link id="TWinControl"/>
@ -12271,18 +12312,20 @@ getting the parent control's Canvas dimensions.</p>
</element>
<!-- function Visibility: default -->
<element name="StringToCursor">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
<var>StringToCursor</var> - returns the cursor value corresponding to the name supplied</short>
<descr>
<printshort id="StringToCursor"/>
<p>Finds the numeric cursor value corresponding to the name <var>S</var> in the cursor look-up table</p>
</descr>
</element>
<!-- function result Visibility: default -->
<element name="StringToCursor.Result">
<short/>
<short>The numeric cursor value from the look-up table</short>
</element>
<!-- argument Visibility: default -->
<element name="StringToCursor.S">
<short/>
<short>The name of the cursor for which the numeric value is sought</short>
</element>
<!-- procedure Visibility: default -->
<element name="GetCursorValues">
@ -12316,22 +12359,20 @@ getting the parent control's Canvas dimensions.</p>
</element>
<!-- function Visibility: default -->
<element name="IdentToCursor">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
<var>IdentToCursor</var> - uses look-up table to find numeric cursor value corresponding to the Identifier string</short>
</element>
<!-- function result Visibility: default -->
<element name="IdentToCursor.Result">
<short/>
<short>Returns True if a valid entry was found in the look-up table</short>
</element>
<!-- argument Visibility: default -->
<element name="IdentToCursor.Ident">
<short/>
<short>The name of the cursor cor which the numeric value is sought</short>
</element>
<!-- argument Visibility: default -->
<element name="IdentToCursor.Cursor">
<short/>
<short>The numeric value of the named cursor</short>
</element>
<!-- function Visibility: default -->
<element name="GetKeyShiftState">
@ -13523,7 +13564,8 @@ getting the parent control's Canvas dimensions.</p>
<!-- procedure Visibility: protected -->
<element name="TControl.UpdateMouseCursor">
<short>
<var>UpdateMouseCursor</var> - ensure co-ordinates <var>X, Y </var> for the cursor are correctly stored</short>
<var>UpdateMouseCursor</var> - ensure co-ordinates
<var>X, Y </var> for the cursor are correctly stored</short>
<descr/>
<errors/>
<seealso/>