From 6bb2f34cb4687910b4739a1175698d3168da1c0f Mon Sep 17 00:00:00 2001 From: marc Date: Sat, 22 Sep 2007 21:51:18 +0000 Subject: [PATCH] * Updated documentation by Chris Kirkpatrick git-svn-id: trunk@12140 - --- docs/xml/lcl/controls.xml | 217 ++++++++++++++++++++++++-------------- 1 file changed, 138 insertions(+), 79 deletions(-) diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index f12e1c5749..8f58639daa 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -1,4 +1,4 @@ -fpdoc --package=lcl --show-private --output=/home/kirkpatc/FreePascal/doc.tmp/ --format=html --content --descr=/home/kirkpatc/FreePascal/lazarus/docs/xml/lcl/controls.xml --input=/home/kirkpatc/FreePascal/lazarus/lcl/controls.pp + The main ancestor class for visual controls. - TControl is the main ancestor class for all visual controls.
-
- The definition includes a large number of constants, types and methods that are inherited by derived classes and types.
-
- These include devices for defining and controlling
the state and position of the object
(including alignment and anchoring),
+ TControl is the main ancestor class for all visual controls.

+ + The definition includes a large number of constants, types and methods that are inherited by derived classes and types.

+ + These include devices for defining and controlling
+the state and position of the object
+(including alignment and anchoring),
+ the state of the mouse,
+ whether dragging or docked,
-the size and type of border,
the way child components should behave,
the way actions should occur in response to various events,
+ +the size and type of border,
+the way child components should behave,
+the way actions should occur in response to various events,
+ and the way the Control should be drawn.
 - + @@ -5360,22 +5368,32 @@ Reads logical (boolean) flag to see whether auto-sizing is to be operated, or wr - + + The object to be dragged and dropped + - + + The X co-ordinate to which the object is to be dropped (target) + - + + The Y co-ordinate to which the object is to be dropped (target) + Dock - Procedure governing Docking of Control - - - + Performs checks that there is already a valid host control
to which the present control is to be docked,
removes old controls from the list of docked controls
and adds the new control to the list,
then calls DoDock to perform the actual docking process + An exception is raised if there is already a docking process in progress for this control + - + + The host control to which which the current control is to be docked + - + + The position at which the control is to be docked + ManualDock - permits operator-defined docking @@ -5385,23 +5403,31 @@ Reads logical (boolean) flag to see whether auto-sizing is to be operated, or wr ControlSide: TAlign): Boolean; Docks this control to DropControl or on NewDockSite. - If DropControl is not nil, ControlSide defines on which side of DropControl + If DropControl is not nil, ControlSide defines on which side of DropControl this control is docked. (alNone,alClient for stacked in pages). DropControl will become part of a TDockManager. - If DropControl is nil, then DropControl becomes a normal child of NewDockSite + If DropControl is nil, then DropControl becomes a normal child of NewDockSite and ControlSide is ignored. ------------------------------------------------------------------------------} - + + The function returns True if a manual dock has been successfully performed + - + + The new site to which the control is docked, if DropControl has been found to be nil + - + + If nil (default) then ignored else used as the control for docking, on side specified by ControlSide + - + + The side on which the control is to be docked, if DropControl is not nil + ManualFloat - the opposite of ManualDock, allows operator to Float a control @@ -5418,35 +5444,48 @@ Reads logical (boolean) flag to see whether auto-sizing is to be operated, or wr - + + The function returns True if a manual float has been succesfully performed + - + + The rectangle within which the floating control is located + The rectangle within which the floating control is located
(ie the location of the floating dock site to which the control is docked) + - - - - + 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 + - + + Returns True if a docked control has been successfully replaced with a new one + - + + The old control that was previously docked at this site + - + + The new site for docking; used if DropControl is nil + - + + The control site to be used for docking, unless it is nil when it is igored. Passed straight through as an argument to ManualDock + - + + The side to which the new control is to be aligned; passed straight through as an argument to ManualDock + - - - - + Returns True if the control is being dragged - + + Returns True if the control is being dragged + @@ -5466,13 +5505,12 @@ Reads logical (boolean) flag to see whether auto-sizing is to be operated, or wr - - - - + Auto-sizing has been delayed until some other process is complete - + + Returns True if auto-sizing has been delayed + AnchorToNeighbour - anchoring instructions @@ -5487,11 +5525,17 @@ Reads logical (boolean) flag to see whether auto-sizing is to be operated, or wr - + + The side on which we should anchor + - + + The size of the space to be left around the control when anchoring + - + + The sibling control to which we should anchor + AnchorParallel - instructions for anchoring beside another control @@ -5500,60 +5544,76 @@ Reads logical (boolean) flag to see whether auto-sizing is to be operated, or wr - + + The side on which we should anchor to the sibling + - + + The size of the space to be left around the control when anchoring + - + + The sibling control to which we should anchor in a parallel manner + AnchorHorizontal - instructions for anchoring - Sibling - another control to which the current control is to be anchored, centred horizontally - - - - + Another control to which the current control is to be anchored, centred horizontally AnchorVertical - instructions for anchoring - Sibling - another control to which the current control is to be anchored, centred vertically - + + Another control to which the current control is to be anchored, centred vertically + - - - - + Sets the boundaries defining the position of the current control + Height, Width, and position of Top Left pixel - + + The X co-ordinate of the top left pixel of the control + - + + The Y co-ordinate of the top left pixel of the control + - + + The width of the control + - + + The height of the control + - - - - + Sets the bounds of the control initially, when it is created + Checks that this is a new control,
then calls SetBounds to set up coordinates defining its position + - + + X co-ordinate of top left pixel + - + + Y co-ordinate of top left pixel + - + + Width of control + - + + Height of control + @@ -6082,11 +6142,9 @@ Bounding rectangle (top-left, bottom-right) is defined in TRect Caption - the text-string appearing on the Control, usually used to identify its function - By default, the Caption appears the same as the control Name in the Object Inspector,
and the developer needs to set it explicitly to some new text.

+ By default, the Caption appears the same as the control Name in the Object Inspector,
and the developer needs to set it explicitly to some new text.

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

-
- * The VCL implementation relies on the virtual Get/SetTextBuf to 
+Gets caption as a text-string (GetText), or stores the new caption (SetText). Shows flag if caption is stored (IsCaptionStored).

* The VCL implementation relies on the virtual Get/SetTextBuf to 
  * exchange text between widgets and VCL. This means a lot of 
  * (unnecesary) text copies.
  * The LCL uses strings for exchanging text (more efficient).
@@ -6199,7 +6257,8 @@ Reads or Writes flag if bounds are changed
       
       
         Event Handler for mouse click
-        // standard properties, which should be supported by all descendants
Reads or writes a flag if  amouse click is detected, and sets a flag if a value is stored.
+        // standard properties, which should be supported by all descendants

+Reads or writes a flag if  a mouse click is detected, and sets a flag if a value is stored.
         
       
       
@@ -6240,7 +6299,8 @@ Reads or writes a flag to find or store the identity of the parent for this cont
       
         The Visible property represents the ability to see a visual control.
         
-          
The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden.
+          
The Visible property represents the ability to see a visual control. 
+          If Visible is True the control is shown, otherwise it is hidden.
           Setting Visible to True is equivalent to calling Show method.
           Setting Visible to False is equivalent to calling Hide method.

           The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.
@@ -10388,7 +10448,6 @@ TGraphicControl, you must query the ClientRect.

         
         
       
-