diff --git a/docs/xml/lcl/actnlist.xml b/docs/xml/lcl/actnlist.xml index 3d5fafad3b..d99d229305 100644 --- a/docs/xml/lcl/actnlist.xml +++ b/docs/xml/lcl/actnlist.xml @@ -47,7 +47,8 @@ - + + TContainedAction - parent class for TCustomAction; defines some properties especially relationships with parents @@ -120,7 +121,7 @@ - + @@ -131,7 +132,7 @@ - + @@ -149,8 +150,7 @@ - - Deallocates an object + 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. Take the following precautions when creating your own Destroy method: @@ -161,12 +161,13 @@ Take the following precautions when creating your own Destroy method: * An exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called, so your destructor must check if the resources were really allocated before disposing of them. -* Remember to call Free for all objects created on the constructor. +* Remember to call Free for all objects created on the constructor. + - + @@ -177,7 +178,7 @@ Take the following precautions when creating your own Destroy method: - + @@ -188,7 +189,7 @@ Take the following precautions when creating your own Destroy method: - + @@ -199,7 +200,7 @@ Take the following precautions when creating your own Destroy method: - + @@ -211,19 +212,19 @@ Take the following precautions when creating your own Destroy method: - + The ActionList in which this action is contained - + The Index of this action in the list of actions - + The Category of this action @@ -389,7 +390,8 @@ Take the following precautions when creating your own Destroy method: - + + AddAction - adds an action to the list @@ -400,7 +402,8 @@ Take the following precautions when creating your own Destroy method: - + + RemoveAction - removes an action from the list @@ -411,13 +414,14 @@ Take the following precautions when creating your own Destroy method: - + + Change the action - + @@ -432,7 +436,7 @@ Take the following precautions when creating your own Destroy method: - + @@ -447,7 +451,7 @@ Take the following precautions when creating your own Destroy method: - + @@ -463,7 +467,8 @@ Take the following precautions when creating your own Destroy method: - + + SetImages - stores a list of images @@ -474,34 +479,33 @@ Take the following precautions when creating your own Destroy method: - + + OnChange - event handler for a change in the action - + + OnExecute - event handler for execution of the action - + + OnUpdate - event handler for updating the action - - - Create a new instance of the TCustomActionList class - + - - Destroys the instance of the component. + Destroy sends a opRemove notification to all components in the free-notification list. After that, all owned components are @@ -512,8 +516,7 @@ After that, the parent's destroy method is called. - - Standard action execution method. + ExecuteAction checks whether Action handles the current component, and if yes, calls the ExecuteAction method, @@ -532,8 +535,7 @@ action handles the current component. - - Updates the state of an action. + UpdateAction checks whether Action handles the current component, and if yes, calls the UpdateTarget method, @@ -626,32 +628,27 @@ action handles the current component. - - The Images from an ImageList to be associated with the actions, eg in a Menu display + - - State of the action : Normal, Suspended or SuspendedEnabled + - - Event handler for change in action list + - - Event handler for executing action + - - Event handler for updating action list + @@ -679,7 +676,7 @@ action handles the current component. - Add a shortcut to the list + Add a shortcut to the list; implements the function @@ -1025,8 +1022,7 @@ action handles the current component. - - Generic assignment function. +

AssignTo is the generic function to assign the class' contents to @@ -1057,7 +1053,7 @@ execution will end up at the TPersistent implementation of - + @@ -1069,7 +1065,8 @@ execution will end up at the TPersistent implementation of - + + HandleShortCut - returns True if there is a short cut associated with the handle @@ -1080,24 +1077,19 @@ execution will end up at the TPersistent implementation of - + + SavedEnabledState - if True, the Enabled state has been saved - - - Create a new instance of the TCustomAction class - + - - - Destroy - Deallocates an object - + @@ -1113,10 +1105,7 @@ execution will end up at the TPersistent implementation of HintStr - the text-string for display as a hint - - - Execute - method to determine if action is to be performed - + True if action is to be performed @@ -1209,85 +1198,63 @@ execution will end up at the TPersistent implementation of - - - Create a new instance of the TCustomAction class - + - - - AutoCheck - whether the control (eg a CheckBox) is to be automatically checked + - - The Caption to be used if this action is associated with a visible component + - - Whether the CheckBox associated with the action is Checked (default False) + - - - Enabled - whether this action is able to be used (default True) + - - - GroupIndex - Index of the action within its group + - - - HelpContext - the index for a context-based help message + - - - HelpKeyWord - the keyword of a context-based help message + - - - HelpType - the sort of help message to be offered: default Context-based + - - - Hint - a pop-up message that appears when the mouse hovers over an object + - - - ImageIndex - the index number of the image to be associated with this action + - - Event triggered when the action executes. +

