diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 7a47159613..6393885e51 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -7401,7 +7401,7 @@ - + @@ -8256,7 +8256,7 @@ Determines the style of the tool button. See TToolButtonStyle for the possible Style values. - + @@ -8362,7 +8362,7 @@

Typically, the tool buttons correspond to items in an application's menu and gives the user more direct access to the application's commands.

- + HowToUseStdCtrls @@ -9011,7 +9011,7 @@

To add tool buttons to the toolbar at design time, select the toolbar, right-click, and choose New Button. To create a space (separator) between one button and the next, select New Separator. To create a divider between buttons, add a button and set its Style propery to tbsDivider. Other controls may be added to the toolbar directly from the Component palette.

- + @@ -15715,7 +15715,7 @@ the comparision is case sensitive. to display a hierarchical list of items. Items are shown by their caption and an optional bitmap. - + @@ -16281,12 +16281,12 @@ the comparision is case sensitive. - Function to compare the node text two nodes. + Function to compare the node text of two nodes.

This function does an ANSICompare on the NodeText of two nodes. The parameters Data1 and Data2 are pointers to the nodes to be compared. The result is the same is the result from ANSICompareText.

-1: The nodetext from the first node is lower then the nodetext from the second.

0: The nodetext-s from both nodes are equal.

- 1: The nodetext from the first node is higher then the nodetext from the second. +

1: The nodetext from the first node is higher then the nodetext from the second.

 @@ -16308,7 +16308,7 @@ the comparision is case sensitive.

This function does an ANSICompare on the NodeText of two nodes. The parameters Data1 and Data2 are pointers to the nodes to be compared. The result is the same is the result from ANSICompareText.

-1: The given text is lower then the nodetext from the given node.

0: The given text is equal to the nodetext from the given node.

- 1: The given text is higher then the nodetext from the given node. +

1: The given text is higher then the nodetext from the given node.

diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index d2a3efec95..ed9157f280 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -348,7 +348,7 @@ mrLast=mrYesToAll=10 Enumerated type listing the possible positions for alignment of a control - +

Enumerated type listing the possible positions for alignment of a control

akTop, 
   akLeft, 
   akRight, 
@@ -962,8 +962,8 @@ mrLast=mrYesToAll=10
       
         The base class for the canvas property of several graphic controls, such as TGraphicControl and TCustomControl
         
-          
-          
+          
+          
           TCanvas
         
       
@@ -1681,7 +1681,7 @@ mrLast=mrYesToAll=10
       
         Procedure for hiding the drag image during movement
         
-          ShowDragImage
+          ShowDragImage
         
       
       
@@ -1696,7 +1696,7 @@ mrLast=mrYesToAll=10
       
         Procedure for keeping the image visible during movement
         
-          HideDragImage
+          HideDragImage
         
       
       
@@ -1753,7 +1753,7 @@ mrLast=mrYesToAll=10
       
         An ancestor class for many drag control objects
         
-          
+          
         
       
       
@@ -1818,7 +1818,7 @@ mrLast=mrYesToAll=10
         Assigns source object
         Overrides definition in parent class
         
-          
+          
         
       
       
@@ -3423,7 +3423,7 @@ mrLast=mrYesToAll=10
       
       
         
-          
SetHelpContext
 - specifies the context-based help variable to use
+          SetHelpContext - specifies the context-based help variable to use
         
         
         
@@ -4200,8 +4200,8 @@ mrLast=mrYesToAll=10
         Function to get text-string associated with control
         Uses RealGetText rather than GetTextBuf to avoid unnecessary read-writes to PChar buffers
         
-          GetTextBuf
-          
+          GetTextBuf
+          
         
       
       
@@ -4667,8 +4667,8 @@ mrLast=mrYesToAll=10
         Stores text in buffer
         Uses RealSetText rather than SetTextBuf to avoid unnecessary read-writes to PChar buffer
         
-          RealSetText
-          SetTextBuf
+          RealSetText
+          SetTextBuf
         
       
       
@@ -4709,7 +4709,7 @@ mrLast=mrYesToAll=10
       
         Flag showing the set of states for this control
         
-          
+          
         
       
       
@@ -5647,40 +5647,40 @@ 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 
-           event
+           event
       
       
       
         
           DblClick   - a procedure that allows the programmer to simulate a mouse double-click over the control, and initiates the same 
           Action  as that associated with the 
