diff --git a/components/lazcontrols/docs/dividerbevel.xml b/components/lazcontrols/docs/dividerbevel.xml index 51b8a3f634..bbecc1ba78 100644 --- a/components/lazcontrols/docs/dividerbevel.xml +++ b/components/lazcontrols/docs/dividerbevel.xml @@ -17,6 +17,7 @@ + @@ -49,11 +50,6 @@ - - - - - @@ -125,43 +121,56 @@ - + Sets the value for the Transparent property. - + + + - + New value for the Transparent property. - + Member with the height for the bevel. - Member with the height for the bevel. + Member with the top for the bevel. - Member with the flag set when the Font, Text, or preferred size is changed. + Member with the flag set when the Font, Text, Bevel or the preferred size has been changed. - + + + + + + + + Member with the text extent for the Caption property. - + + + + + - The default size of new instance of the class. + The default size for a new instance of the class.

GetControlClassDefaultSize is an overridden TSize function used to get the default size for new instances of the TDividerBevel class. The width (CX) in the TSize instance is set to 240. The height (CY) in the TSize instance is set to 17. @@ -242,9 +251,14 @@ Sets the value for the AutoSize property. - + +

+ SetAutoSize is an overridden method in TDividerBevel. It calls the inherited method on entry to update the member for AutoSize and to call the AdjustSize method when needed. It extends InvalidatePreferredSize method (in the ancestor) to clear any cached preferred size value for the control or any of its parents when Value is set to True. +

+
TControl.AutoSize + TControl.InvalidatePreferredSize
@@ -363,7 +377,7 @@ - + TBevelStyle @@ -373,8 +387,16 @@

The default value for the property is -1. Negative values in the property indicate that the bevel is drawn using 20% of the Text height for the control, with a minimum height of 3 pixels.

+

+ Changing the value in BevelWidth causes the control to be updated. When AutoSize is True, the preferred size is reset and the AdjustSize method is called. When AutoSize is False, an internal flag is set to indicate that the size needs to be recalculated in the CalcSize method. The Invalidate method is called to force the control to be redrawn. +

- + + + TControl.InvalidatePreferredSize + TControl.AdjustSize + TControl.Invalidate +
@@ -382,11 +404,11 @@ - Number of pixels reserved as spacing in front of and following the Caption. + Number of pixels reserved as spacing in front of and following the Caption for the control.

- The default value for the property is 10. Use LeftIndent to set the position (in pixels) where the Caption text starts. Any negative value in LeftIndent causes the caption to be centered along the bevel. + The default value for the property is 10. Use LeftIndent to set the position (in pixels) where the Caption text is drawn. A negative value in LeftIndent causes the caption to be centered along the bevel, and the value in CaptionSpacing is ignored.

@@ -405,7 +427,7 @@ - Position relative to Left where the CaptionSpacing and Caption are displayed. + Position relative to Left where the CaptionSpacing and Caption are drawn.

@@ -415,10 +437,10 @@ Use CaptionSpacing to set the number of pixels reserved as undecorated blank space on each side of the Caption text.

- For example: If CaptionSpacing is set to 10, and LeftIndent is set to 60, the CaptionSpacing starts at 60 pixels and the text at 70 pixels. + For example: If CaptionSpacing is set to 10, and LeftIndent is set to 60, the CaptionSpacing starts at 60 pixels and the text at 70 pixels relative to Left.

- LeftIndent, when set to any negative value, causes the CaptionSpacing and Caption text to be centered along the Orientation for the divider bevel. When set to 0, no left indent or caption spacing is applied before the Caption text. + LeftIndent, when set to a negative value, causes the CaptionSpacing and Caption text to be centered along the Orientation for the divider bevel. When set to 0, neither left indent nor caption spacing are applied before the Caption text.

Changing the value for the property causes the control to be redrawn. @@ -429,9 +451,9 @@ - + TControl.Caption TControl.Left @@ -452,7 +474,7 @@ TGraphicControl.Canvas - TControl.AutoSize + TControl.AutoSize TTrackBarOrientation @@ -465,7 +487,7 @@ - + Drawing style for the bevel on the control.

