From e854ebc85551379fd6e07addadf48a66a0901a63 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Thu, 6 Dec 2007 23:23:07 +0000 Subject: [PATCH] LazDoc - updates in StdCtrls.xml to: TCustomEdit, TCustomMemo, TMemo, TCustomStaticText, TStaticText, TButtonControl, TCustomButton, TCustomCheckBox, TCheckBox, TToggleBox, TRadioButton, TCustomLabel, TLabel and consequential changes to TControl in Controls.xml git-svn-id: trunk@13185 - --- docs/xml/lcl/controls.xml | 13 +- docs/xml/lcl/stdctrls.xml | 283 +++++++++++--------------------------- 2 files changed, 88 insertions(+), 208 deletions(-) diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index c91f576057..631e75ad7a 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -4710,10 +4710,7 @@ mrLast=mrYesToAll=10 - - - - + Click - a procedure that allows the programmer to simulate a mouse click over the control, and initiates the same Action as that associated with the OnClick event @@ -8545,8 +8542,12 @@ Properties are defined in the parent class TPop - Determines if the user can tab to a control. - Reads or writes boolean flag; default is False + TabStop - determines if the user can tab to a control. + +

Reads or writes boolean flag; default is False

+

Use the TabStop to allow or disallow access to the control using the Tab key.

+

If TabStop is True, the control is in the tab order. If TabStop is False, the control is not in the tab order and the user can't use the Tab key to move to the control.

+ diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml index 82c6bba951..bf8ebd1e57 100644 --- a/docs/xml/lcl/stdctrls.xml +++ b/docs/xml/lcl/stdctrls.xml @@ -3971,45 +3971,27 @@ Indicates how text is displayed in a text editing control.

- - - - + Clear - delete all text - - - - + SelectAll text, for example in order to copy or delete it - - - - + ClearSelection - delete all characters in selected text - - - - + CopyToClipboard - put a copy of the selection on the clipboard, while leaving the original text in place - - - - + CutToClipboard - remove the selected text from its original location and put it on the clipboard - - - - + PasteFromClipboard - put a copy of the clipboard contents at the current writing position @@ -4164,10 +4146,7 @@ Indicates how text is displayed in a text editing control.

 - Custom Memo - Custom Memo: the base type from which Memo is derived - - + TCustomMemo: the base class for TMemo @@ -4413,24 +4392,18 @@ Indicates how text is displayed in a text editing control.

 - - - - + Append - procedure for adding a text string to the Memo - - - + Alignment - whether text is centered, left- or right-justified - Lines - Lines: an array of strings (representing single lines of characters) which contains the textual material held or being entered in the Memo. The array is zero-indexed, ie the strings are numbered [0..numLines-1] - + Lines : an array of strings (single lines of characters) which contains the text held or being entered in the Memo + Lines: an array of strings (representing single lines of characters) which contains the textual material held or being entered in the Memo. The array is zero-indexed, ie the strings are numbered [0..numLines-1] @@ -4446,9 +4419,7 @@ Indicates how text is displayed in a text editing control.

 - - - + Whether the Memo has ScrollBars - none, horizontal or vertical or both, or automatically placed if needed @@ -4464,9 +4435,8 @@ Indicates how text is displayed in a text editing control.

 - Word Wrap + Is WordWrap enabled, allowing long words to be carried on to the next line? Word Wrap: a logical flag to show whether or not word-wrap is enabled, ie if a word is close to the end of a line and is going to be too long for the line, it is wrapped down to the next line - @@ -4645,8 +4615,11 @@ Indicates how text is displayed in a text editing control.

- Memo Box - Memo box: for entry or display of multiple lines of text. + TMemo - a box for entry or display of multiple lines of text + +

TMemo - a box for entry or display of multiple lines of text.

+

The textual data is held as an array of strings in Lines, where it can be edited

+ @@ -4716,11 +4689,7 @@ Indicates how text is displayed in a text editing control.

 - - Lines - Lines: an array of strings (representing single lines of characters) which contains the textual material held or being entered in the Memo. - - + Max Length @@ -4915,24 +4884,10 @@ Indicates how text is displayed in a text editing control.

- Custom Static Text - Custom Static Text: the base type from which Static Text is derived. - - + TCustomStaticText: the base class for Static Text - - FAutoSelected: Boolean - Private variable for property AutoSelected. - -True indicate that the edit or combobox control has just performed -an AutoSelect operation so that subsequent mouse-clicks and keystrokes -proceeds normally without selecting the text. - -False is set when the edit or combobox control looses focus. - - - + @@ -5056,9 +5011,7 @@ False is set when the edit or combobox control looses focus. - - - + Alignment - whether text is centered, left- or right-justified @@ -5074,14 +5027,19 @@ False is set when the edit or combobox control looses focus. - - - + ShowAccelChar - underline the character in the static text that acts as an accelerator with a shortcut key + +

ShowAccelChar - underline the character in the static text that acts as an accelerator with a shortcut key

+

Boolean property - default True

+ - Static Text - Static Text: a box to display a Constant Text String + TStaticText: a box to display a Constant Text String + +

TStaticText: a box to display a Constant Text String

+

Use this control to display a statement or comment that is not likely to change very often, or is not usually responsive to user actions

+ @@ -5284,10 +5242,7 @@ False is set when the edit or combobox control looses focus. - Button Control - Button Control: Base Type for the Button (including Radio Button) and Check Box types ; - - + TButtonControl: ancestor class for several Button (including Radio Button) and Check Box classes @@ -5358,10 +5313,11 @@ False is set when the edit or combobox control looses focus. - - - - + Click - the procedure which allows programmatic simulation of a mouse click + +

Click - the procedure which allows programmatic simulation of a mouse click, and thus activation of the Action associated with the OnClick event +

