paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-09-01 11:20:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - updates to ActnList.xml, Buttons.xml and ComCtrls.xml - mostly minor formatting corrections

Browse Source 
git-svn-id: trunk@14584 -
This commit is contained in:
kirkpatc 2008-03-19 13:45:33 +00:00
parent 8ad1e194c2
commit 5cf0c4c222
3 changed files with 3422 additions and 1256 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
docs/xml/lcl/actnlist.xml
View File

@ -268,13 +268,13 @@ Take the following precautions when creating your own Destroy method:
<!-- object Visibility: default -->
<element name="TCustomActionList">
<short>
<i>TCustomActionList</i> - the ancestor class for <i>TActionList</i>
<var>TCustomActionList</var> - the ancestor class for <var>TActionList</var>
</short>
<descr>
<p>
<i>TCustomActionList</i> - the ancestor class for <i>TActionList</i>. If you want to define your own action list class, you should derive it from this class.</p>
<var>TCustomActionList</var> - the ancestor class for <var>TActionList</var>. If you want to define your own action list class, you should derive it from this class.</p>
<p>
<i>TActionList</i>, <i>TAction</i>, <i>TActionLink</i> and <i>TContainedAction</i> are used to centralize
<var>TActionList</var>, <var>TAction</var>, <var>TActionLink</var> and <var>TContainedAction</var> are used to centralize
the implementation of user commands, and can then be linked to the appropriate button, menu or another component. This is an Object-Oriented programming strategy
to reuse the code, as opposed to the Event-Oriented approach of writing an OnClick event for each component.</p>
</descr>
@ -493,7 +493,7 @@ Take the following precautions when creating your own Destroy method:
<!-- constructor Visibility: public -->
<element name="TCustomActionList.Create">
<short>
<i>Create </i>a new instance of the <i>TCustomActionList </i>class</short>
<var>Create </var>a new instance of the <var>TCustomActionList </var>class</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomActionList.Create.AOwner">
@ -599,7 +599,7 @@ action handles the current component.
</element>
<!-- property Visibility: public -->
<element name="TCustomActionList.Images">
<short>The <i>Images</i> from an <i>ImageList</i> to be associated with the actions, eg in a Menu display</short>
<short>The <var>Images</var> from an <var>ImageList</var> to be associated with the actions, eg in a Menu display</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomActionList.State">
@ -610,24 +610,24 @@ action handles the current component.
<!-- object Visibility: default -->
<element name="TActionList">
<short>
<i>TActionList</i> - The basic actions list class</short>
<var>TActionList</var> - The basic actions list class</short>
<descr>
<p>
<i>TActionList</i> - The basic actions list class</p>
<var>TActionList</var> - The basic actions list class</p>
<p>
<i>TActionList</i> is the last component on the "Standard" component pallete on the Lazarus IDE.</p>
<var>TActionList</var> is the last component on the "Standard" component pallete on the Lazarus IDE.</p>
<p>To use an ActionList, click on the icon on the IDE Standard Components toolbar, then click anywhere on the main form and an ActionList icon will appear. It doesn't matter where you position it, because it is not visible at run-time. </p>
<p>You can add, remove or modify actions on the list by right-clicking on the ActionList icon on the form editor and then choosing "Edit action list...", or by double-clicking on the icon with the left mouse button. This will open the "Action List Editor". </p>
<p>You can now use the "+" and "-" buttons to add and remove actions. The ActionList editor menu allows you to select standard actions from a selection (option 'New Standard Action') or create a new action (option 'New Action'). To edit an action, click it and then open the object inspector. To add code to be executed when an action is triggered, double-click the action's name on the "Action List Editor".</p>
<p>The <i>TActionList</i>
<p>The <var>TActionList</var>
Class introduces very few properties of its own, but inherits a lot from its ancestor, <link id="#lcl.ActnList.TCustomActionList">TCustomActionList</link>, and related components <link id="#lcl.ActnList.TAction">TAction</link>, <link id="#lcl.ActnList.TCustomAction">TCustomAction</link>, <link id="#lcl.ActnList.TContainedAction">TContainedAction</link> and <link id="#rtl.Classes.TBasicAction">TBasicAction</link>
</p>
<p>Each entry in the ActionList appears in the Object Inspector as an instance of <i>TAction</i>, and its properties are accessible and modifiable from the Object Inspector</p>
<p>Each entry in the ActionList appears in the Object Inspector as an instance of <var>TAction</var>, and its properties are accessible and modifiable from the Object Inspector</p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TActionList.Images">
<short>The <i>Images</i> from an <i>ImageList</i> to be associated with the actions, eg in a Menu display</short>
<short>The <var>Images</var> from an <var>ImageList</var> to be associated with the actions, eg in a Menu display</short>
<descr/>
<seealso/>
</element>
@ -734,11 +734,11 @@ action handles the current component.
<!-- object Visibility: default -->
<element name="TCustomAction">
<short>
<i>TCustomAction</i> is the ancestor class for <i>TAction</i>
<var>TCustomAction</var> is the ancestor class for <var>TAction</var>
</short>
<descr>
<p>
<i>TCustomAction</i> is a generic class for all components that represent actions that can be be set on the user interface for buttons and other controls. <i>TCustomAction</i> is the ancestor for <i>TAction</i>. If you want to define your own action class, you should derive it from this class.</p>
<var>TCustomAction</var> is a generic class for all components that represent actions that can be be set on the user interface for buttons and other controls. <var>TCustomAction</var> is the ancestor for <var>TAction</var>. If you want to define your own action class, you should derive it from this class.</p>
<p>You can assign a action to a component by using the Object Inspector.</p>
</descr>
<seealso>
@ -1087,7 +1087,7 @@ execution will end up at the <var>TPersistent</var> implementation of
<!-- constructor Visibility: public -->
<element name="TCustomAction.Create">
<short>
<i>Create</i> a new instance of the <i>TCustomAction</i> class</short>
<var>Create</var> a new instance of the <var>TCustomAction</var> class</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomAction.Create.AOwner">
@ -1096,12 +1096,12 @@ execution will end up at the <var>TPersistent</var> implementation of
<!-- destructor Visibility: public -->
<element name="TCustomAction.Destroy">
<short>
<i>Destroy </i>- Deallocates an object</short>
<var>Destroy </var>- Deallocates an object</short>
</element>
<!-- function Visibility: public -->
<element name="TCustomAction.DoHint">
<short>
<i>DoHint</i> - method for displaying the hint contained in <i>HintStr</i> if True value is returned</short>
<var>DoHint</var> - method for displaying the hint contained in <var>HintStr</var> if True value is returned</short>
</element>
<!-- function result Visibility: default -->
<element name="TCustomAction.DoHint.Result">
@ -1110,12 +1110,12 @@ execution will end up at the <var>TPersistent</var> implementation of
<!-- argument Visibility: default -->
<element name="TCustomAction.DoHint.HintStr">
<short>
<i>HintStr</i> - the text-string for display as a hint</short>
<var>HintStr</var> - the text-string for display as a hint</short>
</element>
<!-- function Visibility: public -->
<element name="TCustomAction.Execute">
<short>
<i>Execute</i> - method to determine if action is to be performed</short>
<var>Execute</var> - method to determine if action is to be performed</short>
</element>
<!-- function result Visibility: default -->
<element name="TCustomAction.Execute.Result">
@ -1124,85 +1124,85 @@ execution will end up at the <var>TPersistent</var> implementation of
<!-- property Visibility: public -->
<element name="TCustomAction.AutoCheck">
<short>
<i>AutoCheck</i> - whether the control (eg a CheckBox) is to be automatically checked</short>
<var>AutoCheck</var> - whether the control (eg a CheckBox) is to be automatically checked</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Caption">
<short>The <i>Caption</i> to be used if this action is associated with a visible component</short>
<short>The <var>Caption</var> to be used if this action is associated with a visible component</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Checked">
<short>Whether the CheckBox associated with the action is <i>Checked</i> (default False)</short>
<short>Whether the CheckBox associated with the action is <var>Checked</var> (default False)</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.DisableIfNoHandler">
<short>
<i>DisableIfNoHandler </i>- don't use this action if no Handler has been provided</short>
<var>DisableIfNoHandler </var>- don't use this action if no Handler has been provided</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Enabled">
<short>
<i>Enabled</i> - whether this action is able to be used (default True)</short>
<var>Enabled</var> - whether this action is able to be used (default True)</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.GroupIndex">
<short>
<i>GroupIndex </i>- Index of the action within its group</short>
<var>GroupIndex </var>- Index of the action within its group</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.HelpContext">
<short>
<i>HelpContext </i>- the index for a context-based help message</short>
<var>HelpContext </var>- the index for a context-based help message</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.HelpKeyword">
<short>
<i>HelpKeyWord </i>- the keyword of a context-based help message</short>
<var>HelpKeyWord </var>- the keyword of a context-based help message</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.HelpType">
<short>
<i>HelpType</i> - the sort of help message to be offered: default Context-based</short>
<var>HelpType</var> - the sort of help message to be offered: default Context-based</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Hint">
<short>
<i>Hint</i> - a pop-up message that appears when the mouse hovers over an object</short>
<var>Hint</var> - a pop-up message that appears when the mouse hovers over an object</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.ImageIndex">
<short>
<i>ImageIndex </i>- the index number of the image to be associated with this action</short>
<var>ImageIndex </var>- the index number of the image to be associated with this action</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.ShortCut">
<short>
<i>ShortCut </i>- an index to a shortcut list</short>
<var>ShortCut </var>- an index to a shortcut list</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.SecondaryShortCuts">
<short>
<i>SecondaryShortCuts</i> - a stringlist containing shortcuts</short>
<var>SecondaryShortCuts</var> - a stringlist containing shortcuts</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Visible">
<short>
<i>Visible</i> - is this action visible? (default True)</short>
<var>Visible</var> - is this action visible? (default True)</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.OnHint">
<short>
<i>OnHint</i> - action to be taken when a hint is required</short>
<var>OnHint</var> - action to be taken when a hint is required</short>
</element>
<!-- object Visibility: default -->
<element name="TAction">
<short>
<i>TAction</i> is the basic action object used on the LCL.</short>
<var>TAction</var> is the basic action object used on the LCL.</short>
<descr>
<p>
<i>TAction</i> is the basic action object used on the LCL.</p>
<var>TAction</var> is the basic action object used on the LCL.</p>
<p>It redeclares many properties inherited from TCustomAction on the public section, but does not add any new features. For more details look at the See Also section for TCustomAction.</p>
<i>The properties of each Action can be modified at design time in the Object Inspector</i>
<var>The properties of each Action can be modified at design time in the Object Inspector</var>
</descr>
<seealso>
<link id="TCustomAction"/>
@ -1211,7 +1211,7 @@ execution will end up at the <var>TPersistent</var> implementation of
<!-- constructor Visibility: public -->
<element name="TAction.Create">
<short>
<i>Create</i> a new instance of the <i>TCustomAction</i> class</short>
<var>Create</var> a new instance of the <var>TCustomAction</var> class</short>
</element>
<!-- argument Visibility: default -->
<element name="TAction.Create.AOwner">
@ -1220,68 +1220,68 @@ execution will end up at the <var>TPersistent</var> implementation of
<!-- property Visibility: published -->
<element name="TAction.AutoCheck">
<short>
<i>AutoCheck</i> - whether the control (eg a CheckBox) is to be automatically checked</short>
<var>AutoCheck</var> - whether the control (eg a CheckBox) is to be automatically checked</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.Caption">
<short>The <i>Caption</i> to be used if this action is associated with a visible component</short>
<short>The <var>Caption</var> to be used if this action is associated with a visible component</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.Checked">
<short>Whether the CheckBox associated with the action is <i>Checked</i> (default False)</short>
<short>Whether the CheckBox associated with the action is <var>Checked</var> (default False)</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.Enabled">
<short>
<i>Enabled</i> - whether this action is able to be used (default True)</short>
<var>Enabled</var> - whether this action is able to be used (default True)</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.GroupIndex">
<short>
<i>GroupIndex </i>- Index of the action within its group</short>
<var>GroupIndex </var>- Index of the action within its group</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.HelpContext">
<short>
<i>HelpContext </i>- the index for a context-based help message</short>
<var>HelpContext </var>- the index for a context-based help message</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.HelpKeyword">
<short>
<i>HelpKeyWord </i>- the keyword of a context-based help message</short>
<var>HelpKeyWord </var>- the keyword of a context-based help message</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.HelpType">
<short>
<i>HelpType</i> - the sort of help message to be offered: default Context-based</short>
<var>HelpType</var> - the sort of help message to be offered: default Context-based</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.Hint">
<short>
<i>Hint</i> - a pop-up message that appears when the mouse hovers over an object</short>
<var>Hint</var> - a pop-up message that appears when the mouse hovers over an object</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.ImageIndex">
<short>
<i>ImageIndex </i>- the index number of the image to be associated with this action</short>
<var>ImageIndex </var>- the index number of the image to be associated with this action</short>
<descr/>
<seealso/>
</element>
@ -1308,7 +1308,7 @@ normal task if the <var>OnExecute</var> handler was called.
<!-- property Visibility: published -->
<element name="TAction.OnHint">
<short>
<i>OnHint</i> - action to be taken when a hint is required</short>
<var>OnHint</var> - action to be taken when a hint is required</short>
<descr/>
<seealso/>
</element>
@ -1326,7 +1326,7 @@ executed at this point in time.
<!-- property Visibility: published -->
<element name="TAction.SecondaryShortCuts">
<short>
<i>SecondaryShortCuts</i> - a stringlist containing shortcuts</short>
<var>SecondaryShortCuts</var> - a stringlist containing shortcuts</short>
<descr/>
<seealso/>
</element>
@ -1339,7 +1339,7 @@ executed at this point in time.
<!-- property Visibility: published -->
<element name="TAction.Visible">
<short>
<i>Visible</i> - is this action visible? (default True)</short>
<var>Visible</var> - is this action visible? (default True)</short>
<descr/>
<seealso/>
</element>
@ -1496,7 +1496,7 @@ executed at this point in time.
</element>
<!-- function Visibility: public -->
<element name="TActionLink.IsCheckedLinked">
<short>Is the action's <i>Checked</i> property linked to the client?</short>
<short>Is the action's <var>Checked</var> property linked to the client?</short>
<descr/>
<errors/>
<seealso/>
@ -1518,7 +1518,7 @@ executed at this point in time.
</element>
<!-- function Visibility: public -->
<element name="TActionLink.IsGroupIndexLinked">
<short>Is the action's <i>GroupIndex</i> property linked to the client?</short>
<short>Is the action's <var>GroupIndex</var> property linked to the client?</short>
<descr/>
<errors/>
<seealso/>
@ -1540,7 +1540,7 @@ executed at this point in time.
</element>
<!-- function Visibility: public -->
<element name="TActionLink.IsHelpLinked">
<short>Is the action's <i>Help</i> property linked to the client?</short>
<short>Is the action's <var>Help</var> property linked to the client?</short>
<descr/>
<errors/>
<seealso/>
@ -1551,7 +1551,7 @@ executed at this point in time.
</element>
<!-- function Visibility: public -->
<element name="TActionLink.IsHintLinked">
<short>Is the action's <i>Hint</i> property linked to the client?</short>
<short>Is the action's <var>Hint</var> property linked to the client?</short>
<descr/>
<errors/>
<seealso/>
@ -1573,7 +1573,7 @@ executed at this point in time.
</element>
<!-- function Visibility: public -->
<element name="TActionLink.IsShortCutLinked">
<short>Is the action's <i>ShortCut</i> property linked to the client?</short>
<short>Is the action's <var>ShortCut</var> property linked to the client?</short>
<descr/>
<errors/>
<seealso/>

