From 2b67dddf551cdcc5e6691248257635bc6d3b0b9f Mon Sep 17 00:00:00 2001 From: dsiders Date: Fri, 3 Mar 2023 04:45:32 +0000 Subject: [PATCH] Docs: LCL/forms. Adds content, grammar corrections, missing line endings in topics. --- docs/xml/lcl/forms.xml | 65 ++++++++++++++++++++++++++++-------------- 1 file changed, 44 insertions(+), 21 deletions(-) diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index dbf2959f79..f92f41fcfb 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -85,10 +85,15 @@ Used to define members in control classes. -Type used for an object procedure that takes no arguments. + +Type used for an object procedure that takes no arguments. +

-Used to define members in control classes. +TProcedureOfObject is a type which represents a parameter-less +object procedure. It is used in control classes to represent an event handler +which when signalled expects no arguments - not even a Sender object instance. +For example: TCustomUpDown uses it for its internal mouse timer event.

@@ -203,7 +208,6 @@ option.
- Represents actions that can occur when a form is closed. @@ -235,7 +239,6 @@ Uncomment when the topic exists in RTL documentation. - Represents the caNone enumeration value in TCloseAction. @@ -311,11 +314,7 @@ enabled. - -The text used for the Hint. - - - + The orientation of a scroll bar. @@ -2524,7 +2523,9 @@ end; end.

-One drawback is that complex inheritance hierarchies for TFrame classes can be problematic; they do not propagate changes to all derived frames in a multi-level inheritance tree. +One drawback is that complex inheritance hierarchies for TFrame +classes can be problematic; they do not propagate changes to all derived +frames in a multi-level inheritance tree.

@@ -3002,13 +3003,15 @@ end; end.

-One drawback is that complex inheritance hierarchies for TFrame classes can be problematic; they do not propagate changes to all derived frames in a multi-level inheritance tree. +One drawback is that complex inheritance hierarchies for TFrame +classes can be problematic; they do not propagate changes to all derived +frames in a multi-level inheritance tree.

TFrame contains a new property which indicates the LCL (Lazarus Component Library) version number used in the container. An overridden constructor is also introduced to initialize the value in the LCLVersion property. TFrame -sets the visibility for properties defines in ancestor classes. +sets the visibility for properties defined in ancestor classes.

@@ -5055,7 +5058,7 @@ Performs a delayed bounds change using the DelayedEvent for the control. TCustomForm. It re-implements the method from the ancestor class, and does not call the inherited method.

-

+

DoOnChangeBounds sets an internal flag to indicate that a delayed bounds change event has been requested. It increments an internal counter to track the number of pending delayed events. @@ -16922,7 +16925,7 @@ HintPause is an Integer property with the number of milliseconds to wait before a Hint window is displayed for a form or control.

-The default value is defines in the DefHintPause constant and assigned to the +The default value is defined in the DefHintPause constant and assigned to the property in the constructor for the application instance.

@@ -19042,21 +19045,39 @@ TWindowState value for the specified string, or wsNormal by default. -Formats various typed values into readable text. - + +Formats debugger messages for various types by converting their values into +readable text. + + +

+dbgs is overloaded in forms.pp. The overloads handle +creating textual information for the TWindowState, TCloseAction, and +TScrollBarKind types. The text is used in DebugLn and WriteLn messages in the +Lazarus debugger. +

+
-The formatted value. + +The formatted text with values for the specified argument. + - + +TWindowState instance with values included in the text. + - + +TCloseAction instance with values included in the text. + - + +TScrollBar instance with values included in the text. + @@ -19153,7 +19174,9 @@ object. - + +TPersistent instance for the event notification. +