Style is a TGrabStyle property with the shape or pattern used to draw the bevel on the control. diff --git a/components/lazcontrols/docs/extendednotebook.xml b/components/lazcontrols/docs/extendednotebook.xml index 534321c0cb..4756d45e2c 100644 --- a/components/lazcontrols/docs/extendednotebook.xml +++ b/components/lazcontrols/docs/extendednotebook.xml @@ -30,174 +30,148 @@ Specifies an event handler signalled for a drag/drop event on a notebook tab. - - + +

+ TNotebookTabDragDropEvent is the type used for the OnTabDragDropEx property in TExtendedNotebook. It is used to perform actions needed when a tab on a TExtendedNotebook control is moved to a new location using drag and drop. +

+

+ An application must implement and assign an object method which uses this signature to respond to the event notification. It is signalled from the DragDrop method in TExtendedNotebook, and occurs after its OnTabDragOverEx event. +

+
+ + + + +
- + Object for the notification. - + Control where the drag operation originated. - + Original ordinal position for the dragged tab. - + New ordinal position for the dragged tab. - + True if the Ctrl key is pressed during the drag and drop operation. - + True if the tab can be moved to the new location. - Specifies an event handler signalled for a drag event over a notebook tab. + Specifies an event handler signalled when a dragged tab is over a notebook control. - + + + + + - + Object for the notification. - + Control where the drag operation originated. - + Original ordinal position for the dragged tab. - + New ordinal position for the dragged tab. - + True if the Ctrl key is pressed during the drag and drop operation. - + True if the notebook control can accept the dragged tab. - Implements an notebook or page control which supports drag and drop events for its tabs. + Implements a notebook or page control which supports drag and drop events for its tabs.

- TExtendedNotebook is a TPageControl descendant. + TExtendedNotebook is a TPageControl descendant, and extends the ancestor class with properties, methods, and events which enable drag and drop operations for the tabs on the paged notebook control. It works in conjunction with the DragManager (TDragManager) instance for the LCL interface. +

+

+ Overridden methods are provided initiates and completes a drag and drop operation, as well as handle mouse up, down and move messages for the control. Event handlers signalled during drag and drop are also provided. Additional properties are introduced to indicate how drop / drop operations are handled by the control and to identify the tab affected by the operation. +

+

+ TExtendedNotebook is used in the implementation of TSourceWindow in the Lazarus IDE, where it provides access to the source editor for a tab, as well as its form and anchor design surfaces.

- + + TPageControl + TDragManager + DragManager +
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + - - - - - - + - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + - Handles mouse down events for the control. - - + Handles mouse down messages for the control. + +

+ MouseDown is an overridden method in TExtendedNotebook. It initializes members used to track drag and drop operations in the class instance, and sets the DragCursor for the control. It calls the inherited MouseDown method to handle an OnEditingDone event for the ActiveControl on the parent form. It updates DragManager for the mouse button in the notification, and signals the OnMouseDown event handler (when assigned). When DragMode is set to dmAutomatic, a left mouse button event causes the value in MouseCapture to be set to True. +

+

+ MouseDown is called from methods which process LM_LBUTTONDOWN, LM_RBUTTONDOWN, LM_MBUTTONDOWN, and LM_XBUTTONDOWN window messages for the control. +

+
+ + TControl.OnEditingDone + TControl.MouseDown + TControl.WMLButtonDown + TControl.WMRButtonDown + TControl.WMMButtonDown + TControl.WMXButtonDown +
Mouse button for the event. @@ -307,7 +281,7 @@ - Performs actions needed when a drag operation is over a page or tab on the control. + Performs actions needed when a drag operation is over a tab on the control. @@ -337,7 +311,10 @@ Paints the window for the control to the specified device context. - + + TWinControl.PaintWindow + TPageControl.TabPosition + Device context where the window is drawn. @@ -350,7 +327,10 @@ Create is the overridden constructor for the class instance. It ensures that internal members used in drag and drop operations are initialized for the class instance.

