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

LazDoc: Moved description of TButton here from unit Buttons

Browse Source 
git-svn-id: trunk@12695 -
This commit is contained in:
kirkpatc 2007-11-02 13:05:40 +00:00
parent 09342edb8f
commit 44f7d0ddf5
1 changed files with 416 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

416
docs/xml/lcl/stdctrls.xml
View File

@ -4594,6 +4594,422 @@ Properties can include [Checked], [Click] (mouse clicks on button) and the actio
<descr/>
<seealso/>
</element>
<short>The ancestor class for TButton</short>
<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>
</element>
<!-- variable Visibility: private -->
<element name="TCustomButton.FCancel">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomButton.FDefault">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomButton.FModalResult">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomButton.FShortCut">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomButton.SetCancel">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.SetCancel.NewCancel">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomButton.SetDefault">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.SetDefault.Value">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomButton.SetModalResult">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.SetModalResult.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomButton.WMDefaultClicked">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.WMDefaultClicked.Message">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomButton.Click">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomButton.CreateWnd">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomButton.DoSendBtnDefault">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomButton.ControlKeyDown">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.ControlKeyDown.Key">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.ControlKeyDown.Shift">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomButton.ControlKeyUp">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.ControlKeyUp.Key">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.ControlKeyUp.Shift">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomButton.SetParent">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.SetParent.AParent">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomButton.RealSetText">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.RealSetText.Value">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TCustomButton.ChildClassAllowed">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomButton.ChildClassAllowed.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.ChildClassAllowed.ChildClass">
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomButton.Create">
<short>Creates a new instance of the TCustomButton class</short>
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
However, if you create the component by code don´t forget to free it when it is no longer needed.
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</descr>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomButton.Create.TheOwner">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomButton.ExecuteDefaultAction">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomButton.ExecuteCancelAction">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomButton.UpdateRolesForForm">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomButton.Color">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomButton.Default">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomButton.ModalResult">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomButton.Cancel">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomButton.TabStop">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TButton">
<short>The most basic button component</short>
<descr>Button: Base type for all Buttons. A push button control. The user pushes a button (eg selects it with the mouse cursor and clicks the mouse) to start an action.</descr>
</element>
<!-- procedure Visibility: public -->
<element name="TButton.Click">
<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 its Click method. This will have the same effect as a user clicking on the button.</descr>
</element>
<!-- property Visibility: published -->
<element name="TButton.Action">
<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 assigned to the OnClick event of the button. Assigning a action sets other properties of the button as well, like Enabled and Caption.</descr>
</element>
<!-- property Visibility: published -->
<element name="TButton.Align">
<short></short>
<descr><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>
<errors></errors>
<seealso></seealso>
</element>
<!-- property Visibility: published -->
<element name="TButton.Anchors">
<short>Anchors are used to keep a button on a defined distance to certain borders of the parent control.</short>
<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.
For instance setting Anchors to [akBottom, akRight] will keep the control at a constant distance to the bottom right corner.</descr>
</element>
<!-- property Visibility: published -->
<element name="TButton.AutoSize">
<short>Autosize in TButton has no function.</short>
<descr>If this property is set to true, the control will automatically adapt its size to be able to accomodate its content. This property is not used in Buttons.</descr>
</element>
<!-- property Visibility: published -->
<element name="TButton.BorderSpacing">
<short>Borderspacing ????</short>
</element>
<!-- property Visibility: published -->
<element name="TButton.Cancel">
<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>
</element>
<!-- property Visibility: published -->
<element name="TButton.Caption">
<short>Sets the text displayed on the button.</short>
</element>
<!-- property Visibility: published -->
<element name="TButton.Constraints">
<short>Constraints can be used to give a control certain minimum and or maximum dimensions.</short>
<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>
</element>
<!-- property Visibility: published -->
<element name="TButton.Default">
<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>
</element>
<!-- property Visibility: published -->
<element name="TButton.Enabled">
<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 appearance grayed.
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>
<!-- property Visibility: published -->
<element name="TButton.Font">
<short>Font is used to set the font of the caption of the Button.</short>
<descr>Font is used to set the font of the caption of the Button.</descr>
</element>
<!-- property Visibility: published -->
<element name="TButton.ModalResult">
<short>If the button gets clicked, the ModalResult of the form will be set to this value.</short>
<descr>Setting ModalResult of a button makes closing a form easy. Just set this property to a value different from mrNone and a click on this button will set the modalresult of the form it is placed on to this value. Setting the ModalResult of a form will make it close.</descr>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnChangeBounds">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnClick">
<short>The OnClick event is triggered when a user clicks on the button</short>
<descr>The OnClick event is triggered when a user clicks on the button. It can also be invoked by calling the Click method.</descr>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnEnter">
<short>The OnEnter event is triggered when the button gets focus.</short>
<descr>The OnEnter event is triggered when the button gets focus.</descr>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnExit">
<short>The OnExit event is triggered when the button loses focus.</short>
<descr>The OnExit event is triggered when the button loses focus.</descr>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnKeyDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnKeyPress">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnKeyUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnMouseEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnMouseLeave">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.TabStop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButton.Visible">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TCheckBoxState">
<short>Check Box State</short>