From 8b83117d8996a9cf5f603a342ff40e7ff282b32a Mon Sep 17 00:00:00 2001 From: dodi Date: Mon, 28 Dec 2009 08:21:01 +0000 Subject: [PATCH] docs: some LCL doc updates git-svn-id: trunk@23306 - --- docs/xml/lcl/controls.xml | 84 +++++++++++++++++++++++++++++++-------- docs/xml/lcl/lclintf.xml | 2 +- 2 files changed, 68 insertions(+), 18 deletions(-) diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index 1ac6809dc7..a67a5102d7 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -1736,13 +1736,13 @@ mrLast=mrYesToAll=10 - Find position for this object + Mouse position in screen coordinates 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 + Mouse position in client coordinates of the DragTarget (site) + Reads or writes the mouse position (X, Y client coordinates) of control object to which the current object is to be dragged @@ -2366,7 +2366,7 @@ mrLast=mrYesToAll=10 - RemoveControl - delete the specified control + RemoveControl - remove undocked control from layout. @@ -5462,7 +5462,13 @@ mrLast=mrYesToAll=10 - Calculate the sizes required for docking + Calculate the sizes related to docking + In floating state sets UndockWidth/Height to the current Width/Height. + +In docked state sets LRDockWidth/TBDockHeight to the current Width/Height. +Note: should save both in any case, independent from DockOrientation or host Align. +Rationale: a DockManager will either ignore these values, or use them according to the *new* alignment. +Without a DockManager both extents are required, because no (valid) alignment information applies. @@ -5563,7 +5569,7 @@ mrLast=mrYesToAll=10 - DoDragMsg - sends a drag message at specified position for nominated object and target; returns an integer Result for success + DoDragMsg - sends to AControl a drag message at specified position for nominated object and target; returns an integer Result for success @@ -9676,9 +9682,10 @@ Reads message from flag area, or stores a message - - DockOver - software emulation of the OnDockOver event - + Position DockRect, invoke OnDockOver (via DoDockOver) + Called on dragmanager message dmEnter/Leave/Move to get the DockRect to show. +Accept has been set to True, to signal acceptance. +Everything can be overridden by the OnDockOver handler, if installed. @@ -9765,10 +9772,10 @@ Reads message from flag area, or stores a message - - GetSiteInfo - software emulation of the - OnGetSiteInfo event - + Return information about this dock site (InfluenceRect). + The InfluenceRect determines the screen coordinates, within which a drop is accepted. +The InfluenceRect is the slightly inflated WindowRect of the dock site, adjustable in an OnGetSiteInfo handler. + @@ -15104,9 +15111,11 @@ and that description should be read to understand their definitions more fully. - DoDockClientMsg - issues a Dock Client message for a specified - DragDropOject at a given position; returns True if successful - + DoDockClientMsg - handles dmDragDock message for a specified DragDockObject at a given position; returns True if successful + Called when a control is dropped for docking. +Asks the dropped control to Dock itself into this control (adjust HostDockSite etc.) +Calls an installed DockManager to adjust the coordinates of the docked control. +The Result is always True (unless overridden). @@ -15125,7 +15134,7 @@ and that description should be read to understand their definitions more fully. - DoUndockClientMsg - issues a message to undock a client control; returns True if successful + DoUndockClientMsg - notifies DockManager of undock of a client control; always returns True. @@ -16103,6 +16112,47 @@ and that description should be read to understand their definitions more fully. bounds to the wanted position and sends a move message to the interface. It is up to the interface to handle moves instantly or queued.

 + + + SendDragMsg - sends to AControl a drag message at specified position for nominated object; returns an integer Result for success + + + + SendCmDragMsg - sends to DragTarget a drag message at specified position for nominated object; returns True for success + The Result is used to select the DragCursor (deny/accept drop). + + + Draw the DockRect outlines when its position has changed + Checks the DockRect for changes against EraseDockRect, to prevent flicker. +Remembers the drawn frame coordinates in EraseDockRect. + + + Shows the DockRect, remembers the coordinates in EraseDockRect + + + Hides the DockRect, invalidates EraseDockRect to prevent further erases. + + + Initializes the dragging coordinates. + Determines hotspot offset for adjusting the undocked rectangle. +Since the undocked extent of the control doesn't change, we fix the hotspot offset. +Usage: OffsetRect(DockRect, FDockOffset); + + + + Determine the DropAlign. + ADockObject contains valid DragTarget, DragPos and DragTargetPos relative dock site. +DropOnControl may be Nil if nothing has been docked yet, or no target control exists at the mouse coordinates. +DockRect may be unusable in this case (not yet determined). + +Return True if ADockObject.DropAlign has been determined. + + + + Determine the target control within the target DockSite. + Do nothing (return Nil) unless a DockManager is installed in the target site and something has already been docked. + + diff --git a/docs/xml/lcl/lclintf.xml b/docs/xml/lcl/lclintf.xml index 5d1b9d00a6..2bcdcd8128 100644 --- a/docs/xml/lcl/lclintf.xml +++ b/docs/xml/lcl/lclintf.xml @@ -3739,7 +3739,7 @@ the Canvas.SaveHandleState and Canvas.RestoreHandleState. - + Move Left/Right by dx, Top/Bottom by dy. Return Top and Left are >= 0.