110
docs/xml/lcl/buttons.xml
View File

@ -2,7 +2,7 @@
<fpdoc-descriptions>
<package name="LCL">
<module name="Buttons">
<short/>
<short>Defines several specialist button classes</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
@ -216,7 +216,7 @@ Constructors allocate memory and system resources needed by the object. They als
<!-- destructor Visibility: public -->
<element name="TButtonGlyph.Destroy">
<short>Deallocates an object</short>
<descr>If you call Destroy for an object witch hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
<descr>If you call Destroy for an object which hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
Take the following precautions when creating your own Destroy method:
@ -515,14 +515,14 @@ Take the following precautions when creating your own Destroy method:
<!-- procedure Visibility: protected -->
<element name="TCustomBitBtn.Click">
<short>
<i>Click </i>- the procedure which allows programmatic simulation of a mouse click</short>
<var>Click </var>- the procedure which allows programmatic simulation of a mouse click</short>
<descr>
<p>
<i>Click </i>
<var>Click </var>
- the procedure which allows programmatic simulation of a mouse click, and thus activation of the <i>Action</i> associated with the <i>OnClick</i> event
- the procedure which allows programmatic simulation of a mouse click, and thus activation of the <var>Action</var> associated with the <var>OnClick</var> event
</p>
</descr>
<errors/>
@ -564,7 +564,7 @@ Constructors allocate memory and system resources needed by the object. They als
<!-- destructor Visibility: public -->
<element name="TCustomBitBtn.Destroy">
<short>Deallocates an object</short>
<descr>If you call Destroy for an object witch hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
<descr>If you call Destroy for an object which hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
Take the following precautions when creating your own Destroy method:
@ -636,7 +636,7 @@ Take the following precautions when creating your own Destroy method:
<short>Used to align the control in one of four directions.</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Either reads a flag containing alignment instructions (<i>FAlign</i>) or writes alignment instructions (<i>SetAlign</i>)</p>
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
</descr>
</element>
@ -646,7 +646,7 @@ Take the following precautions when creating your own Destroy method:
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determines how the control is to be anchored to its client or parent conrol</p>
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <i>IsAnchorsStored</i>
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
</p>
</descr>
</element>
@ -672,49 +672,49 @@ Take the following precautions when creating your own Destroy method:
<!-- property Visibility: published -->
<element name="TBitBtn.Caption">
<short>
<i>Caption</i> - the text-string appearing on the Control, usually used to identify its function</short>
<var>Caption</var> - the text-string appearing on the Control, usually used to identify its function</short>
<descr>
<p>Gets caption as a text-string (<i>GetText</i>), or stores the new caption (<i>SetText</i>). Shows flag if caption is stored (<i>IsCaptionStored</i>).</p>
<p>By default, the <i>Caption</i> appears the same as the control <i>Name</i> in the Object Inspector,
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
and the developer needs to set it explicitly to some new text.</p>
<p>The VCL implementation relies on the virtual <i>Get/SetTextBuf</i> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <i>RealGet/SetText</i> is
<p>The VCL implementation relies on the virtual <var>Get/SetTextBuf</var> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <var>RealGet/SetText</var> is
introduced. These functions interface with the LCLInterface. </p>
<p>The default <i>Get/SetTextBuf</i> implementation calls the <i>RealGet/SetText</i>. As long as the <i>Get/SetTextBuf</i> isn't overridden <i>Get/SetText</i> calls <i>RealGet/SetText</i> to avoid PChar copying.</p>
<p>The default <var>Get/SetTextBuf</var> implementation calls the <var>RealGet/SetText</var>. As long as the <var>Get/SetTextBuf</var> isn't overridden <var>Get/SetText</var> calls <var>RealGet/SetText</var> to avoid PChar copying.</p>
<p>To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.</p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Constraints">
<short>Determine <i>Constraints</i> (max and min height and width) for this control</short>
<short>Determine <var>Constraints</var> (max and min height and width) for this control</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determine <i>Constraints</i> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Default">
<short>Is this the Default button? (default setting is False)</short>
<descr>
<p>Defines if a button is the <i>Default</i> on a form. That is, pressing ENTER will execute its onClick method, whether the control has focus or not!</p>
<p>Defines if a button is the <var>Default</var> on a form. That is, pressing ENTER will execute its onClick method, whether the control has focus or not!</p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Enabled">
<short>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</short>
<short>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</p>
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Font">
<short>The <i>Font</i> to be used for text in this control</short>
<short>The <var>Font</var> to be used for text in this control</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
<p>The properties of <i>Font</i> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
</p>
</descr>
<seealso/>
@ -763,7 +763,7 @@ introduced. These functions interface with the LCLInterface. </p>
<short>Event Handler for mouse click</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <i>ActionList</i>
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <var>ActionList</var>
</p>
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
</descr>
@ -772,26 +772,26 @@ introduced. These functions interface with the LCLInterface. </p>
<!-- property Visibility: published -->
<element name="TBitBtn.OnEnter">
<short>
<i>OnEnter</i> - event handler for when the mouse enters the control, and the control receives focus</short>
<var>OnEnter</var> - event handler for when the mouse enters the control, and the control receives focus</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnExit">
<short>
<i>OnExit</i> - event handler for when the mouse leaves the control and it loses focus</short>
<var>OnExit</var> - event handler for when the mouse leaves the control and it loses focus</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnKeyDown">
<short>
<i>OnKeyDown</i> - event handler for instance when key is down while control has focus</short>
<var>OnKeyDown</var> - event handler for instance when key is down while control has focus</short>
<descr>
<p>
<i>OnKeyDown</i>
<var>OnKeyDown</var>
- event handler for instance when key is down while control has focus</p>
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <i>OnKeyPress</i> the key needs to become pressed while the control has focus.</p>
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.</p>
</descr>
<seealso/>
</element>
@ -800,19 +800,19 @@ introduced. These functions interface with the LCLInterface. </p>
<short>OnKeyPress - event controller for a key being pressed while the control has focus</short>
<descr>
<p>
<i>OnKeyPress</i>
<var>OnKeyPress</var>
- event controller for a key being pressed while the control has focus</p>
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <i>OnKeyDown</i> the key may have already been down when the control received focus.</p>
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.</p>
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnKeyUp">
<short>
<i>OnKeyUp</i> - event handler for instance when a key is up (not pressed) while the control has focus</short>
<var>OnKeyUp</var> - event handler for instance when a key is up (not pressed) while the control has focus</short>
<descr>
<p>
<i>OnKeyUp</i>
<var>OnKeyUp</var>
- event handler for instance when a key is up (not pressed) while the control has focus</p>
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
</descr>
@ -847,7 +847,7 @@ Reads or Writes flag if control is re-sized.
<!-- property Visibility: published -->
<element name="TBitBtn.ParentShowHint">
<short>
<i>ParentShowHint </i>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
<var>ParentShowHint </var>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
<descr/>
<seealso/>
</element>
@ -890,7 +890,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<!-- property Visibility: published -->
<element name="TBitBtn.Visible">
<short>
<i>Visible</i> - can the control be seen?</short>
<var>Visible</var> - can the control be seen?</short>
<descr>
<pre>The Visible property represents the ability to see a visual control.
If Visible is True the control is shown, otherwise it is hidden.
@ -961,11 +961,11 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- object Visibility: default -->
<element name="TCustomSpeedButton">
<short>The ancestor class for <i>TSpeedButton</i>
<short>The ancestor class for <var>TSpeedButton</var>
</short>
<descr>
<p>
<i>TCustomSpeedButton</i> is the ancestor for <i>TSpeedButton</i>. If you want to define your own speedbutton class, you should use this class to derive it from.</p>
<var>TCustomSpeedButton</var> is the ancestor for <var>TSpeedButton</var>. If you want to define your own speedbutton class, you should use this class to derive it from.</p>
<p>The Speed Button is designed to automate a process when it is selected. An user pushes a button to start an action or set a mode.
</p>
<p>When a user clicks on a SpeedButton focus is not shifted; a Speed Button never gets focus. The button may carry an descriptive glyph, and has a state (checked or not, etc)</p>
@ -1429,7 +1429,7 @@ Constructors allocate memory and system resources needed by the object. They als
<!-- procedure Visibility: public -->
<element name="TCustomSpeedButton.Click">
<short>
<i>Click</i> - a procedure that allows the programmer to simulate a mouse click over the control, and initiates the same <i>Action</i> as that associated with the <i>OnClick</i> 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 <var>OnClick</var> event</short>
<descr/>
<errors/>
<seealso/>
@ -1518,7 +1518,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
<short>Used to align the control in one of four directions.</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Either reads a flag containing alignment instructions (<i>FAlign</i>) or writes alignment instructions (<i>SetAlign</i>)</p>
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
</descr>
</element>
@ -1528,7 +1528,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determines how the control is to be anchored to its client or parent conrol</p>
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <i>IsAnchorsStored</i>
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
</p>
</descr>
<seealso/>
@ -1552,25 +1552,25 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Constraints">
<short>Determine <i>Constraints</i> (max and min height and width) for this control</short>
<short>Determine <var>Constraints</var> (max and min height and width) for this control</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determine <i>Constraints</i> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Caption">
<short>
<i>Caption</i> - the text-string appearing on the Control, usually used to identify its function</short>
<var>Caption</var> - the text-string appearing on the Control, usually used to identify its function</short>
<descr>
<p>Gets caption as a text-string (<i>GetText</i>), or stores the new caption (<i>SetText</i>). Shows flag if caption is stored (<i>IsCaptionStored</i>).</p>
<p>By default, the <i>Caption</i> appears the same as the control <i>Name</i> in the Object Inspector,
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
and the developer needs to set it explicitly to some new text.</p>
<p>The VCL implementation relies on the virtual <i>Get/SetTextBuf</i> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <i>RealGet/SetText</i> is
<p>The VCL implementation relies on the virtual <var>Get/SetTextBuf</var> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <var>RealGet/SetText</var> is
introduced. These functions interface with the LCLInterface. </p>
<p>The default <i>Get/SetTextBuf</i> implementation calls the <i>RealGet/SetText</i>. As long as the <i>Get/SetTextBuf</i> isn't overridden <i>Get/SetText</i> calls <i>RealGet/SetText</i> to avoid PChar copying.</p>
<p>The default <var>Get/SetTextBuf</var> implementation calls the <var>RealGet/SetText</var>. As long as the <var>Get/SetTextBuf</var> isn't overridden <var>Get/SetText</var> calls <var>RealGet/SetText</var> to avoid PChar copying.</p>
<p>To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.</p>
</descr>
</element>
@ -1581,10 +1581,10 @@ introduced. These functions interface with the LCLInterface. </p>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Enabled">
<short>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</short>
<short>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</p>
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
</descr>
</element>
@ -1635,7 +1635,7 @@ introduced. These functions interface with the LCLInterface. </p>
<!-- property Visibility: published -->
<element name="TSpeedButton.Visible">
<short>
<i>Visible</i> - can the control be seen?</short>
<var>Visible</var> - can the control be seen?</short>
<descr>
<pre>The Visible property represents the ability to see a visual control.
If Visible is True the control is shown, otherwise it is hidden.
@ -1650,7 +1650,7 @@ introduced. These functions interface with the LCLInterface. </p>
<short>Event Handler for mouse click</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <i>ActionList</i>
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <var>ActionList</var>
</p>
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
</descr>
@ -1685,7 +1685,7 @@ introduced. These functions interface with the LCLInterface. </p>
<!-- property Visibility: published -->
<element name="TSpeedButton.OnPaint">
<short>
<i>OnPaint</i> - event handler for request to paint canvas</short>
<var>OnPaint</var> - event handler for request to paint canvas</short>
<descr/>
<seealso/>
</element>
@ -1717,14 +1717,14 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<!-- property Visibility: published -->
<element name="TSpeedButton.ParentFont">
<short>
<i>ParentFont </i>- should the control use the same font as the parent? Default is true</short>
<var>ParentFont </var>- should the control use the same font as the parent? Default is true</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.ParentShowHint">
<short>
<i>ParentShowHint </i>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
<var>ParentShowHint </var>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
<descr/>
<seealso/>
</element>
@ -1793,11 +1793,11 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
</descr>
</element>
<element name="TSpeedButton.Font">
<short>The <i>Font</i> to be used for text in this control</short>
<short>The <var>Font</var> to be used for text in this control</short>
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
<p>The properties of <i>Font</i> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
</p>
</descr>
</element>

4458
docs/xml/lcl/comctrls.xml
View File

File diff suppressed because it is too large Load Diff