From 94a92b78f2ab7ea6bfbb2b254d40c7fe9dabd151 Mon Sep 17 00:00:00 2001
From: dsiders
+TDragKind is an enumeration type with values that indicate the
+action performed when the mouse is used to start a drag operation.
+
+TDragKind is the type used to implement the Dragkind property in TControl.
+
+Called when a TDragPerformer repositions the the mouse pointer during an
+active drag operation.
+
+MouseDown is an abstract virtual method in
+TDragManager. It must be overridden in a descendent class to
+perform actions need for the drag manager implementation.
+
+In the LCL, the drag managers are implementation classes like
+TDragManagerDefault. This derived classes ignores the button down event in
+the drag manager to prevent a premature end to a drag operation. The button
+down event has already been initiated in the message processing loop in
+TControl. MouseUp handles ending the drag operation.
+
+Dragging is an abstract virtual method in TDragmanager.
+It must be implemented in a descendent class to perform actions needed in
+the method.
+
+Use IsDragging to determine whether a drag performer is active in the drag
+manager for a(ny) control.
+
-CanStartDragging must be implemented in a descendent class, like -TDragManagerDefault. +CanStartDragging must be implemented in a descendent class, like the +TDragManagerDefault class in the implementation for the unit.
TConstrainedResizeEvent is an object procedure type that specifies an event handler signalled to resize a control to the specified size -constraints. Used to implement the OnConstrainedResize event in -TControl. +constraints. The handler routine can update the values in the MinWidth, +MinHeight, MaxWidth, and MaxHeight arguments if needed. +
++TConstrainedResizeEvent is the type used to implement the +OnConstrainedResize event in TControl.
-TSpacingSize is an alias to the Integer type. +TSpacingSize is an alias for the Integer type. TSpacingSize is used for values that represent spacing around or between controls. TSpacingSize is the type used to implement properties in TControlBorderSpacingDefault and TControlBorderSpacing. @@ -5186,14 +5302,24 @@ Used, for example, when the Parents.ChildSizing.Layout defines a table layout.
+Space is an indexed Integer property which provides +access to the border spacing used for a specified TAnchorKind value. For example: +
+AControl.BorderSpacing.Space[akTop] := 6;
+
@@ -5546,7 +5670,7 @@ Left properties.
+Formerly, this method changed the OnClick event handler for the client
+control. That action no longer need because TControl.Click now calls the
+OnExecute handler in the action.
+
+In the current LCL version, this method is a NOP.
+
+DoShowHint is a Boolean function used to build a hint
+string for the client control when it includes a shortcut or accelerator key.
+In short, a HintStr like:
+
+Is formatted as:
+
+No actions are performed in the method if the Action is not derived from
+TCustomAction, HintShortCuts has not been enabled in the Application, or the
+action has the value scNone in its ShortCut property.
+
+DoShowHint signals the OnHint event handler in the action (when assigned) to
+get custom hint text. HintStr is replaced with the combined value for the
+hint text and the ShortCut for the Action. ShortCutToText is called to
+convert the TShortCut value to its string representation like 'Ctrl+S'.
+
+The return value is always True.
+'&Save your work.'
+'Save your work. (Ctrl+S)'
+
Floating state is assumed when the control has a HostDockSite using the -FloatingDockSiteClass type, and is the only docked client. +FloatingDockSiteClass type, and 0 or 1 docked clients.
+DragCanceled has an empty implementation in TControl. +
+The default value is crDrag. If the control cannot be dropped on a target, @@ -11760,32 +12019,46 @@ the cursor changes temporarily to crNoDrop.
Set to dkDrag for a drag-drop operation, or to dkDock for a drag-dock operation.
-The default value is dmManual, and indicates that dragging must be started in -code. +DragMode is a TDragMode property which determines how a +drag operation is started for the control.
-Set to dmAutomatic to allow the user to drag this control. In this mode -dragging can start immediately (on left mouse button press) or delayed, after -the mouse has been moved away by a number of pixels (Threshold). +dmManual is the default value, and indicates that drag operation must be +started in code by calling the BeginDrag method. +
++dmAutomatic allows a drag operation to start when the mouse pointer is +dragged over the control. +
++Use DragKind to specify whether the drag operation is a drag-and-drop or a +drag-and-dock operation.
-Unlike for a drag-dock operation, no default action is associated with an -drag-drop; the OnDragDrop handler is the only way to do something meaningful -on an drag-drop. +OnDragDrop is a TDragDropEvent property with the event +handler signalled when another control is dropped onto the control instance. +Unlike with drag-dock, a default action is not associated with the drag-drop +operation. The OnDragDrop handler is the only way to do something meaningful +for the drag-drop operation. +
++The Sender argument contains the current control instance (Self) +for for the event. +
++The Source argument is the object (TControl) which is droppped +onto the current control instance. +
++X and Y contains the control-relative coordinates for +the mouse pointer when the event occurred. +
++OnDragDrop is signalled from the DragDrop method, and occurs when dmDragDrop +messages (TDragMessage) are handled for the control.
+OnDragOver is a TDragOverEvent property with the event +handler signalled when another control is dragged over the current control. +It is signalled from the DragOver method, and occurs when drag messages are +handled for the control. +
++The Sender argument is the current TControl instance. +
++The Source argument contains the control instance which is being +dragged over the control. +
++The X and Y arguments contain the control-relative coordinates for the mouse +pointer when the event was triggered. +
++State indicates whether the event has occurred when the mouse +pointer entered the control, was repositioned, or exited the control. +
++The Accept argument indicates whether the drag operation is +handled in the routine or rejected. Set Accept to False to reject a +drop on the control. +
+OnEndDock is a TEndDragEvent property with the event +handler signalled when a drag-dock operation is ended. It occurs when the +EndDrag method is called for the active drag object in the DragManager. +
++Use OnEndDrag to perform actions needed when a drag-drop operation is ended. +
++OnEndDrag is a TEndDragEvent property with the event +handler signalled when a drag-drop operation is ended. It occurs when the +EndDrag method is called for the active drag object in the DragManager. +
++Use OnEndDrag to perform actions needed when a drag-drop operation is ended. +
+-The handler routine can provide a special DragControl object. Otherwise, a -default object is created. +OnStartDrag is a TStartDragEvent property with the +event handler signalled when a drag operation is started for the control. Use +the event handler to perform actions needed when the drag operation is +started, such customizing the drag cursor or initializing related drag event +handlers. +
++The Sender argument is the TControl instance for the event +notification. +
++The DragObject argument returns the TDragControlObject allocated +by the drag manager when the drag operation was started.
+ManualFloat is a Boolean function used to undock the +control. It undocks the control from the HostDockSite (when assigned) found +in the control or in its Parent. +
++For TControl, which does not have a handle, a floating host dock site where +the control can be docked is created. TWinControl has a handle and can float +without any assistance. +
++The Dock method is called to dock the control to the new floating dock site. +
++The return value is True if the control was successfully undocked +and re-docked to a floating dock site. +
+The anchor control used in the TAnchorSide instances is always the Parent +control. +
++AnchoredControls is a read-only indexed TControl +property which allows access to controls which which are anchored to the +control instance. Anchored controls are indexed by their ordinal position in +the list used to store the values. +
+-AutoAdjustLayout can be used to alter PPI settings, scale the control, or -apply changes to height or width without scaling. +AutoAdjustLayout can be used to alter PPI settings, scale the +control, or apply changes to height or width without scaling.
-AMode indicates the layout policy applied in the method, and the actions -performed to achieve the task. +AMode indicates the layout policy applied in the method, and the +actions performed to achieve the task.
Scaling factors are calculated (when needed) for both horizontal (X-axis) and
@@ -14124,7 +14553,10 @@ Ends a drag operation by notifying the drag manager.
Changing the value for the property causes a CM_CURSORCHANGED message to be -performed to update the control. The value is applied ar run-time when the +performed to update the control. The value is applied at run-time when the CMCursorChanged method handles the control message.
@@ -17190,54 +17637,34 @@ in the properties.
-BorderStyle is a TBorderStyle property which indicates whether borders are -drawn for the control. bsSingle indicates that borders are drawn for the -control. The default value for the property is bsNone, and indicates that -borders are not drawn for the control. +BorderStyle is a TBorderStyle property which indicates +the borders drawn for the control. bsSingle indicates that borders are drawn +for the control. The default value for the property is bsNone, and indicates +that borders are not drawn for the control.
Changing the value for the property causes the widgetset class to be updated @@ -25934,7 +26365,7 @@ A.AnchorSide[akTop].Side:=asrCenter; A.AnchorSide[akTop].Control:=B;
-Or use this, it's equivalent: +Or use this equivalent:
A.AnchorSide[akBottom].Side:=asrCenter;