diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index 0be307bc3b..98240a7c69 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -9247,33 +9247,69 @@ Control message handled in the method. - Handles a CM_PARENTSHOWHINTCHANGED message for the control. - - + +

+CMParentShowHintChanged ensures that the ShowHint property in the +control is updated when the corresponding property in the Parent control is +changed. When ParentShowHint is set to True, the ShowHint property +from the Parent is copied into the control. +

+
+ + + +
- + +Control message handled in the method. + Handles a CM_VISIBLECHANGED message for the control. - - + +

+CMVisibleChanged causes the control to be redrawn using the +Visible and ControlStyle properties in the class instance. It allows a +parented control to be redrawn using the visibility and opacity settings for +the control. It calls the InvalidateControl method to invalidate the bounds +rectangle or the control. +

+

+No actions are performed in the method at design-time. +

+
+ + + +TComponent.ComponentState +
- + +Control message handled in the method. + Handles a CM_TEXTCHANGED message for the control. + +

+Calls the TextChanged method when the message is received by the control. +

+
+ + +
@@ -9391,9 +9427,25 @@ user (e.g. a dock caption). -Not implemented in TControl. - - + +Performs actions needed before a drag operation is started for the control. + + +

+BeforeDragStart has an empty implementation in +TControl. The virtual method can be overridden in descendent +classes to perform the actions needed. Some common actions include updating +control flags or checking for a valid Handle before starting the drag +operation. +

+

+BeforeDragStart is called from the DragStart method in TDragManager. +

+
+ + + +
@@ -9438,7 +9490,7 @@ The dragged DockObject, containing the DockRect to adjust. -Adjusts the control's position and extent for the new docksite. +Adjusts the control position and extent for the new docksite.

@@ -9540,41 +9592,91 @@ indicates acceptance of the drop message. -Signals the OnEndDock -handler. +Signals the OnEndDock event handler when the control has been undocked. + +

+No actions are performed in the method if a handler routine has not been +assigned to OnEndDock. +

+

+DoEndDock is called from the EndDrag method in TDragDockObject. +

+
+ + + +
- + +Object instance with the target control or dock site site. + - + +Horizontal mouse coordinate where the mouse button was released. + - + +Vertical mouse coordinate where the mouse button was released. + -Signals the OnEndDrag -handler. +Signals the OnEndDrag event handler. + +

+DoEndDrag occurs when a drag operation for the control has been +completed. In TControl, it signals the OnEndDrag event +handler (when assigned). Arguments to the handler include the target control +(or dock site) and the mouse coordinates when the drag operation was +completed. +

+

+No actions are perform in the method if a handler routine has not been +assigned to OnEndDrag. +

+

+Descendent classes may override the method to perform additional actions +needed in their implementation. +

+

+DoEndDrag is called from the EndDrag method in TDragObject. +

+
+ + + +
- + +Object instance with the target control or dock site site. + - + +Horizontal mouse coordinate where the mouse button was released. + - + +Vertical mouse coordinate where the mouse button was released. + -Signals the OnStartDock -handler. +Signals the OnStartDock event handler. + + + + @@ -9582,16 +9684,21 @@ handler. -Signals the OnStartDrag -handler. +Signals the OnStartDrag event handler. + + + + -Notifies the control of a cancelled drag. + +Notifies the control of a cancelled drag operation. + @@ -9710,9 +9817,26 @@ Neither OnClick nor the ActionLink are executed at design-time. Signals the OnDblClick event handler (when assigned). - + +

+DblCLick is a method used to perform actions needed when a mouse +double click event has occurred on the control. In TControl, it signals the +OnDblClick event handler (when assigned) using the class instance as the +Sender argument in the event type. +

+

+Descendent classes may override the method to perform additional actions +needed in the their implementations. +

+

+DblClick is called from the WMLButtonDBLCLK method when the LM_LBUTTONDBLCLK +window message is handled for the control. +

+
+ +TNotifyEvent
@@ -9720,9 +9844,25 @@ Signals the OnDblClick event handler (when assigned). Signals the OnTripleClick event handler (when assigned). - + +

+TripleClick is a method used to perform actions needed when a +mouse triple click event has occurred on the control. In TControl, +it signals the OnTripleClick event handler (when assigned) using the class +instance as the Sender argument in the event type. +

+

+Descendent classes may override the method to perform additional actions +needed in the their implementations. +

+

+TripleClick is called from the WMLButtonTripleCLK method when the M_LBUTTONTRIPLECLK window message is handled for the control. +

+
+ +TNotifyEvent
@@ -9730,9 +9870,26 @@ Signals the OnTripleClick event handler (when assigned). Signals the OnQuadClick event handler (when assigned). - + +

+QuadClick is a method used to perform actions needed when a +mouse quadruple click event has occurred on the control. In +TControl, it signals the OnQuadClick event handler (when assigned) +using the class instance as the Sender argument in the event type. +

+

+Descendent classes may override the method to perform additional actions +needed in the their implementations. +

+

+QuadClick is called from the WMLButtonQuadCLK method when the +M_LBUTTONQUADCLK window message is handled for the control. +

+
+ +TNotifyEvent @@ -9946,20 +10103,60 @@ handler. -Signals the OnMouseEnter handler. +Signals the OnMouseEnter event handler (when assigned). - - + +

+MouseEnter is a method used to perform actions when the mouse +pointer enters the client rectangle for the control. In TControl, +it signals the OnMouseEnter event handler using the class instance as the +Sender argument. +

+

+Descendent classes may override the method to perform actions needed for +their implementations. +

+

+MouseEnter is called from the CMMouseEnter method when a CM_MOUSEENTER +message is handled for the control. +