OnExecute is the event triggered when the action is activated @@ -1306,15 +1273,12 @@ normal task if the OnExecute handler was called. - - - OnHint - action to be taken when a hint is required + - - Event trigged when the application is idle. + OnUpdate is the event triggered when the application is idle, and the action is being updated. The OnUpdate event can be used to @@ -1324,22 +1288,18 @@ executed at this point in time. - - - SecondaryShortCuts - a stringlist containing shortcuts + - + - - - Visible - is this action visible? (default True) + @@ -1753,9 +1713,7 @@ executed at this point in time. This action is associated with a shortcut - - Disable this action if no handler is found - + diff --git a/docs/xml/lcl/arrow.xml b/docs/xml/lcl/arrow.xml index 45f9f0c1ce..b759704e3c 100644 --- a/docs/xml/lcl/arrow.xml +++ b/docs/xml/lcl/arrow.xml @@ -1,426 +1,298 @@ - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Defines the Arrow symbol widely used in Forms + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TArrow - an arrow symbol widely used in forms + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ArrowType - pointing up, down, left or right + + + + + + + + + + + + + ShadowType - the type of shadowing: None, In, Out, EtchedIn, EtchedOut + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/xml/lcl/buttonpanel.xml b/docs/xml/lcl/buttonpanel.xml index 3aa8a58a2e..7877869db2 100644 --- a/docs/xml/lcl/buttonpanel.xml +++ b/docs/xml/lcl/buttonpanel.xml @@ -124,7 +124,7 @@ - + @@ -135,31 +135,31 @@ - + - + - + - + - + @@ -337,7 +337,7 @@ - + @@ -348,7 +348,7 @@ - + @@ -497,139 +497,139 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -641,6 +641,11 @@ + + + + + diff --git a/docs/xml/lcl/buttons.xml b/docs/xml/lcl/buttons.xml index 48cfdbc736..a173c551d6 100644 --- a/docs/xml/lcl/buttons.xml +++ b/docs/xml/lcl/buttons.xml @@ -203,19 +203,18 @@ - - Creates a new instance of the TButtonGlyph class + 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. +Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class. + - - Deallocates an object + 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: @@ -226,7 +225,8 @@ Take the following precautions when creating your own Destroy method: * An exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called, so your destructor must check if the resources were really allocated before disposing of them. -* Remember to call Free for all objects created on the constructor. +* Remember to call Free for all objects created on the constructor. + @@ -513,9 +513,7 @@ Take the following precautions when creating your own Destroy method: - - - Click - the procedure which allows programmatic simulation of a mouse click +

Click @@ -540,20 +538,19 @@ Take the following precautions when creating your own Destroy method: - - Initialise the window + - - Creates a new instance of the TCustomBitBtn class + 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. +Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class. + @@ -562,8 +559,7 @@ Constructors allocate memory and system resources needed by the object. They als - - Deallocates an object + 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: @@ -574,7 +570,8 @@ Take the following precautions when creating your own Destroy method: * An exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called, so your destructor must check if the resources were really allocated before disposing of them. -* Remember to call Free for all objects created on the constructor. +* Remember to call Free for all objects created on the constructor. + @@ -623,8 +620,7 @@ Take the following precautions when creating your own Destroy method: - - The action to be associated with this control +

// standard properties, which should be supported by all descendants

The (default) action to be associated with this control