-            event
+	    event
       
       
       
         
           TripleClick   - a procedure that allows the programmer to simulate a mouse triple-click over the control, and initiates the same 
           Action  as that associated with the 
-           event
+	   event
       
       
       
         
           QuadClick   - a procedure that allows the programmer to simulate a mouse quadruple-click over the control, and initiates the same 
           Action  as that associated with the 
-            event
+	    event
       
       
       
         
           MouseDown   - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same 
           Action  as that associated with the 
-            event
+	    event
         
           

             MouseDown   - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same 
             Action  as that associated with the 
-              event

+	      event

           

             Button specifies which mouse button; 
             Shift signifies whether Ctrl, Shift or Alt keys are also pressed; 
@@ -5710,12 +5710,12 @@ mrLast=mrYesToAll=10
         
           MouseMove   - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same 
           Action  as that associated with the 
-            event
+	    event
         
           

             MouseMove   - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same 
             Action  as that associated with the 
-              event

+	      event

           

             Shift signifies whether Ctrl, Shift or Alt keys are also pressed; 
             X, Y show mouse position

@@ -5740,12 +5740,12 @@ mrLast=mrYesToAll=10
         
           MouseUp   - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same 
           Action  as that associated with the 
-            event
+	    event
         
           

             MouseUp   - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same 
             Action  as that associated with the 
-              event

+	      event

           

             Button specifies which mouse button; 
             Shift signifies whether Ctrl, Shift or Alt keys are also pressed; 
@@ -5775,7 +5775,7 @@ mrLast=mrYesToAll=10
         
           MouseEnter - a procedure that allows the programmer to simulate a mouse entering the control, and initiates the same 
           Action as that associated with the 
-           event
+	   event
         
         
         
@@ -5785,7 +5785,7 @@ mrLast=mrYesToAll=10
         
           MouseLeave - a procedure that allows the programmer to simulate a mouse leaving the control, and initiates the same 
           Action as that associated with the 
-           event
+	   event
         
         
         
@@ -5930,9 +5930,9 @@ mrLast=mrYesToAll=10
         This is the function that is actually used by GetTextBuf, and loads a string rather than performing read-write to a PChar buffer
 
         
-          GetTextBuf
-          RealSetText
-          SetTextBuf
+		GetTextBuf
+		RealSetText
+		SetTextBuf
         
       
       
@@ -5945,9 +5945,9 @@ mrLast=mrYesToAll=10
         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
 
         
-          SetTextBuf
-          RealGetText
-          GetTextBuf
+		SetTextBuf
+		RealGetText
+		GetTextBuf
         
       
       
@@ -6500,7 +6500,7 @@ mrLast=mrYesToAll=10
         Remove a previously docked control and put a new control in its place
         Checks to see whether there is a previously docked control, 
and removes it, then puts the new control in its place
         
-          ManualDock
+		ManualDock
         
       
       
@@ -6654,7 +6654,7 @@ mrLast=mrYesToAll=10
         Checks that this is a new control, then calls SetBounds to set up coordinates defining its position
 
         
-          SetBounds
+		SetBounds
         
       
       
@@ -6890,8 +6890,8 @@ mrLast=mrYesToAll=10
         
           Hide this control
         
-          
-          
+		
+		
         
       
       
@@ -6975,8 +6975,8 @@ mrLast=mrYesToAll=10
- RealGetText - GetText + RealGetText + GetText @@ -7021,8 +7021,8 @@ mrLast=mrYesToAll=10 - RealSetText - SetText + RealSetText + SetText @@ -7107,8 +7107,8 @@ mrLast=mrYesToAll=10 - - + + @@ -7258,7 +7258,7 @@ mrLast=mrYesToAll=10

May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right

- + @@ -7271,7 +7271,7 @@ mrLast=mrYesToAll=10

- + @@ -7284,7 +7284,7 @@ mrLast=mrYesToAll=10

- + @@ -7406,7 +7406,7 @@ introduced. These functions interface with the LCLInterface.

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

- + @@ -7434,7 +7434,7 @@ introduced. These functions interface with the LCLInterface.

- whether mouse has been clicked, data being read, control being re-drawn, etc. Reads or stores the state of the control.

- + @@ -7449,7 +7449,7 @@ introduced. These functions interface with the LCLInterface.