- + + + TPageControl.DragCursor +
Owner of the class instance. @@ -413,10 +393,19 @@ Ordinal position for the tab affected by a drag operation.

- DraggingTabIndex is a read-only Integer property. + DraggingTabIndex is a read-only Integer property which contains the ordinal position for the tab or page active in a drag and drop operation. Its value is assigned in methods like BeginDragTab, DoEndDrag, and DragCanceled. The value is set to -1 when drag and drop is not active for the control. +

+

+ Its value is used in the DragOver and DragDrop methods, and is passed as an argument to event handlers signalled in the class instance.

- + + + + + + +
@@ -445,7 +434,7 @@ - Event handler signalled when and object is dropped onto a tab on the control while the Ctrl key is held. + Event handler signalled when an object is dropped onto a tab on the control while the Ctrl key is held. @@ -453,7 +442,7 @@ - Event handler signalled when a drag operation is ended for the control. + Event handler signalled when a drag operation is ended for a tab on the control. @@ -461,7 +450,7 @@ - Event handler signalled when a drag operation is started for the control. + Event handler signalled when a drag operation is started for a tab on the control. @@ -469,11 +458,11 @@ - Drag mode for a tab on the control. + Indicates how a Drag operation is started for a tab on the control.

- The default value for the property is dmManual. + The default value for the property is dmManual, and indicates that the operation is started in code executed by OnTabStartDrag event handler for the control. When set to dmAutomatic, the drag operation is initialized in the MouseDown method when the left mouse button is clicked on a tab for the notebook control.

@@ -481,11 +470,14 @@ - Default accept mode for drag operation for a tab. + Default accept mode for a drag operation for a tab.

- The default value for the property is dmManual. + TabDragAcceptMode is a TDragMode property which indicates how a dragged tab is accepted on the destination control. It is used in the DragDrop method to determine whether the tab is positioned automatically, or handled in code assigned to an event handler. +

+

+ The default value for the property is dmManual, and indicates that the tab is relocated manually in the OnTabDragDropEx event handler for the control. When set to dmAutomatic, the tab is automatically relocated using the Move method in the Pages collection for the control.

diff --git a/components/lazcontrols/docs/listviewfilteredit.xml b/components/lazcontrols/docs/listviewfilteredit.xml index 598d1e3f94..77adf98491 100644 --- a/components/lazcontrols/docs/listviewfilteredit.xml +++ b/components/lazcontrols/docs/listviewfilteredit.xml @@ -79,7 +79,6 @@ - TFPGList
diff --git a/components/lazcontrols/docs/spinex.xml b/components/lazcontrols/docs/spinex.xml index 733a00b08e..77ff29c2d3 100644 --- a/components/lazcontrols/docs/spinex.xml +++ b/components/lazcontrols/docs/spinex.xml @@ -208,7 +208,6 @@ -
@@ -675,8 +674,8 @@

- - + +
@@ -717,7 +716,7 @@
- +
@@ -764,7 +763,6 @@
-
@@ -901,12 +899,12 @@

- - - - - - - + + + + + +
@@ -928,10 +926,6 @@ - - - -
@@ -954,10 +948,6 @@ - - - -
@@ -1015,7 +1005,6 @@ -
@@ -1199,7 +1188,7 @@

- + @@ -1266,9 +1255,7 @@ - -
@@ -1362,8 +1349,7 @@ - - + @@ -1394,10 +1380,10 @@ - + - + @@ -1423,11 +1409,9 @@

- + - - @@ -1470,9 +1454,7 @@ - - - +
@@ -1536,11 +1518,10 @@ - + -
@@ -1555,14 +1536,11 @@

- - - + + - -
@@ -1752,7 +1730,6 @@ -
@@ -1781,7 +1758,6 @@ " -
@@ -1835,7 +1811,6 @@ -
@@ -1863,8 +1838,7 @@

- - +
@@ -1905,10 +1879,9 @@

- + -