@@ -632,8 +628,7 @@ Take the following precautions when creating your own Destroy method:
- - Used to align the control in one of four directions. +

// standard properties, which should be supported by all descendants

Either reads a flag containing alignment instructions (FAlign) or writes alignment instructions (SetAlign)

@@ -641,8 +636,7 @@ Take the following precautions when creating your own Destroy method:
- - The set of anchor definitions for this control +

// standard properties, which should be supported by all descendants

Determines how the control is to be anchored to its client or parent conrol

@@ -651,8 +645,7 @@ Take the following precautions when creating your own Destroy method:
- - Determines the border spacing for this control +

// standard properties, which should be supported by all descendants

Determines the border spacing for this control

@@ -663,16 +656,13 @@ Take the following precautions when creating your own Destroy method:
- - Is this the Cancel button? (default setting is False) +

Setting this property to true, will have the effect that when the user hits ESC this button is Clicked, even if the button does not have focus. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.

- - - Caption - the text-string appearing on the Control, usually used to identify its function +

Gets caption as a text-string (GetText), or stores the new caption (SetText). Shows flag if caption is stored (IsCaptionStored).

By default, the Caption appears the same as the control Name in the Object Inspector, @@ -685,23 +675,20 @@ introduced. These functions interface with the LCLInterface.

- - Determine Constraints (max and min height and width) for this control +

// standard properties, which should be supported by all descendants

Determine Constraints (max and min height and width) for this control; reads the size constraints or stores new ones.

- - Is this the Default button? (default setting is False) +

Defines if a button is the Default on a form. That is, pressing ENTER will execute its onClick method, whether the control has focus or not!

- - Whether the control is Enabled. If not, it usually appears 'greyed-out' +

// standard properties, which should be supported by all descendants

Whether the control is Enabled. If not, it usually appears 'greyed-out'

@@ -709,8 +696,7 @@ introduced. These functions interface with the LCLInterface.

- - The Font to be used for text in this control +

// standard properties, which should be supported by all descendants

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

@@ -720,38 +706,32 @@ introduced. These functions interface with the LCLInterface.

- - The BitMap Glyph to be displayed on the button + - - What kind of BitButton? Custom, OK, Cancel, Yes, No etc + - - Layout of button - Glyph at top, bottom, left or right + - - The margin to be left around glyphs + - - Is a Modal Result awaited? (default is false) + - - Event handler for a change in bounds of the control +

// standard properties, which should be supported by all descendants

Reads or Writes flag if bounds are changed

@@ -759,8 +739,7 @@ introduced. These functions interface with the LCLInterface.

- - Event Handler for mouse click +

// standard properties, which should be supported by all descendants

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 ActionList @@ -770,23 +749,17 @@ introduced. These functions interface with the LCLInterface.

- - - OnEnter - event handler for when the mouse enters the control, and the control receives focus + - - - OnExit - event handler for when the mouse leaves the control and it loses focus + - - - OnKeyDown - event handler for instance when key is down while control has focus +

OnKeyDown @@ -796,8 +769,7 @@ introduced. These functions interface with the LCLInterface.

- - OnKeyPress - event controller for a key being pressed while the control has focus +

OnKeyPress @@ -807,9 +779,7 @@ introduced. These functions interface with the LCLInterface.

- - - OnKeyUp - event handler for instance when a key is up (not pressed) while the control has focus +

OnKeyUp @@ -819,41 +789,35 @@ introduced. These functions interface with the LCLInterface.

- - Event handler for when a mouse button is pressed down + - - Event handler for mouse movement within the current control + - + - - Event Handler for resize of control + // standard properties, which should be supported by all descendants
Reads or Writes flag if control is re-sized.
- - - ParentShowHint - does the control adopt the same hinting behaviour as its parent? Default is true + - - PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control + // standard properties, which should be supported by all descendants
Reads the details of the pop-up menu, or stores them.
Properties are defined in the parent class TPopupMenu @@ -861,36 +825,30 @@ Properties are defined in the parent class TPop
- - Flag to determine: Is hint to be displayed for this control? + // standard properties, which should be supported by all descendants
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
- - The spacing around the BitButton + - - The place this control occupies in the list of tabs + Reads or writes information in flag; default is -1 - - Is the Button included in the TabStop list? (default setting is True) + - - - Visible - can the control be seen? +
The Visible property represents the ability to see a visual control. 
           If Visible is True the control is shown, otherwise it is hidden.