- whether the control responds to mouse clicks, can be re-sized, has particular actions, etc. Reads the stored style, or saves the new style

- + @@ -7522,8 +7522,8 @@ Reads a logical (boolean) flag or sets it to determine whether this object is a Event Handler when a hint needs to be shown // standard properties, which should be supported by all descendants
Reads or Writes a flag when a hint (a small pop-up box, appearing when the mouse hovers over an object) is to be shown - - + + @@ -7532,7 +7532,7 @@ Reads a logical (boolean) flag or sets it to determine whether this object is a // standard properties, which should be supported by all descendants
Reads or writes a flag to find or store the identity of the parent for this control. The parent is of type TWincontrol - + @@ -7552,7 +7552,7 @@ 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 - OnShowHint + OnShowHint @@ -7568,9 +7568,9 @@ Properties are defined in the parent class TPop The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility. - - - + + + @@ -7578,7 +7578,7 @@ Properties are defined in the parent class TPop Reads or writes a message associated with this window // standard properties, which should be supported by all descendants
Reads message from flag area, or stores a message - + @@ -8253,7 +8253,7 @@ Properties are defined in the parent class TPop

Defines procedures and functions related to windowed controls, some of which override virtual methods defined in ancestor classes.

- + @@ -10100,7 +10100,7 @@ Properties are defined in the parent class TPop CreateParams - create parameters for this windowed class - +

CreateParams - create parameters for this windowed class

Definition of parameters:

TCreateParams = record
     Caption: PChar;
@@ -10177,7 +10177,7 @@ End;
         
           InitializeWnd - initialise the window for this control
         
-          
+		
InitializeWnd - initialise the window for this control

           
Gets called after the Handle is created and before the child handles are created

         
         
@@ -10401,7 +10401,7 @@ End;
         Definitions of how any child control is to be sized
         Reads values from flag or stores values to flag. Most of the properties are inherited from TControlChildSizing, 
which you should read to find out more about this control
         
-          
+		
         
       
       
@@ -10447,7 +10447,7 @@ End;
         Property that actually controls the docking process
         Reads or writes a flag. Derived from the parent class TDockManager
         
-          
+		
         
       
       
@@ -11246,7 +11246,7 @@ need the ability to accept keyboard input or contain other controls. 

             Paint method called in response to paint requests received by the parent control.

         
         
-          
+		
           
         
       
@@ -11336,8 +11336,8 @@ getting the parent control's Canvas dimensions.

         Contains simple basic definitions to create, destroy and paint window controls and set basic properties like canvas and border
 
         
-          
-          
+		
+		
         
       
       
@@ -11369,7 +11369,7 @@ getting the parent control's Canvas dimensions.

         Paint handler plug-in
         This is a plug-in in TWinControl to get the DC, 
assign it to our canvas and call the paint method for 
descendants to do the actual painting
         
-          
+		
         
       
       
@@ -11425,7 +11425,7 @@ getting the parent control's Canvas dimensions.

         Only a restricted series of options is available: none or a single border.
 
         
-          
+		
         
       
       
@@ -11978,7 +11978,7 @@ getting the parent control's Canvas dimensions.
- + @@ -12637,7 +12637,7 @@ getting the parent control's Canvas dimensions.

Calls CursorToIdent to find correct entry in look-up table - + @@ -12653,7 +12653,7 @@ getting the parent control's Canvas dimensions.

StringToCursor - returns the cursor value corresponding to the name supplied - +

StringToCursor - returns the cursor value corresponding to the name supplied

Finds the numeric cursor value corresponding to the name S in the cursor look-up table

 @@ -13476,7 +13476,7 @@ getting the parent control's Canvas dimensions.

The threshold amount by which the mouse must move before the dragging process starts. - The threshold amount by which the mouse must move before the dragging process starts. Default is 5 pixels - irrelevant if is true + The threshold amount by which the mouse must move before the dragging process starts. Default is 5 pixels - irrelevant if is true diff --git a/docs/xml/lcl/customtimer.xml b/docs/xml/lcl/customtimer.xml index bf3a2fb72c..50aa8660fd 100644 --- a/docs/xml/lcl/customtimer.xml +++ b/docs/xml/lcl/customtimer.xml @@ -141,22 +141,29 @@ - - + + + Create - constructor for TCustomTimer: calls inherited Create, sets up handle and initialises timer interval - + + + - - + + + Destroy: destructor for TCustomTimer: disables and kills timer then calls inherited Destroy + - + + + diff --git a/docs/xml/lcl/extctrls.xml b/docs/xml/lcl/extctrls.xml index 642585ce66..23bc6ae071 100644 --- a/docs/xml/lcl/extctrls.xml +++ b/docs/xml/lcl/extctrls.xml @@ -106,13 +106,12 @@