+
+ + + + + + +
-Signals the OnMouseLeave handler. +Signals the OnMouseLeave event handler (when assigned). - - + +

+MouseLeave is a method used to perform actions when the mouse +pointer leaves the client rectangle for the control. In TControl, +it signals the OnMouseLeave event handler using the class instance as the +Sender argument. +

+

+Descendent classes may override the method to perform actions needed for +their implementations. +

+

+MouseLeave is called from the CMMouseLeave method when a CM_MOUSELEAVE +message is handled for the control. +

+
+ + + + + + +
@@ -10024,11 +10221,26 @@ Performs actions needed when the value for the control has been changed.

-In TControl, Changed posts a CM_CHANGED control message to the message -processing loop. +In TControl, Changed calls Perform to post a CM_CHANGED +control message to the message processing loop. The Parent control, which +provides the window handle, receives the message in its CMChanged method and +calls its WindowProc processing loop. +

+

+Changed may be overridden or reimplemented in descendent classes to perform +actions needed in the implementations for the controls. For instance, +triggering OnChange or other notification events. +

+

+Changed is called when properties for the control, especially its value, have +been modified.

- + + + + +
@@ -10570,7 +10782,9 @@ immediate abort of dragging before dragging really starts. -Notification handler for insertion or deletion of components. + +Notification handler for insertion or deletion of components. +

First, the inherited TComponent.Notification is called to notify @@ -10595,7 +10809,7 @@ anchors for the removed control are detached. -Determined whether the Tab key can be used for navigation in the control. +Determines whether the Tab key can be used for navigation in the control.

@@ -10707,7 +10921,9 @@ not to the up and down handlers [Delphi compatible]. -Signals the OnMouseWheelDown handler. + +Signals the OnMouseWheelDown handler. + True if handled. @@ -10716,7 +10932,9 @@ not to the up and down handlers [Delphi compatible]. -Signals the OnMouseWheelUp handler. + +Signals the OnMouseWheelUp handler. + True if handled. @@ -10746,8 +10964,11 @@ Performs actions needed to handle horizontal mouse wheel events. TPoint with the mouse coordinates for the event. + -Performs the OnMouseWheelLeft event handler. + +Signals the OnMouseWheelLeft event handler. + @@ -10762,7 +10983,9 @@ Performs actions needed to handle horizontal mouse wheel events. -Performs the OnMouseWheelRight event handler. + +Signals the OnMouseWheelRight event handler. + @@ -10777,7 +11000,9 @@ Performs actions needed to handle horizontal mouse wheel events. -Notifies all OnVisibleChanging handlers. + +Notifies all OnVisibleChanging handlers. + @@ -10929,11 +11154,11 @@ notification. Signals the OnContextPopup handler.

-DoContextPopup is a method used to signal the OnContextPopup event handler -(when assigned). The control instance is used as the Sender argument. Values -in MousePos and Handled are also passed as parameters to the event handler. -Handled should be set to True in the handler routine if the context -pop-up was displayed and a menu item was executed. +DoContextPopup is a method used to signal the OnContextPopup event +handler (when assigned). The control instance is used as the Sender argument. +Values in MousePos and Handled are also passed as parameters to the event +handler. Handled should be set to True in the handler routine if the +context pop-up was displayed and a menu item was executed.

@@ -10994,20 +11219,20 @@ the control.

-DoAutoAdjustLayout is a method which implements changes to control sizes for -the AutoAdjustLayout method. These methods are called when High-DPI and -scaling have been enabled in the project options for an application. +DoAutoAdjustLayout is a method which implements changes to control +sizes for the AutoAdjustLayout method. These methods are called when High-DPI +and scaling have been enabled in the project options for an application.

-AMode indicates the automatic layout policy applied in the method. It is a -value from the TLayoutAdjustmentPolicy enumeration, and determines whether -horizontal / vertical / or both sizes are adjusted in the method. It +AMode indicates the automatic layout policy applied in the method. +It is a value from the TLayoutAdjustmentPolicy enumeration, and determines +whether horizontal / vertical / or both sizes are adjusted in the method. It generally reflects the constraints for the device type where the application is running.

-AXProportion and AYProportion contain the scaling factors applied to the -horizontal and/or vertical sizes. +AXProportion and AYProportion contain the scaling +factors applied to the horizontal and/or vertical sizes.

DoAutoAdjustLayout ensures that new values for Height and Width in the @@ -11179,7 +11404,8 @@ operation. Allows the user to drag the control.

-Default is dmManual, meaning that dragging must be started in code. +The default value is dmManual, and indicates that dragging must be started in +code.

Set to dmAutomatic to allow the user to drag this control. In this mode @@ -11295,10 +11521,11 @@ restored from an external storage mechanism.

-SessionProperties is a String property with the names of properties, in the -class instance or its child Components. SessionProperties allows published -property values to be saved to and restored from an external storage -mechanism like: TIniPropStorage, TXMLPropStorage, or TJSONPropStorage. +SessionProperties is a String property with the names +of properties, in the class instance or its child Components. +SessionProperties allows published property values to be saved to and +restored from an external storage mechanism like: TIniPropStorage, +TXMLPropStorage, or TJSONPropStorage.

Values in the property are delimited using the ';' (SemiColon) character. @@ -11308,8 +11535,8 @@ values can be assigned at design-time using a dialog in the Lazarus IDE, or by setting the property value at run-time.

-In TControl, SessionProperties has protected visibility; it is elevated to -published visibility in the TForm descendant. +In TControl, SessionProperties has protected visibility; it is +elevated to published visibility in the TForm descendant.