@@ -905,7 +863,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         Links a TSpeedButton with an action.
       
       
-      
+      
         
         
         
@@ -916,7 +874,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         
       
       
-      
+      
         
         
         
@@ -927,7 +885,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         
       
       
-      
+      
         
         
         
@@ -939,7 +897,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
       
       
       
-        
+        
+          SetGroupIndex - stores the value of the index within the list of links
         
         
         
@@ -950,7 +909,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
       
       
       
-        
+        
+          SetChecked - stores the Checked status (True or False)
         
         
         
@@ -1129,14 +1089,14 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         
       
       
-      
+      
         
         
         
         
       
       
-      
+      
         
         
         
@@ -1182,7 +1142,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         
       
       
-      
+      
         
         
         
@@ -1205,7 +1165,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         
       
       
-      
+      
         
         
         
@@ -1224,7 +1184,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         
       
       
-      
+      
         
         
         
@@ -1247,8 +1207,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         
       
       
-      
-        Paint the Glyph
+      
         
         
         
@@ -1320,8 +1279,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         
       
       
-      
-        Procedure to store text associated with the control in a string
+      
         This is the procedure that is actually used by SetTextBuf, and stores text as a string rather than performing read-write to a PChar buffer
 
         
@@ -1386,8 +1344,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
         
       
       
-      
-        Called when the component has finished loading.
+      
         
           

Loaded is called by the streaming system when a root @@ -1405,13 +1362,13 @@ is done automatically by the streaming system. - - Creates a new instance of the TCustomSpeedButton class + 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. +Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class. + @@ -1420,16 +1377,14 @@ Constructors allocate memory and system resources needed by the object. They als - + Destroy this instance of a graphic control and return its resources - - - 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 + @@ -1448,7 +1403,7 @@ Constructors allocate memory and system resources needed by the object. They als - + Whether the button is to be displayed Flat or in relief @@ -1505,8 +1460,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g - - The action to be associated with this control +

// standard properties, which should be supported by all descendants

The (default) action to be associated with this control

@@ -1514,8 +1468,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
- - Used to align the control in one of four directions. +

// standard properties, which should be supported by all descendants

Either reads a flag containing alignment instructions (FAlign) or writes alignment instructions (SetAlign)

@@ -1523,8 +1476,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
- - The set of anchor definitions for this control +

// standard properties, which should be supported by all descendants

Determines how the control is to be anchored to its client or parent conrol

@@ -1534,13 +1486,11 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
- - Boolean flag to determine whether all buttons are allowed to be Up (default false) + - - Determines the border spacing for this control +

// standard properties, which should be supported by all descendants

Determines the border spacing for this control

@@ -1551,8 +1501,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
- - Determine Constraints (max and min height and width) for this control +

// standard properties, which should be supported by all descendants

Determine Constraints (max and min height and width) for this control; reads the size constraints or stores new ones.

@@ -1560,9 +1509,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
- - - Caption - the text-string appearing on the Control, usually used to identify its function +

Gets caption as a text-string (GetText), or stores the new caption (SetText). Shows flag if caption is stored (IsCaptionStored).

By default, the Caption appears the same as the control Name in the Object Inspector, @@ -1575,13 +1522,11 @@ introduced. These functions interface with the LCLInterface.

- - The button has been set in the Down state + - - Whether the control is Enabled. If not, it usually appears 'greyed-out' +

// standard properties, which should be supported by all descendants

Whether the control is Enabled. If not, it usually appears 'greyed-out'

@@ -1589,53 +1534,43 @@ introduced. These functions interface with the LCLInterface.