TPageFlag - enumerated type containing possible values for page flags for notebook pages

- 
-
-    pfAdded,  // handle of page added to notebook handle
+          
pfAdded,  // handle of page added to notebook handle
     pfAdding, // currently handle of page adding to notebook handle
     pfRemoving, // currently removing page handle from notebook handle
     pfInserting // currently inserting page into notebook
-
+

+        
         
       
       
@@ -316,11 +315,14 @@
         
       
       
-      
-        
+      
+        
+          Create - constructor for TCustomPage: calls inherited Create then initialises style, visibility, alignment and caption
         
         
-        
+        
+          
+        
       
       
       
@@ -505,10 +507,14 @@
         
       
       
-      
+      
         
         
-        
+        
+          
+        
+        
+          Create - constructor for TNBPages: calls inherited Create then sets up the list of pages on the notebook
       
       
       
@@ -1132,22 +1138,29 @@
           Page that is currently selected and is available for interaction
       
       
-      
-        
+      
+        
+          Create - constructor for TCustomNotebook: calls inherited Create creates a pagelist, then sets initial bounds and default values for local variables and properties
         
         
-        
+        
+          
+        
       
       
       
         
       
       
-      
-        
+      
+        
+          Destroy - destructor for TCustomNotebook: clears and frees pages and list, then calls inherited Destroy
+        
         
         
-        
+        
+          
+        
       
       
       
@@ -1576,7 +1589,7 @@
         
       
       
-      
+      
         
         
         
@@ -1908,22 +1921,29 @@
         
       
       
-      
-        
+      
+        
+          Create: constructor for TIdleTimer: calls inherited Create then sets up operating mode (autostart and autoend)
         
         
-        
+        
+          
+        
       
       
       
         
       
       
-      
-        
+      
+        
+          Destroy - destructor for TIdleTimer: turns off AutoEnabled then calls inherited Destroy
+        
         
         
-        
+        
+          
+        
       
       
       
@@ -2062,22 +2082,29 @@
         
       
       
-      
-        
+      
+        
+          Create - constructor for TShape: calls inherited Create, sets default styles and bounds, creates pen and brush
         
         
-        
+        
+          
+        
       
       
       
         
       
       
-      
-        
+      
+        
+          Destroy - destructor for TShape: frees pen and brush, then calls inherited Destroy
+        
         
         
-        
+        
+          
+        
       
       
       
@@ -2626,11 +2653,14 @@
         
       
       
-      
-        
+      
+        
+          Create - constructor for TCustomSplitter: calls inherited Create then sets initial alignment, size and style
         
         
-        
+        
+          
+        
       
       
       
@@ -2868,11 +2898,14 @@
         
       
       
-      
-        
+      
+        
+          Create - constructor for TPaintBox: calls inherited Create then sets initial bounds and style
         
         
-        
+        
+          
+        
       
       
       
@@ -3179,22 +3212,29 @@
         
       
       
-      
-        
+      
+        
+          Create - constructor for TCustomImage: calls inherited Create then sets default style, bounds and local variables: creates space for the picture
         
         
-        
+        
+          
+        
       
       
       
         
       
       
-      
-        
+      
+        
+          Destroy - destructor for TCustomImage: frees picture then calls inherited Destroy
+        
         
         
-        
+        
+          
+        
       
       
       
@@ -3290,7 +3330,7 @@
 : a graphic image placed on the form; usually loaded from a picture file.

           
The actual image is found in Picture or Canvas
           

-          
Inherits most of its properties from its ancestors, TCustomImage, TGraphicControl and TControl
+          
Inherits most of its properties from its ancestors, TCustomImage, TGraphicControl and TControl
           

         
         
@@ -3486,7 +3526,7 @@
 
 
  - a bevel placed around the edge of buttons and other components.

-          
Its appearance is governed by TBevelShape, TBevelStyle and TBevelwidth
+          
Its appearance is governed by TBevelShape, TBevelStyle and TBevelwidth
           

         
       
