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

updated lcl documentation from Matthijs

Browse Source 
git-svn-id: trunk@7178 -
This commit is contained in:
vincents 2005-05-16 18:17:25 +00:00
parent abefc8a3b6
commit be8a4a043f
4 changed files with 27678 additions and 39396 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -102,9 +102,7 @@
</element> </element>
<!-- enumeration type Visibility: default --> <!-- enumeration type Visibility: default -->
<element name="TButtonLayout"> <element name="TButtonLayout">
<short/> <short>A set of constants to define the position of a glyph on a button.</short>
<descr/>
<seealso/>
</element> </element>
<!-- enumeration value Visibility: default --> <!-- enumeration value Visibility: default -->
<element name="TButtonLayout.blGlyphLeft"> <element name="TButtonLayout.blGlyphLeft">
@ -124,9 +122,7 @@
</element> </element>
<!-- enumeration type Visibility: default --> <!-- enumeration type Visibility: default -->
<element name="TButtonState"> <element name="TButtonState">
<short/> <short>A set of constants to define the state of a SpeedButton.</short>
<descr/>
<seealso/>
</element> </element>
<!-- enumeration value Visibility: default --> <!-- enumeration value Visibility: default -->
<element name="TButtonState.bsUp"> <element name="TButtonState.bsUp">
@ -152,10 +148,8 @@
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TCustomButton"> <element name="TCustomButton">
<short/> <short>The ancestor class for TButton</short>
<descr/> <descr>TCustomButton is the ancestor for TButton. If you want to define your own button class, you should use this class to derive it from.</descr>
<errors/>
<seealso/>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
<element name="TCustomButton.FCancel"> <element name="TCustomButton.FCancel">
@ -377,29 +371,29 @@
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TButton"> <element name="TButton">
<short>TButton is a push button control</short> <short>A push button control</short>
<descr>TButton is a push button control. An user pushes a button to start an action.</descr> <descr>TButton is a push button control. An user pushes a button to start an action.</descr>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TButton.Click"> <element name="TButton.Click">
<short>Click, calling this method will invoke the OnClick event of the button</short> <short>Click, calling this method will invoke the OnClick event of the button</short>
<descr>If you want to programmatically Click on a button you can call it Click method. This will have the same effect as a user clicking on the button.</descr> <descr>If you want to programmatically Click on a button you can call its Click method. This will have the same effect as a user clicking on the button.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Action"> <element name="TButton.Action">
<short>Action can be used with ActionList</short> <short>The action executed when the user clicks the button.</short>
<descr>If you assign an action from an ActionList to a TButton.Action the correspondig execute-method is assign to the OnClick event of to button.</descr> <descr>If you assign an action from an ActionList to a TButton.Action the correspondig execute-method is assigned to the OnClick event of the button. Assigning a action sets ohter properties of the button as well, like Enabled and Caption.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Align"> <element name="TButton.Align">
<short>Align is used to allign a button to a border of a parent control.</short> <short>Is used to align a button to a border of a parent control.</short>
<descr>Allign is used to allign a button to a border of a parent control, even if the parent control is resized. <descr>Align is used to align a control to a border of a parent control, even if the parent control is resized.<br/><br/>
Possible values fo Allign are: Possible values fo Allign are:<br/>
alTop: Places the control at the top, using the full clientwidth of its parent control. alTop: Places the control at the top, using the full clientwidth of its parent control.<br/>
alBottom: Places the control at the bottom, using the full clientwidth of its parent control. alBottom: Places the control at the bottom, using the full clientwidth of its parent control.<br/>
alLeft: Places the control at the left side of its parent and uses the available height between any top or bottom alligned controls. alLeft: Places the control at the left side of its parent and uses the available height between any top or bottom alligned controls.<br/>
alRight: Like alLeft but on the right side of the parent control. alRight: Like alLeft but on the right side of the parent control.<br/>
alNone: The control can be placed anywhere on the parent control alNone: The control can be placed anywhere on the parent control.<br/>
alClient: The control takes al available space on parent control next to controls aligned to the top, bottom, right or left.</descr> alClient: The control takes al available space on parent control next to controls aligned to the top, bottom, right or left.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
@ -420,12 +414,12 @@ For instance setting Anchors to [akBottom, akRight] will keep the control at a c
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Cancel"> <element name="TButton.Cancel">
<short>Cancel setting this property will make is OnClick event executed when the user hits ESC.</short> <short>Setting this property will make the OnClick event executed when the user hits ESC.</short>
<descr>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</descr> <descr>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Caption"> <element name="TButton.Caption">
<short>The Caption is used to set the text displayed on the button.</short> <short>Sets the text displayed on the button.</short>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Constraints"> <element name="TButton.Constraints">
@ -434,14 +428,14 @@ For instance setting Anchors to [akBottom, akRight] will keep the control at a c
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Default"> <element name="TButton.Default">
<short>If the default porperty is set of a Button its OnClick event will be called when the user presses ENTER</short> <short>Setting this property will make the OnClick event executed when the user hits ENTER</short>
<descr>Defines if a button is the default on a form. That is, pressing enter will execute its onClick wether the control has focus or not!</descr> <descr>Defines if a button is the default on a form. That is, pressing enter will execute its onClick wether the control has focus or not!</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Enabled"> <element name="TButton.Enabled">
<short>If a button can be clicked on is determined by the Enabled property.</short> <short>Determines if the button reacts to a click.</short>
<descr>Setting this property determines if the control can be used. If Enabled is false a button cannot be clicked. Setting the Enabled property to false also makes its caption grayed. <descr>Setting this property determines if the control can be used. If Enabled is false a button cannot be clicked. Setting the Enabled property to false also makes its appearance grayed.
If an Action has been assigned to the button and this action is disabled then the button gets its Enabled property set to false as well.</descr> If an Action has been assigned to the button and this action is disabled then the enabled property is set to false as well.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Font"> <element name="TButton.Font">
@ -566,10 +560,7 @@ If an Action has been assigned to the button and this action is disabled then th
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TButtonGlyph"> <element name="TButtonGlyph">
<short/> <short>A special class used in buttons with a Glyph (TSpeedButton and TBitBtn)</short>
<descr/>
<errors/>
<seealso/>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
<element name="TButtonGlyph.FOriginal"> <element name="TButtonGlyph.FOriginal">
@ -691,9 +682,7 @@ If an Action has been assigned to the button and this action is disabled then th
</element> </element>
<!-- enumeration type Visibility: default --> <!-- enumeration type Visibility: default -->
<element name="TBitBtnKind"> <element name="TBitBtnKind">
<short/> <short>A set of possible types for BitButtons.</short>
<descr/>
<seealso/>
</element> </element>
<!-- enumeration value Visibility: default --> <!-- enumeration value Visibility: default -->
<element name="TBitBtnKind.bkCustom"> <element name="TBitBtnKind.bkCustom">
@ -748,17 +737,11 @@ If an Action has been assigned to the button and this action is disabled then th
<short/> <short/>
</element> </element>
<!-- set type Visibility: default --> <!-- set type Visibility: default -->
<element name="TBitBtnKinds"> <element name="TBitBtnKinds"/>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TCustomBitBtn"> <element name="TCustomBitBtn">
<short/> <short>The ancestor class for TBitBtn.</short>
<descr/> <descr>TCustomBitBtn is the ancestor for TBitBtn. If you want to define your own bitbutton class, you should use this class to derive it from.</descr>
<errors/>
<seealso/>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
<element name="TCustomBitBtn.FButtonGlyph"> <element name="TCustomBitBtn.FButtonGlyph">
@ -1008,24 +991,30 @@ If an Action has been assigned to the button and this action is disabled then th
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TBitBtn"> <element name="TBitBtn">
<short>A push button that can show a glyph.</short> <short>A push button that can show a glyph.</short>
<descr>TBitBtn is a push button control which can show a glyph. An user pushes a button to start an action.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.Action"> <element name="TBitBtn.Action">
<short/> <short>The action executed when the user clicks the button.</short>
<descr/> <descr>If you assign an action from an ActionList to a TBitBtn.Action the correspondig execute-method is assigned to the OnClick event of the button. Assigning a action sets ohter properties of the button as well, like Enabled and Caption.</descr>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.Align"> <element name="TBitBtn.Align">
<short/> <short>Is used to allign a bitbutton to a border of a parent control.</short>
<descr/> <descr>Align is used to align a control to a border of a parent control, even if the parent control is resized.<br/><br/>
<seealso/> Possible values fo Allign are:<br/>
alTop: Places the control at the top, using the full clientwidth of its parent control.<br/>
alBottom: Places the control at the bottom, using the full clientwidth of its parent control.<br/>
alLeft: Places the control at the left side of its parent and uses the available height between any top or bottom alligned controls.<br/>
alRight: Like alLeft but on the right side of the parent control.<br/>
alNone: The control can be placed anywhere on the parent control.<br/>
alClient: The control takes al available space on parent control next to controls aligned to the top, bottom, right or left.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.Anchors"> <element name="TBitBtn.Anchors">
<short/> <short>Anchors are used to keep a button on a defined distance to certain borders of the parent control.</short>
<descr/> <descr>Anchors can be used to keep control at a certain distance from a side of its parent control, when the parent control is resized.<br/><br/>
<seealso/> For instance setting Anchors to [akBottom, akRight] will keep the control at a constant distance to the bottom right corner.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.BorderSpacing"> <element name="TBitBtn.BorderSpacing">
@ -1035,33 +1024,27 @@ If an Action has been assigned to the button and this action is disabled then th
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.Cancel"> <element name="TBitBtn.Cancel">
<short/> <short>Setting this property will make the OnClick event executed when the user hits ESC.</short>
<descr/> <descr>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</descr>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.Caption"> <element name="TBitBtn.Caption">
<short/> <short>Sets the text displayed on the button.</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.Constraints"> <element name="TBitBtn.Constraints">
<short/> <short>Used to give a control certain minimum and or maximum dimensions.</short>
<descr/> <descr>Sets the minimum and maximum sizes for a control. If a control is resized the new dimensions are allways within the ranges given here. You should take care when setting these options that they do not conflict with the Anchors en Allign settings.</descr>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.Default"> <element name="TBitBtn.Default">
<short/> <short>Setting this property will make the OnClick event executed when the user hits ENTER</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.Enabled"> <element name="TBitBtn.Enabled">
<short/> <short>Determines if the button reacts to a click.</short>
<descr/> <descr>Setting this property determines if the control can be used. If Enabled is false a bitbutton cannot be clicked. Setting the Enabled property to false also makes its appearance grayed.
<seealso/> If an Action has been assigned to the bitbutton and this action is disabled then the enabled property is set to false as well.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBitBtn.Font"> <element name="TBitBtn.Font">
@ -1209,10 +1192,7 @@ If an Action has been assigned to the button and this action is disabled then th
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TSpeedButtonActionLink"> <element name="TSpeedButtonActionLink">
<short/> <short>Links a TSpeedButton with an action.</short>
<descr/>
<errors/>
<seealso/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TSpeedButtonActionLink.AssignClient"> <element name="TSpeedButtonActionLink.AssignClient">
@ -1271,10 +1251,8 @@ If an Action has been assigned to the button and this action is disabled then th
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TCustomSpeedButton"> <element name="TCustomSpeedButton">
<short/> <short>The ancestor class for TSpeedButton</short>
<descr/> <descr>TCustomSpeedButton is the ancestor for TSpeedButton. If you want to define your own speedbutton class, you should use this class to derive it from.</descr>
<errors/>
<seealso/>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
<element name="TCustomSpeedButton.FAllowAllUp"> <element name="TCustomSpeedButton.FAllowAllUp">
@ -1783,22 +1761,26 @@ If an Action has been assigned to the button and this action is disabled then th
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TSpeedButton"> <element name="TSpeedButton">
<short/> <short>A button control</short>
<descr/> <descr>TSpeedButton is a button control. It can show a glyph and has a state. An user pushes a button to start an action or set a mode. When a user clicks on a SpeedButton focus is not shifted. A SpeedButton never gets focus.</descr>
<errors/>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Action"> <element name="TSpeedButton.Action">
<short/> <short>The action executed when the user clicks the speedbutton.</short>
<descr/> <descr>If you assign an action from an ActionList to a TSpeedButton.Action the correspondig execute-method is assigned to the OnClick event of the SpeedButton. Assigning a action sets ohter properties of the button as well, like Enabled and Caption.</descr>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Align"> <element name="TSpeedButton.Align">
<short/> <short>Is used to align the button to a border of a parent control.</short>
<descr/> <descr>Align is used to align a control to a border of a parent control, even if the parent control is resized.
<seealso/> <br/><br/>
Possible values fo Allign are:<br/>
alTop: Places the control at the top, using the full clientwidth of its parent control.<br/>
alBottom: Places the control at the bottom, using the full clientwidth of its parent control.<br/>
alLeft: Places the control at the left side of its parent and uses the available height between any top or bottom alligned controls.<br/>
alRight: Like alLeft but on the right side of the parent control.<br/>
alNone: The control can be placed anywhere on the parent control.<br/>
alClient: The control takes al available space on parent control next to controls aligned to the top, bottom, right or left.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Anchors"> <element name="TSpeedButton.Anchors">
@ -1808,9 +1790,8 @@ If an Action has been assigned to the button and this action is disabled then th
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.AllowAllUp"> <element name="TSpeedButton.AllowAllUp">
<short/> <short>Determines wether all speedbuttons in a group can be up.</short>
<descr/> <descr>SpeedButtons can be grouped by setting their GroupIndex. AllowAllUp specifies whether or not all SpeedButtons in this group can be unselected (all have the state Up). Changing this property for one SpeedButtons sets this for all SpeedButtons in the same group. A GroupIndex of 0 has no effect, that is AllowAllUp has no effect if GroupIndex is 0.</descr>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.BorderSpacing"> <element name="TSpeedButton.BorderSpacing">
@ -1826,21 +1807,18 @@ If an Action has been assigned to the button and this action is disabled then th
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Caption"> <element name="TSpeedButton.Caption">
<short/> <short>Sets the text displayed on the button.</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Down"> <element name="TSpeedButton.Down">
<short/> <short>Maintains the state of the button.</short>
<descr/> <descr>If the groupindex of a SpeedButton is unequal to 0, its state can be up or down. Use this properties to read or set the state of a speedbutton.</descr>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Enabled"> <element name="TSpeedButton.Enabled">
<short/> <short>Determines if the button reacts to a click.</short>
<descr/> <descr>Setting this property determines if the control can be used. If Enabled is false a speedbutton cannot be clicked. Setting the Enabled property to false also makes its appearance grayed.<br/>
<seealso/> If an Action has been assigned to the speedbutton and this action is disabled then the enabled property is set to false as well.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Flat"> <element name="TSpeedButton.Flat">
@ -1850,21 +1828,27 @@ If an Action has been assigned to the button and this action is disabled then th
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Glyph"> <element name="TSpeedButton.Glyph">
<short/> <short>Property to read and set the glyph.</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.GroupIndex"> <element name="TSpeedButton.GroupIndex">
<short/> <short>Determines how a SpeedButton reacts when it is clicked.</short>
<descr/> <descr>If GroupIndex = 0, the speedbutton reacts like a ordinary push button. That is it appears down when the user clicks on it and it comes up again when the user releases the mouse button.
<seealso/>
If GroupIndex &gt; 0, the speedbuttons remains down after the user clicks on it, until it receives a second click.
If more SpeedButtons have the same GroupIndex the behave like a group. You can use SpeedButtons in a group to present mutually exclusive choices to the user. If the user clicks on a SpeedButton in a group, this SpeedButton gets the down state, returning all other buttons to the up state.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Layout"> <element name="TSpeedButton.Layout">
<short/> <short>Determines the place of the glyph with respect to the caption.</short>
<descr/> <descr>Determines the place of the glyph with respect to the caption.
<seealso/> <br/><br/>
Possible values are:<br/>
blGlyphBottom: The glyph is shown under the caption.<br/>
blGlyphLeft: The glyph is shown left of the caption.<br/>
blGlyphRight: The glyph is shown right of the caption.<br/>
blGlyphTop: The glyph is shown above the caption.</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TSpeedButton.Margin"> <element name="TSpeedButton.Margin">

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

6
docs/xml/lcl/dialogs.xml
View File

@ -608,7 +608,7 @@
</element> </element>
<!-- enumeration type Visibility: default --> <!-- enumeration type Visibility: default -->
<element name="TOpenOption"> <element name="TOpenOption">
<short>A set of Options for the OpenDialog</short> <short>A set of possible options which can be used in OpenDialog</short>
</element> </element>
<!-- enumeration value Visibility: default --> <!-- enumeration value Visibility: default -->
<element name="TOpenOption.ofReadOnly"> <element name="TOpenOption.ofReadOnly">
@ -1264,8 +1264,8 @@ choice of colour for text or graphics.</descr>
</element> </element>
<!-- enumeration type Visibility: default --> <!-- enumeration type Visibility: default -->
<element name="TFindOption"> <element name="TFindOption">
<short>A set of posible options which can be used in Find-dialogs.</short> <short>A set of possible options which can be used in Find-dialogs.</short>
<descr>A set of posible options which can be used in Find-dialogs.</descr> <descr>A set of possible options which can be used in Find-dialogs.</descr>
</element> </element>
<!-- enumeration value Visibility: default --> <!-- enumeration value Visibility: default -->
<element name="TFindOption.frDown"> <element name="TFindOption.frDown">