- + - - The Bitmap glyph to be used on this button - + - - The Index within the group of speedbuttons + - - The button layout - Glyph at top, bottom, left or right + - - Margin - the space around glyphs + - - The number of Glyphs available + - - Spacing around button + - - Whether button is transparent + - - - Visible - can the control be seen? +
The Visible property represents the ability to see a visual control. 
           If Visible is True the control is shown, otherwise it is hidden.
@@ -1646,8 +1581,7 @@ introduced. These functions interface with the LCLInterface. 

- - Event Handler for mouse click +

// standard properties, which should be supported by all descendants

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 ActionList @@ -1657,16 +1591,14 @@ introduced. These functions interface with the LCLInterface.

- - Event Handle for mouse double-click +

Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate.

- - Event handler for when a mouse button is pressed down + @@ -1677,29 +1609,24 @@ introduced. These functions interface with the LCLInterface.

- - Event handler for when the mouse button is released, ie "up" + - - - OnPaint - event handler for request to paint canvas + - - Event Handler for resize of control + // standard properties, which should be supported by all descendants
Reads or Writes flag if control is re-sized.
- - Event handler for a change in bounds of the control +

// standard properties, which should be supported by all descendants

Reads or Writes flag if bounds are changed

@@ -1707,30 +1634,24 @@ Reads or Writes flag if control is re-sized.
- - Flag to determine: Is hint to be displayed for this control? + // standard properties, which should be supported by all descendants
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
- - - ParentFont - should the control use the same font as the parent? Default is true + - - - ParentShowHint - does the control adopt the same hinting behaviour as its parent? Default is true + - - PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control + // standard properties, which should be supported by all descendants
Reads the details of the pop-up menu, or stores them.
Properties are defined in the parent class TPopupMenu @@ -1757,18 +1678,10 @@ Properties are defined in the parent class TPop The height of the glyph image - - What to do if the text of the Bitbutton has ben changed - - - Find the default size for this class of controls (by reference to parents) - - - What Colour is the button? (default is the same as all other button faces) - - - The number of glyphs for display - + + + + Paint the background @@ -1784,16 +1697,14 @@ Properties are defined in the parent class TPop Should caption be displayed? - - Determine the colour for the current control +

// standard properties, which should be supported by all descendants

Reads the value for colour, or stores the value, and sets a flag if the colour is stored.

The default colour is the same as the window in which the control is located.

- - The Font to be used for text in this control +

// standard properties, which should be supported by all descendants

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

@@ -1801,15 +1712,17 @@ Properties are defined in the parent class TPop