@@ -3554,17 +3594,21 @@
         
       
       
-      
+      
         
         
-        
+        
+          
+        
+        
+          Create - cunstructor for TBevel: calls inherited Create then sets initial style, shape and bounds
       
       
       
         
       
       
-      
+      
         
         
         
@@ -3942,22 +3986,29 @@ requiring the user to select one af a set of alternatives

         
       
       
-      
-        
+      
+        
+          Create - constructor for TCustomRadioGroup: calls inherited Create, then sets list of buttons, and initialises layout and sizing properties
         
         
-        
+        
+          
+        
       
       
       
         
       
       
-      
-        
+      
+        
+          Destroy - destructor for TCustomRadioGroup: frees items and buttons, then calls inherited Destroy
+        
         
         
-        
+        
+          
+        
       
       
       
@@ -4053,13 +4104,13 @@ requiring the user to select one af a set of alternatives

         
       
       
-      
+      
         
         
         
       
       
-      
+      
         
         
         
@@ -4083,13 +4134,13 @@ requiring the user to select one af a set of alternatives

         
       
       
-      
+      
         
         
         
       
       
-      
+      
         
           Items - a string list containing the captions of the radio boxes
         
@@ -4470,22 +4521,29 @@ requiring the user to select one af a set of alternatives

         
       
       
-      
-        
+      
+        
+          Create - constructor for TCustomCheckGroup: calls inherited Create, then sets styles, creates lists, initialises sizing and layout properties
         
         
-        
+        
+          
+        
       
       
       
         
       
       
-      
-        
+      
+        
+          Destroy - destructor for TCustomCheckGroup: frees items and buttons, then calls inherited Destroy
+        
         
         
-        
+        
+          
+        
       
       
       
@@ -5010,7 +5068,7 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
 : The base type for 
             
             LabeledEdit.

-          
Note particularly the EditLabel property (see TBoundLabel), which contains the label attached to the Edit control.

+          
Note particularly the EditLabel property (see TBoundLabel), which contains the label attached to the Edit control.

         
         
           TCustomEdit
@@ -5156,11 +5214,14 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
         
       
       
-      
-        
+      
+        
+          Create - constructor for TCustomLabeledEdit: calls inherited Create then sets initial position and label spacing
         
         
-        
+        
+          
+        
       
       
       
@@ -5696,11 +5757,14 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
         
       
       
-      
-        
+      
+        
+          Create - constructor for TCustomPanel: calls inherited Create then sets initial style, bevel, colour, alignment and bounds
         
         
-        
+        
+          
+        
       
       
       
@@ -6111,17 +6175,28 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
         
           TTrayIcon is a multiplatform System Tray component. It adds an icon to the tray and signifies an application that is inactive but ready to be activated. Under Windows the System tray is usually located on the bottom-right corner of the screen, but it may be elsewhere. On other operating systems this position varies.
       
-      
+      
         
           Create creates a new instance of a TCustomTrayIcon class.
           If AOwner is not Nil, the new component attempts to insert itself in the list of owned components of the owner.
-        
+
+        
+          Create - constructor for TCustomTrayIcon: performs inherited Create then creates icon, timer and initialises balloon timeout
+        
+          
+        
       
-      
+      
         
-          Destroy sends a opRemove notification to all components in the free-notification list. After that, all owned components are destroyed by calling DestroyComponents (and hence removed from the list of owned components). When this is done, the component removes itself from its owner's child component list.
+          Destroy sends a opRemove notification to all components in the free-notification list. After that, all owned components are destroyed by calling DestroyComponents (and hence removed from the list of owned components). When this is done, the component removes itself from its owner's child component list.
 After that, the parent's destroy method is called.
-        
+
+        
+          Destroy - destructor for TCustomTrayIcon: frees icon and timer then calls inherited Destroy
+        
+        
+          
+        
       
       
         Hide - Removes the icon from the System Tray
@@ -6210,7 +6285,7 @@ After that, the parent's destroy method is called.
 compatible.
 

           
The TPersistent implementation of Assign does nothing
-but calling the AssignTo method of
+but calling the AssignTo method of
 source. This means that if the destination class does not know how to assign
 the contents of the source class, the source class instance is asked to assign
 itself to the destination class. This means that it is necessary to
@@ -7041,7 +7116,6 @@ will copy the contents of the Source class to the
         
         
       
-