+ @@ -5381,9 +5337,7 @@ False is set when the edit or combobox control looses focus. - - - + Checked - whether this button has been checked, which signifies selection @@ -5460,14 +5414,7 @@ False is set when the edit or combobox control looses focus. - - TCustomButton - - - TCustomButton - - - + TCustomButton - the base class for TButton and TBitBtn @@ -5701,9 +5648,7 @@ False is set when the edit or combobox control looses focus. - - - + Is this control Active - has it got Focus; is the mouse over it? @@ -5967,9 +5912,8 @@ False is set when the edit or combobox control looses focus. - TCustomCheckBox is the ancestor of all check-box components. - Custom Check Box: The base (abstract) class from which the TCheckBox is derived. Check boxes present the user with options that can be selected (checked) or deselected (unchecked). - + TCustomCheckBox is the ancestor of all check-box components. +

TCustomCheckBox: The base (abstract) class from which the TCheckBox is derived

.

Check boxes present the user with options that can be selected (checked) or deselected (unchecked).

 @@ -6135,24 +6079,24 @@ False is set when the edit or combobox control looses focus. Determines whether the check box can be in a "grayed" state. - If AllowGrayed is set to True, the check box has three possible states: checked, unchecked and grayed. If AllowGrayed is set to False, the check box has only two possible states: checked and unchecked. - + +

If AllowGrayed is set to True, the check box has three possible states: checked, unchecked and grayed. If AllowGrayed is set to False, the check box has only two possible states: checked and unchecked.

+ - Indicates whether the check box is selected, deselected or grayed. - See TCheckBoxState for possible values of State. - + Indicates whether the check box is checked (selected), unchecked (deselected) or grayed. + +

See TCheckBoxState for possible values of State.

+ - Determines if the user can tab to a control. Use the TabStop to allow or disallow access to the control using the Tab key. If the TabStop is True, the control is in the tab order. If TabStop is False, the control is not in the tab order and the user can't press the Tab key to move to the control. - @@ -6179,9 +6123,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - - AllowGrayed: a flag to show whether the box is allowed to be Greyed out - + @@ -6360,8 +6302,11 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - Toggle Box - Toggle Box: a labelled box capable of being checked (when it becomes recessed) or unchecked (when it is raised). + TToggle Box: a labelled box capable of being checked or unchecked + +

TToggle Box: a labelled box capable of being checked (when it becomes recessed) or unchecked (when it is raised).

+

The Application Programmer is responsible for ensuring that the OnClick event handler recognises the State of the box, takes the appropriate Action and places the State into the next appropriate value

+ @@ -6555,8 +6500,11 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - Radio Button - Radio Button: a button which works in conjunction with other Radio Buttons in a mutually exclusive manner - if one button of a group is selected, none of the others in that group can be selected. + TRadioButton: a button that works with other Radio Buttons in a mutually exclusive way - if one button is selected, none of the others in the group can be selected + +

TRadioButton: a button that works in conjunction with other Radio Buttons in a mutually exclusive manner - if one button of a group is selected, none of the others in that group can be selected.

+

The Application Programmer is responsible for ensuring that the OnClick event handler for each button has a unique Action, and that the Actions of the other (deselected and therefore inactive) buttons are turned off.

+ @@ -7105,15 +7053,11 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - - - + Alignment - whether text is centered, left- or right-justified - - - + FocusControl - whether this control has focus @@ -7129,9 +7073,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - - - + Transparent - whether the viewer can see through the control. Default True @@ -7143,9 +7085,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - - - + OptimalFill - boolean. If True, font size is adjusted for optimal fill of available space @@ -7216,16 +7156,11 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - Label - Label: a brief text label to be placed in the Form near any object that needs to be identified. + TLabel: a brief text label to be placed in the Form near any object that needs to be identified. - - Align - Align: Is used to align a Control component to a border of a parent control. - - + @@ -7233,11 +7168,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - - Anchors - Anchors: keep the edges of a control component a defined distance from certain borders of the parent control. - - + @@ -7257,11 +7188,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - - Caption - Caption - the text string that represents the contents of the label - - + @@ -7269,11 +7196,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - - Constraints - Constraints: Sets the minimum and maximum sizes for a control. - - + @@ -7359,29 +7282,13 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - - Visible - Visible - determines whether or not the control can be seen - - + - - Word Wrap - Word Wrap: a logical flag to show whether or not word-wrap is enabled, ie if a word is near the end of a line and is going to be too long for the line, it is wrapped down to the next line - - + - - On Click - On Click - Action to be taken when the mouse button is clicked with the cursor over this control. User-defined Procedure - - + - - On Double-click - On Double-click - Action to be taken when the mouse button is double-clicked with the cursor over this control. - - + @@ -7401,47 +7308,19 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - - On Mouse Down - Action - On Mouse Down - Action to be taken if the mouse button is down while focus is in this control. - - + - - On Mouse Movement - Action - On Mouse Movement - Action to be taken if the mouse cursor moves while within the bounds of this control. User-defined Procedure - - + - - On Mouse Up - On Mouse Up - Action to be taken if the mouse button is up while the cursor is over this control. - - + - - On Mouse Entry - On Mouse Entry - Action to be taken when the mouse cursor enters the bounds of this control. User-defined Procedure - - + - - On Mouse Leaving - On Mouse Leaving - Action to be taken when the mouse cursor leaves the boundaries of this control. User-defined Procedure. - - + - - On Change Bounds - On Change Bounds - Action to be taken if any of the bounds of the control are changed. - - + - - On Resize - Action - On Resize - Action to be taken when the control is resized. Might include re-alignment of text or selection of a different font size etc. User-defined Procedure - - +