- - Event handler for when the mouse enters the area of the current control - - - Event handler for when the mouse leaves the area of the current control - - - Should caption be displayed? - + + + + + + + + + + + diff --git a/docs/xml/lcl/calendar.xml b/docs/xml/lcl/calendar.xml index 4d48d3ab07..20d00376c1 100644 --- a/docs/xml/lcl/calendar.xml +++ b/docs/xml/lcl/calendar.xml @@ -283,10 +283,7 @@ - - - Create - constructor for a new instance of TCustomCalendar - + @@ -296,21 +293,21 @@ - + - + - + @@ -324,7 +321,7 @@ - the composite DateTime value returned by the control + The composite DateTime value returned by the control @@ -384,169 +381,169 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -558,6 +555,9 @@ + + + diff --git a/docs/xml/lcl/chart.xml b/docs/xml/lcl/chart.xml index 150507fadb..50f975b665 100644 --- a/docs/xml/lcl/chart.xml +++ b/docs/xml/lcl/chart.xml @@ -129,7 +129,7 @@ - + @@ -140,7 +140,7 @@ - + @@ -180,7 +180,8 @@ - + + GetBar - collect the data for one of the bars @@ -207,21 +208,23 @@ - + + BeginUpdate - start updating - + + EndUpdate - finish updating - + The Depth of the bars in the chart @@ -239,91 +242,91 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -335,145 +338,145 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -499,7 +502,7 @@ TBarChartItems - the collection of items defining the bars in this barchart - + Bars - the collection of bars that comprise the BarChart @@ -508,6 +511,11 @@ LabelPosition - left, centered or right + + + + UpdateBarChart - fill in any new information + diff --git a/docs/xml/lcl/checklst.xml b/docs/xml/lcl/checklst.xml index f2d67bb2b8..ac92dcb693 100644 --- a/docs/xml/lcl/checklst.xml +++ b/docs/xml/lcl/checklst.xml @@ -158,10 +158,7 @@ - - - Create a new instance of TCustomCheckListBox - + @@ -191,176 +188,175 @@ - + - + - + - + - + - + - + - + - - Allows multiple selected list items. + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -383,7 +379,7 @@ The State of the box with the specified index - checked, unchecked or greyed - + OnClickCheck - event handler for a mouse click on the CheckBox @@ -392,6 +388,52 @@ OnItemClick - event handler for a mouse click on the data item associated with the checkbox + + + + ReadData from a stream + + + + WriteData to a stream + + + + ClickCheck - software emulator of OnClickCheck event + + + + ItemClick - software emulation of OnItemClick event + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/xml/lcl/clipbrd.xml b/docs/xml/lcl/clipbrd.xml index eefc763277..710390ca6c 100644 --- a/docs/xml/lcl/clipbrd.xml +++ b/docs/xml/lcl/clipbrd.xml @@ -414,9 +414,7 @@ - - - AddFormat - add data to the supported formats. Returns True when operation has proceeded correctly + @@ -457,9 +455,7 @@ - - - Assign - add the data from the source to the clipboard with the specified Format ID + @@ -469,9 +465,7 @@ - - - AssignTo - add the data from the clipboard to the specified destination + @@ -517,9 +511,7 @@ AClipboardType - optional argument specifying type of clipboard to be created - - - Destroy - destructor: remove this instance of clipboard + @@ -751,7 +743,7 @@ - + diff --git a/docs/xml/lcl/colorbox.xml b/docs/xml/lcl/colorbox.xml index b79ddd9d64..a867c2632b 100644 --- a/docs/xml/lcl/colorbox.xml +++ b/docs/xml/lcl/colorbox.xml @@ -152,9 +152,9 @@ - - Write specifier for the setstyle property - Use SetStyle to prevent the style to be changed to anything else than csOwnerDrawFixed. + + Use SetStyle to prevent the style to be changed to anything else than csOwnerDrawFixed. + @@ -163,8 +163,7 @@ - - Method that draws a color item in the colorbox + Use DrawItem to customdraw an item in the ColorBox. A color preview is drawn and the item rectangle is made smaller and given to the inherited method to draw the corresponding text. The Brush color and Pen color where changed and reset to their original values. @@ -183,9 +182,9 @@ - - Constructor for colorbox - Use Create to create an instance of TColorBox and initialize all properties and variables. + + Use Create to create an instance of TColorBox and initialize all properties and variables. + @@ -220,102 +219,102 @@ - + - + - + - + - + - + - + - + - + Color - this is the colour for the display of the actual control, not the colour selected from the list - + - + - + - + - + - + - + - + @@ -327,13 +326,13 @@ - + - + @@ -345,37 +344,37 @@ - + - + - + - + - + - + @@ -385,169 +384,169 @@ The colour that has been Selected from the list - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -642,7 +641,7 @@ - + @@ -654,7 +653,8 @@ - + + SetColorList - stores the list of colours @@ -673,31 +673,31 @@ The colour that has been Selected from the list - + - + - + - + - + @@ -705,118 +705,118 @@ - Color - this is the colour for the display of the actual control, not the colour selected from the list + Color - Determine the colour for the display of the actual control, not the colour selected from the list - + - + - + - + - + - + - + - + - + - + + The Palette of colours from which selection is to be made + + + + + - + - + - + - + - + - + - - - - - - - + @@ -828,151 +828,151 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -984,6 +984,8 @@ + + diff --git a/docs/xml/lcl/customtimer.xml b/docs/xml/lcl/customtimer.xml index ff4e372823..bf3a2fb72c 100644 --- a/docs/xml/lcl/customtimer.xml +++ b/docs/xml/lcl/customtimer.xml @@ -139,9 +139,9 @@ KillTimer - kills the current timer object - + - + @@ -152,7 +152,7 @@ - +