From 6aff8c0e2239bd346477c49b4877b8f3b6d0250d Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Fri, 5 Oct 2007 13:34:21 +0000 Subject: [PATCH] Changes added by Chris Kirkpatrick git-svn-id: trunk@12333 - --- docs/xml/lcl/controls.xml | 232 +++++++++++++++----------------------- 1 file changed, 89 insertions(+), 143 deletions(-) diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index 02cdb7fc4d..ddeb9cba0d 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -466,9 +466,7 @@ mrLast=mrYesToAll=10 - - - + Type defining the three mouse buttons (left, middle, right) @@ -820,10 +818,12 @@ mrLast=mrYesToAll=10 - - - - + The base class for the canvas property of several graphic controls, such as TGraphicControl and TCustomControl + + + + + @@ -868,17 +868,11 @@ mrLast=mrYesToAll=10 - - - - + Create this instance of Control Canvas - - - - + Destroy this Control Canvas and free its resources @@ -889,9 +883,8 @@ mrLast=mrYesToAll=10 - - - + The Control object for which this is the Canvas + Reads or writes a flag to determine the identity of the Control object @@ -1188,10 +1181,7 @@ mrLast=mrYesToAll=10 - - - - + The base class for many objects that are designed to be dragged and dropped @@ -1236,11 +1226,7 @@ mrLast=mrYesToAll=10 - - - - - + @@ -1365,87 +1351,72 @@ mrLast=mrYesToAll=10 - - - - + Destroy this instance of TDragObject - - - - + Assigns a particular source to this drag object + Finds out a lot of information about the source object, such as its operating-system handle, size, position, how much the mouse is allowed to move before the object is moved, and whether the object is to be kept visible during the drag process. - + + The object, with all its properties, that is to be dragged + - - - - + Find name of the object for dragging - + + The object's name returned as a string + - - - - + Procedure for hiding the drag image during movement + - - - - + // exist only for compatibility - + + zero + - - - - + Procedure for keeping the image visible during movement + - - - + Is this drag object being cancelled? + Reads or sets flag to determine whether this drag image is being cancelled. Property has a boolean value, true if cancelling - - - + Finds Operating-System handle for this object + Reads or writes flag for operating-system handle - - - + Find position for this object + Reads or writes flag with position (as X, Y co-ordinates) - - - + The position of the taget control object to which the currect object is to be dragged + Reads or writes flag with position (X, Y co-ordinates) of control object to which the current object is to be dragged - - - + The control object to which the current object is to be dragged (target) + Reads or writes flag with identity of the target control object to which the currect object is to be dragged - - - + Has the drag object been dropped yet? + Boolean property, true if the object has been dropped; reads or writes a flag with this information @@ -1467,10 +1438,8 @@ mrLast=mrYesToAll=10 - - - - + An ancestor class for many drag control objects + @@ -1508,27 +1477,27 @@ mrLast=mrYesToAll=10 - - - - + Creates an instance of this object - + + The control object that is to be dragged + Reads or writes flag with identity of object for dragging + - - - - + Assigns source object + Overrides definition in parent class + - + + The object that is to be dragged + - - - + The identity of the control to be dragged + Reads or writes flag with identity of control object @@ -1835,10 +1804,8 @@ mrLast=mrYesToAll=10 - - - - + A base class for managing the docking process + The declaration contains a number of procedure definitions that are 'virtual' and 'abstract'.
This means that there is no implementation specified:
these essentially represent 'place-holders', and it is the responsibility of the developer of descendant classes
to override these methods and implement them as desired. @@ -9354,10 +9321,8 @@ TGraphicControl, you must query the ClientRect.

- - - - + TDockZone is a node in the TDockTree and encapsulates a region into which other zones or a single control are contained. + This is an ancestor class for TDockTree, in the sense that it forms the elementary component of which the tree is constructed @@ -9523,13 +9488,13 @@ TGraphicControl, you must query the ClientRect.

- - - - + Create this instance of Dock Zone + Specifies the tree to which this zone belongs, and and child zones which it contains - + + The dock tree to which this zone belongs + @@ -9689,7 +9654,7 @@ TGraphicControl, you must query the ClientRect.

 - TDockTree + A tree of dock zones - every docked window has one tree { TDockTree - a tree of TDockZones - Every docked window has one tree @@ -9774,11 +9739,10 @@ TGraphicControl, you must query the ClientRect.

ResetBounds - TODO for Delphi compatibility SetReplacingControl - TODO for Delphi compatibility PaintSite - TODO for Delphi compatibility - +} - - + @@ -9856,10 +9820,7 @@ TGraphicControl, you must query the ClientRect.

- - - - + Update the entries in the tree (increment the update count) @@ -9993,19 +9954,15 @@ TGraphicControl, you must query the ClientRect.

 - - - - + Create a new instance of a docking tree - + + The window control that is to be the site for docking + - - - - + Remove this instance of dock tree, and free its resources @@ -10024,10 +9981,8 @@ TGraphicControl, you must query the ClientRect.

 - - - - + Some properties of the current Mouse + Contains information about current mouse position, whether it has captured an object, whether it is dragging the object, and how far the mouse is allowed to move before the captured object is made to move. @@ -10085,41 +10040,32 @@ TGraphicControl, you must query the ClientRect.

- - - - + Create an instance of the Mouse object - - - - + Destroy this instance of the mouse object + Can be a locally defined method to override the method specified by the parent object - - - + System handle for the captured object + Reads or writes a system variable identifying the captured object - - - + The screen position of the cursor + Reads or writes a variable to determine the position of the cursor (a point with X, Y co-ordinates) - - - + Does the object get dragged as soon as the mouse moves? + Reads or writes a flag to determine whether to move the object immediately the mouse moves: default is true - - - + The least distance the mouse must move before the captured object is moved + Reads or writes a flag to deterine the threshold movement (if DragImmediate was false). Default is 5 pixels