diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index 8bf1369a2c..6f3bd30354 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -8,7 +8,7 @@ --> - Implements Forms, which are the basis for the Lazarus Graphical User Interface. + Implements Forms, which are the basis for the LCL Graphical User Interface.

@@ -165,7 +165,9 @@ Neither maximized nor minimized. - The window is minimized and is not shown in the screen, but only in the taskbar. + + The window is minimized and is not shown in the screen, but only in the taskbar. + @@ -354,7 +356,7 @@ - True when the Control for the class instance has set its AutoScroll property. + True when the Control for the class instance has set its AutoScroll property. @@ -425,7 +427,9 @@ - True when the associated TScrollingWinControl and its handle are valid. + + True when the associated TScrollingWinControl and its handle are valid. +

Used in methods which call LCL interface routines to avoid exceptions resulting from an unassigned control or an invalid handle value. @@ -434,7 +438,9 @@ - True when the associated TScrollingWinControl and its handle are valid. + + True when the associated TScrollingWinControl and its handle are valid. + @@ -446,7 +452,7 @@ - True when AutoScroll is enabled for the scroll bar. + True when AutoScroll is enabled for the scroll bar. @@ -465,7 +471,7 @@ Validates and applies the specified Range and updates the scroll bars.

- Ensures that AValue is not less than zero (0). Applies the range limited value to the member for the Range property, and calls ControlUpdateScrollBars to refresh the scroll bars for the associated TScrollingWinControl instance. + Ensures that AValue is not less than zero (0). Applies the range limited value to the member for the Range property, and calls ControlUpdateScrollBars to refresh the scroll bars for the associated TScrollingWinControl instance.

InternalSetRange is called when the SetRange method updates the value for the Range property. @@ -501,7 +507,7 @@

Sets Position to the value in the Pos member in Message.
SB_THUMBTRACK
- Sets Position to the value in the Pos member in Message when Tracking is enabled. No actions are performed when Tracking is set to False. + Sets Position to the value in the Pos member in Message when Tracking is enabled. No actions are performed when Tracking is set to False.
SB_TOP
Sets Position to 0 (zero).
@@ -637,7 +643,7 @@ - True when Visible, and Range is larger than the Page size. + True when Visible, and Range is larger than the Page size. @@ -657,9 +663,9 @@
Position and Range
Set to 0 (zero).
Smooth and Tracking
-
Set to False.
+
Set to False.
Visible
-
Set to True.
+
Set to True.
 @@ -679,7 +685,7 @@

- Assigns the contents of the source object to the current object; in particular finds the Increment, Position, Range and whether smooth scrolling is to be feature and whether the scroll bar is visible. + Assigns the contents of the source object to the current object; in particular finds the Increment, Position, Range and whether smooth scrolling is to be feature and whether the scroll bar is visible.

@@ -710,7 +716,7 @@ - True if the scroll bar is visible. + True if the scroll bar is visible. @@ -775,7 +781,7 @@
Returns the client height from the associated control.

- ClientSize is used in methods like ClientSizeWithBar and ClientSizeWithoutBar to get the size for the scroll bar adjusted for scroll bar spacing returned from GetSystemMetrics. + ClientSize is used in methods like ClientSizeWithBar and ClientSizeWithoutBar to get the size for the scroll bar adjusted for scroll bar spacing returned from GetSystemMetrics.

@@ -945,7 +951,7 @@ Gives feedback while the slider is dragged.

- When it takes a significant amount of time to repaint the parent control at a new position, Tracking should be False to prevent flicker. This causes the control to be updated only when the slider is released. + When it takes a significant amount of time to repaint the parent control at a new position, Tracking should be False to prevent flicker. This causes the control to be updated only when the slider is released.

@@ -953,13 +959,13 @@ - Hides the scroll bar when False (default True). + Hides the scroll bar when False (default True).

The scroll bar widget is visible only if (Visible=True) and (Range>Page).

- Set Visible to False to disallow the user to scroll the content, while the content still can be scrolled by code. + Set Visible to False to disallow the user to scroll the content, while the content still can be scrolled by code.

Use IsScrollBarVisible to get the current visible state of the widget. @@ -996,7 +1002,9 @@ - Prevents recursive updates, True while an update is already in progress. + + Prevents recursive updates, True while an update is already in progress. + @@ -1049,11 +1057,16 @@ - True when not automatically resized or used as a dock site. + True when not automatically resized or used as a dock site. + Sets or resets the ranges used for scroll bars in the control. - Used in the implementation of the ComputeScrollbars method. + +

+ Used in the implementation of the ComputeScrollbars method. +

+ @@ -1183,14 +1196,14 @@ - Updates Page, AutoRange, IsScrollBarVisible, and returns True when changed. + Updates Page, AutoRange, IsScrollBarVisible, and returns True when changed. - True when something has been changed in the scroll bar settings. + True when something has been changed in the scroll bar settings. @@ -1525,10 +1538,10 @@

- ParentBackground is a Boolean property which indicates if the background for the Parent control is drawn as the background for the current control instance. The default value in TScrollBox is False. + ParentBackground is a Boolean property which indicates if the background for the Parent control is drawn as the background for the current control instance. The default value in TScrollBox is False.

- ParentBackground is True when csParentBackground is included in the ControlStyle property. Setting the value in ParentBackground causes ControlStyle to be updated to include or exclude the csParentBackground enumeration value; it is included when True. + ParentBackground is True when csParentBackground is included in the ControlStyle property. Setting the value in ParentBackground causes ControlStyle to be updated to include or exclude the csParentBackground enumeration value; it is included when True.

@@ -1579,7 +1592,9 @@ - Provides a designer surface for scaling and layout of its child controls. + + Provides a designer surface for scaling and layout of its child controls. +

TCustomDesignControl is a TScrollingWinControl descendant which provides a designer surface used for scaling and layout of its child controls. @@ -1646,7 +1661,7 @@ DoAutoAdjustLayout adjusts the height and width for the design surface by the specified scaling factors. Similarly, the BorderSpacing and Constraints in the control are adjusted using the scaling factors. Finally, the SetBounds method is called to apply the new values for Height and Width to the design surface.

- No actions are performed in the method when the Parent property has not been assigned (contains Nil). In addition, no actions are performed when AMode omits the lapAutoAdjustWithoutHorizontalScrolling and lapAutoAdjustForDPI enumeration values. + No actions are performed in the method when the Parent property has not been assigned (contains Nil). In addition, no actions are performed when AMode omits the lapAutoAdjustWithoutHorizontalScrolling and lapAutoAdjustForDPI enumeration values. @@ -1769,10 +1784,10 @@ The base type for TFrame.

- TCustomFrame is a TCustomDesignControl descendant which implements the base class for TFrame. A Frame is a named container for related components. Groups of controls can be place on a frame, and re-used in your applications. + TCustomFrame is a TCustomDesignControl descendant which implements the base class for TFrame. A Frame is a named container for related components. Groups of controls can be place on a frame, and re-used in your applications.

- A Frame has behavior very similar to a Form. Their unique ability is that they can be embedded into forms or other frames in the designer. Like forms, they are stored in two separate files: the code is stored in a .pas unit file, and the design is stored in a .lfm file. + A Frame has behavior very similar to a Form. Their unique ability is that they can be embedded into forms or other frames in the designer. Like forms, they are stored in two separate files: the code is stored in a .pas unit file, and the design is stored in a .lfm file.

Frames can be created and designed in the Lazarus IDE by creating a new Frame module, and using the unit in your application. An existing frame can be added using the TFrame component on the Standard tab in the Lazarus IDE; you will be prompted for the TFrame class to use for the component. @@ -1788,14 +1803,16 @@ - Adds the specified list of Actions to the Parent form for the frame class. + + Adds the specified list of Actions to the Parent form for the frame class. + No actions are performed in the method when a Parent form has not been assigned for the class instance. -

- AddActionList is called from the Notification method when a TCustomActionList instance has been added to the control. This occurs when a new Parent is assigned for the frame instance. -

+

+ AddActionList is called from the Notification method when a TCustomActionList instance has been added to the control. This occurs when a new Parent is assigned for the frame instance. +

@@ -1934,7 +1951,7 @@ Sets the value for the ParentBackground property.

- Ensures that Color is changed to the value in the Parent control when the property is set to True. Color is set to clDefault when the property is set to False. Calls UpdateOpaque to ensure that the csOpaque style flag is applied to the ControlStyle property as needed. + Ensures that Color is changed to the value in the Parent control when the property is set to True. Color is set to clDefault when the property is set to False. Calls UpdateOpaque to ensure that the csOpaque style flag is applied to the ControlStyle property as needed.

@@ -1949,7 +1966,7 @@ Handles the CM_PARENTCOLORCHANGED message for the control.

- CMParentColorChanged is an overridden method in TCustomFrame. It calls the inherited method on entry to update the values in Color and ParentColor. If the control has finished loading using the LCL component streaming mechanism, the UpdateOpaque method is called to update flag values in the ControlStyle property. ControlStyle is not updated if csLoading is included in the ComponentState property. + CMParentColorChanged is an overridden method in TCustomFrame. It calls the inherited method on entry to update the values in Color and ParentColor. If the control has finished loading using the LCL component streaming mechanism, the UpdateOpaque method is called to update flag values in the ControlStyle property. ControlStyle is not updated if csLoading is included in the ComponentState property.

@@ -1982,7 +1999,9 @@ - Gets the preferred height and width for the control used during auto-sizing. + + Gets the preferred height and width for the control used during auto-sizing. +

CalculatePreferredSize is an overridden method in TCustomFrame. It ensures that the inherited method is not called when the frame is an un-parented component and visible on the form designer. This allows the dimensions to be freely resized on the design surface. Values in the PreferredWidth, PreferredHeight, and WithThemeSpace arguments are not modified at design-time. @@ -2002,7 +2021,9 @@ Preferred height for the control. - True if additional space is reserved in the width or height for theme details. + + True if additional space is reserved in the width or height for theme details. + @@ -2073,7 +2094,7 @@ The write access specifier is overridden in TCustomFrame. It calls the inherited method on entry.

- If the new property value is True and ParentColor is True, the color assigned to the Parent control is stored in the Color property. Otherwise, Color is set to the value clDefault. The UpdateOpaque method is called to adjust the control style flags for the control. + If the new property value is True and ParentColor is True, the color assigned to the Parent control is stored in the Color property. Otherwise, Color is set to the value clDefault. The UpdateOpaque method is called to adjust the control style flags for the control.

The default value for the property is True. @@ -2101,10 +2122,10 @@

- TFrame is a TCustomFrame descendant which implements a named container for related components. Groups of controls can be place on a frame, and re-used in your applications. + TFrame is a TCustomFrame descendant which implements a named container for related components. Groups of controls can be place on a frame, and re-used in your applications.

- A Frame has behavior very similar to a Form. Their unique ability is that they can be embedded into forms or other frames in the designer. Like forms, they are stored in two separate files: the code is stored in a .pas unit file, and the design is stored in a .lfm file. + A Frame has behavior very similar to a Form. Their unique ability is that they can be embedded into forms or other frames in the designer. Like forms, they are stored in two separate files: the code is stored in a .pas unit file, and the design is stored in a .lfm file.

Frames can be created and designed in the Lazarus IDE by creating a new Frame module, and using the unit in your application. An existing frame can be added using the TFrame component on the Standard tab in the Lazarus IDE; you will be prompted for the TFrame class to use for the component. @@ -2257,11 +2278,15 @@

dmPrimary
On the primary monitor
dmMainForm
-
On the same monitor as the main form; if there is no main form then use - dmPrimary behavior
+
+ On the same monitor as the main form; if there is no main form then use + dmPrimary behavior +
dmActiveForm
-
On the same monitor as the currently active form; if there is no active form - then use dmMainForm behavior
+
+ On the same monitor as the currently active form; if there is no active form + then use dmMainForm behavior +
@@ -2479,7 +2504,7 @@ The form that received an Close request. - Set to False to deny closing. + Set to False to deny closing. @@ -2520,7 +2545,7 @@ - Indicates if the help request is satisfied by the event handler; False causes the default help handler for the application to be used. + Indicates if the help request is satisfied by the event handler; False causes the default help handler for the application to be used. @@ -2530,7 +2555,7 @@ Context data for the help request. - False suppresses help display. + False suppresses help display. @@ -2546,7 +2571,7 @@ The key event message. - Set Handled to True to prevent further processing of the key. + Set Handled to True to prevent further processing of the key. @@ -2704,7 +2729,7 @@ - True when the value for the various properties should be included in the LCL streaming mechanism. + True when the value for the various properties should be included in the LCL streaming mechanism. @@ -2765,7 +2790,7 @@ DelayedEvent discards duplicate calls to the method; only the most recent message is processed. It is used in conjunction with the QueueAsyncCall method in TApplication. DelayedEvent decrements an internal counter used to track the number of pending delayed event messages. When the counter reaches zero (0), the message is applied.

- When WindowState is changed to wsNormal, the window origin or size is restored. For delayed OnChangeBounds and OnChangeBounds messages, the DoOnShow and/or Activate methods are called when the form is Active. If the form has not already been displayed and activated, the DoOnResize or the DoOnChangeBounds method is called for the corresponding delayed message. + When WindowState is changed to wsNormal, the window origin or size is restored. For delayed OnChangeBounds and OnChangeBounds messages, the DoOnShow and/or Activate methods are called when the form is Active. If the form has not already been displayed and activated, the DoOnResize or the DoOnChangeBounds method is called for the corresponding delayed message.

@@ -2929,7 +2954,7 @@

- Raises a catchable exception if the Code property has not been assigned for the TMethod instance in Handler. Raised with the message 'TCustomForm.AddHandler'. + Raises a catchable exception if the Code property has not been assigned for the TMethod instance in Handler. Raised with the message 'TCustomForm.AddHandler'.

@@ -3013,7 +3038,7 @@ When the form has a Parent control, or has been configured as a MDI Child form (FormStyle is fsMDIChild).
  • - The form has not been made visible (Showing is False). + The form has not been made visible (Showing is False).
    • @@ -3024,7 +3049,7 @@ Handles the LM_ACTIVATE message which activates or deactivates the form.

    - Calls SetActive to update the value in the Active property to reflect the value for the Active member in Message. + Calls SetActive to update the value in the Active property to reflect the value for the Active member in Message.

    When the form is being de-activated, the Deactivate method in Application is called. Otherwise, the Activate method in Application is called. The UpdateShowInTaskBar method is called ShowInTaskBar to determine the effective visibility for the form in the task bar. @@ -3142,7 +3167,7 @@ Handles the CM_PARENTBIDIMODECHANGED control message for the form.

    - Sets the BidiMode property to the value in Parent when ParentBiDiMode is True and Parent has been assigned. When Parent has not been assigned, the BiDiMode property in Application is copied to the form instance. + Sets the BidiMode property to the value in Parent when ParentBiDiMode is True and Parent has been assigned. When Parent has not been assigned, the BiDiMode property in Application is copied to the form instance.

    @@ -3310,7 +3335,7 @@ Notifies the OnActivate event handler.

    - Activate is a procedure used to signal the OnActivate event handler (if assigned) when the form is activated. Activate is called when the CM_Activate message is handled for the form. + Activate is a procedure used to signal the OnActivate event handler (if assigned) when the form is activated. Activate is called when the CM_Activate message is handled for the form.

    Activate uses an internal member to determine whether the form is being displayed for the first time, or following a change of focus between forms. No actions are performed in the method when the form is being displayed for the first time and the WindowState property contains wsMaximized or wsFullScreen. @@ -3334,7 +3359,9 @@ An empty implementation in TCustomForm. - Can be implemented in a descendant to perform actions needed when the active form is changed. Just like Delphi VCL. +

    + Can be implemented in a descendant to perform actions needed when the active form is changed. Just like Delphi VCL. +

    @@ -3381,7 +3408,7 @@     - True when Color has value other than clDefault or clBtnFace. + True when Color has value other than clDefault or clBtnFace. @@ -3542,7 +3569,9 @@ Unlocks form updates; used with BeginFormUpdate. - When the update counter reaches zero, FormEndUpdated is invoked to realize the pending changes. +

    + When the update counter reaches zero, FormEndUpdated is invoked to realize the pending changes. +

    @@ -3556,7 +3585,7 @@

    - HandleCreateException is a Boolean function which indicates if an exception raised in the OnCreate event handler is handled in the form instance. The return value is True when the Application.CaptureExceptions property is set to True; the HandleException method in Application is called to notify its exception handlers of the exception. When the return value is False, the exception is re-raised in the caller. + HandleCreateException is a Boolean function which indicates if an exception raised in the OnCreate event handler is handled in the form instance. The return value is True when the Application.CaptureExceptions property is set to True; the HandleException method in Application is called to notify its exception handlers of the exception. When the return value is False, the exception is re-raised in the caller.

    HandleCreateException is called from the DoCreate method. @@ -3568,12 +3597,16 @@ - True when the exception is handled by the application. + True when the exception is handled by the application. Placeholder for exception handlers in derived classes. - By default the Application exception handler is invoked. + +

    + By default the Application exception handler is invoked. +

    +     @@ -3581,18 +3614,22 @@     - True when the exception was handled. + True when the exception was handled. Placeholder for exception handlers in derived classes. - By default the Application exception handler is invoked. + +

    + By default the Application exception handler is invoked. +

    +     - True when the exception was handled. + True when the exception was handled. @@ -3612,7 +3649,7 @@ Loaded is an overridden method in TCustomForm.

    - It disables alignment in the form, and adjusts the PixelsPerInch setting for the Font when it differs from the design-time setting. It is performed when Scaled is enabled for the form and the Application. This action is also performed for any child Controls. Calls the inherited Loaded method, and re-enables alignment for the form instance. + It disables alignment in the form, and adjusts the PixelsPerInch setting for the Font when it differs from the design-time setting. It is performed when Scaled is enabled for the form and the Application. This action is also performed for any child Controls. Calls the inherited Loaded method, and re-enables alignment for the form instance.

    Ensures that the ActiveControl (when assigned) can receive focus. ActiveControl is set to Nil if the control cannot be focused for the form instance. Sets the Visible property to True when FormState contains the value fsVisible. @@ -3630,7 +3667,7 @@

    - ChildHandlesCreated is called after all handles for child controls are created. When this is a top-level form (Parent is Nil), the ParentFormHandleInitialized method is also called. + ChildHandlesCreated is called after all handles for child controls are created. When this is a top-level form (Parent is Nil), the ParentFormHandleInitialized method is also called.

    @@ -3701,10 +3738,12 @@

    wsMinimized
    -
    Calls the Minimize method in Application, or Restore if the Form is already minimized
    +
    + Calls the Minimize method in Application, or Restore if the Form is already minimized. +

    - If the value in WindowState has been changed, the method honors the value in the Position property if it was set to maximized at design-time. When the OnWindowStateChange event handler has been assigned for the form, it is signalled for the current class instance. + If the value in WindowState has been changed, the method honors the value in the Position property if it was set to maximized at design-time. When the OnWindowStateChange event handler has been assigned for the form, it is signalled for the current class instance.

    @@ -3738,13 +3777,17 @@     - Performs a delayed resize action using the DelayedEvent for the control. + + Performs a delayed resize action using the DelayedEvent for the control. + - Performs a delayed bounds change using the DelayedEvent for the control. + + Performs a delayed bounds change using the DelayedEvent for the control. + @@ -3755,7 +3798,7 @@     - True for BringToFront. + True for BringToFront. @@ -3790,7 +3833,7 @@ MoveToDefaultPosition is a method used to move a form instance to the location specified in its Position property. It ensures that the form appears on the correct monitor for the values in the DefaultMonitor and Position properties.

    - DefaultMonitor is used to determine whether the form needs to be moved to a different monitor for the value in Position. For instance: + DefaultMonitor is used to determine whether the form needs to be moved to a different monitor for the value in Position. For instance:

    dmDesktop
    @@ -3816,7 +3859,7 @@
    poOwnerFormCenter
    - Uses the Owner form to center align the relocated form instance. If the Owner is not a TCustomForm instance, Position is converted to poMainFormCenter to center the form to the MainForm in the application. + Uses the Owner form to center align the relocated form instance. If the Owner is not a TCustomForm instance, Position is converted to poMainFormCenter to center the form to the MainForm in the application.
    poMainFormCenter
    @@ -3877,7 +3920,7 @@ UpdateShowing calls the inherited method to update the Handle for the form and the visibility for any child Controls.

    - If ActiveControl is not assigned, and there is no Parent form, the FindDefaultForActiveControl method is called to locate the first visible and enabled child control on the form. Its Handle is used to focus the control using the LCL SetFocus routine. + If ActiveControl is not assigned, and there is no Parent form, the FindDefaultForActiveControl method is called to locate the first visible and enabled child control on the form. Its Handle is used to focus the control using the LCL SetFocus routine.

    Finally, the visibility of the form in the task bar is updated and passed to the widgetset class. @@ -3936,7 +3979,7 @@ Calls CallNotifyEvents in the internal method list for any methods using the fhtFirstShow handler type. The form instance is passed as an argument to the handler(s).

    - Called from the UpdateShowing method when the form is Visible and its Showing property is changed to True. Occurs after MoveToDefaultPosition has been to called to position the form on its monitor, and after the value fsFirstShow has been included in the FormState property. + Called from the UpdateShowing method when the form is Visible and its Showing property is changed to True. Occurs after MoveToDefaultPosition has been to called to position the form on its monitor, and after the value fsFirstShow has been included in the FormState property.

    @@ -3964,7 +4007,7 @@ Notifies all VisibleChanging handlers.

    - Calls the inherited method prior to exit. Called prior to setting the new value for the Visible property in a control (or form) in the SetVisible method. + Calls the inherited method prior to exit. Called prior to setting the new value for the Visible property in a control (or form) in the SetVisible method.

    @@ -3973,13 +4016,15 @@ - Notifies all handlers when the visibility for the form has been changed. + + Notifies all handlers when the visibility for the form has been changed. +

    Calls the inherited method on entry.

    - When the Screen singleton has been assigned, its NotifyScreenFormHandler method is called to signal all snFormVisibleChanged handlers in the class instance. + When the Screen singleton has been assigned, its NotifyScreenFormHandler method is called to signal all snFormVisibleChanged handlers in the class instance.

    Called after a new value has been assigned to the Visible property for the control (or form). @@ -4040,7 +4085,7 @@ - True when the Visible property is set to True. + True when the Visible property is set to True. @@ -4142,7 +4187,9 @@ Loads resources needed for the form. - Calls InitResourceComponent to load resources for the current form instance. +

    + Calls InitResourceComponent to load resources for the current form instance. +

    Raises an EResNotFound exception if RequireDerivedFormResource is set for the application, and a resource is not found for the form. @@ -4154,7 +4201,7 @@ Re-implements the auto-drag behavior for forms.

    - BeginAutoDrag is an overridden method in TCustomForm which re-implements the auto-drag and dock behavior for form instances. It allows form dragging only if it is docked (HostDockSite is assigned) to a site where a DockManager is not used (UseDockManager is False). It does not call the inherited method. + BeginAutoDrag is an overridden method in TCustomForm which re-implements the auto-drag and dock behavior for form instances. It allows form dragging only if it is docked (HostDockSite is assigned) to a site where a DockManager is not used (UseDockManager is False). It does not call the inherited method.

    @@ -4173,7 +4220,7 @@ ARect contains the bounds for the new dock site after resizing and alignment (when needed).

    - When a form is docked, its BorderStyle is set to bsNone. DoDock ensures that the value in the BorderStyle property is saved or restored for the form when the value in HostDockSite is changed. If NewDockSite has been assigned, the value in BorderStyle is saved to an internal member. If NewDockSite is Nil, the value in BorderStyle is restored from the internal member. + When a form is docked, its BorderStyle is set to bsNone. DoDock ensures that the value in the BorderStyle property is saved or restored for the form when the value in HostDockSite is changed. If NewDockSite has been assigned, the value in BorderStyle is saved to an internal member. If NewDockSite is Nil, the value in BorderStyle is restored from the internal member.

    Changes needed for the Align property must be handled in the DockManager. @@ -4267,7 +4314,7 @@     - True when the action was handled. + True when the action was handled. Action to execute. @@ -4281,7 +4328,7 @@     - True when the action was updated. + True when the action was updated. @@ -4291,7 +4338,7 @@ Asks all components on the form to update their actions.

    - UpdateActions is a procedure used to update actions assigned to components on the form instance. No actions are performed in the method at design-time, or when the Showing property is set to False in the form instance. + UpdateActions is a procedure used to update actions assigned to components on the form instance. No actions are performed in the method at design-time, or when the Showing property is set to False in the form instance.

    UpdateActions applies updates for an assigned Menu in the form instance. Items on the Menu update their actions when the menu item is visible. Finally, all controls on the form instance are recursively searched; controls which are action clients update their actions when they are visible. @@ -4344,10 +4391,10 @@

    • Sets the FormState to fsFirstShow and calls BeginFormUpdate.
    • Sets the default BorderIcons for the form.
      • -
    • Sets the FormStyle, ControlsStyle, and BorderStyle for the form.
      • +
    • Sets the FormStyle, ControlsStyle, and BorderStyle for the form.
    • Calls the inherited Create constructor.
    • Sets the default bounds for the form instance.
      • -
    • Sets Visible to False.
      • +
    • Sets Visible to False.
    • Sets WindowState to wsNormal.
    • Allocates resources for the Icon property but does not assign a bitmap.
    • Sets the default value for Color.
      • @@ -4470,7 +4517,7 @@ The control which will lose focus. - True if the control is no longer the ActiveControl. + True if the control is no longer the ActiveControl. @@ -4483,7 +4530,7 @@ - Bring the form to front if True. + Bring the form to front if True. @@ -4521,7 +4568,7 @@ - Returns True when the internal update counter for the form contains a positive + Returns True when the internal update counter for the form contains a positive non-zero value. @@ -4533,7 +4580,7 @@ GetFormImage is a TBitmap function used to get a bitmap image with the contents for the form instance. The return value must be managed by the caller to ensure that the image is freed.

      - GetFormImage sets the size for the TBitmap instance to the values in the ClientWidth and ClientHeight properties. The GetWindowRect routine in lclintf is called to get the display rectangle for the form Handle. The PaintTo method is called to draw the rectangle to the Canvas in the bitmap. + GetFormImage sets the size for the TBitmap instance to the values in the ClientWidth and ClientHeight properties. The GetWindowRect routine in lclintf is called to get the display rectangle for the form Handle. The PaintTo method is called to draw the rectangle to the Canvas in the bitmap.

      The return value can be Nil if an Exception was raised and handled in the method. @@ -4618,7 +4665,7 @@ - True when the specified Key was handled as a shortcut. + True when the specified Key was handled as a shortcut. Control message examined in the method. @@ -4637,7 +4684,7 @@ UseWorkarea indicates whether the work area for the target monitor is used. When set to True, the form uses the bounds established for the work area instead of the physical monitor. The default value for the parameter is True.

      - The default value for UseWorkArea was changed from False to True in LCL version 2.3.0. This is the more sensible default value, and it is also Delphi-compatible. + The default value for UseWorkArea was changed from False to True in LCL version 2.3.0. This is the more sensible default value, and it is also Delphi-compatible. @@ -4649,13 +4696,13 @@ - When True the form is adjusted to the bounds for the WorkArea for the monitor. Otherwise, the form is clipped to the monitor bounds. + When True the form is adjusted to the bounds for the WorkArea for the monitor. Otherwise, the form is clipped to the monitor bounds. - Returns True if an auto-size action should be skipped when a form handle is not available. + Returns True if an auto-size action should be skipped when a form handle is not available.

      @@ -4675,7 +4722,7 @@ - True if an auto-size action should be skipped when a form handle is not available. + True if an auto-size action should be skipped when a form handle is not available. @@ -4711,7 +4758,7 @@ - True when the form can receive focus. + True when the form can receive focus.

      CanFocus is an overridden Boolean function which indicates if the form instance can receive focus. The return value is True when the form is Visible and Enabled, or the inherited CanFocus method returns True. @@ -4724,7 +4771,7 @@ - True when the form can receive focus in the application. + True when the form can receive focus in the application. @@ -4735,7 +4782,7 @@ - False when the focused control cannot be changed. + False when the focused control cannot be changed. The control with focus on the form. @@ -4770,7 +4817,7 @@ - True if the form is moved to the monitor and location in the Position property. + True if the form is moved to the monitor and location in the Position property. @@ -4870,7 +4917,7 @@ - Returns False in TCustomForm. + Returns False in TCustomForm. Control with the key message for the method. @@ -5069,7 +5116,7 @@ - Sets scaled to True and calls AutoAdjustLayout with the current PPI for the monitor. + Sets scaled to True and calls AutoAdjustLayout with the current PPI for the monitor.

      @@ -5120,7 +5167,7 @@ Exclude contains a control which is omitted from the Caption values (when assigned). UpdateDockCaption iterates over the controls in DockClients to build the combined Caption for visible controls (other than the control in Exclude). Blank control captions are ignored. UTF8FixBroken is called to ensure that a given caption does not contain invalid UTF-8 characters. The caption for a TMemo control is truncated after 20 characters.

      - The Caption values for the controls are concatenated into a comma-delimited list of values which are assigned to the Caption property. An empty string is never assigned to the Caption property. + The Caption values for the controls are concatenated into a comma-delimited list of values which are assigned to the Caption property. An empty string is never assigned to the Caption property.

      UpdateDockCaption is called when a new value is assigned to the Text property for a DockClient control with an assigned HostDockSite. @@ -5164,7 +5211,7 @@

      • The current form instance.
      • A control not parented by the current form instance.
        • -
      • A control that returns False from its CanFocus method.
        • +
      • A control that returns False from its CanFocus method.

      The SetWindowFocus method is called if the form is Active, and the ActiveChanged method is called. @@ -5211,7 +5258,7 @@ Use AlphaBlendValue to specify the degree of transparency and diffusion applied to the form content.

      - Changing the value in AlphaBlend causes the widgetset class to be notified of the change at run-time when a handle has been allocated for the form instance. A change to the property value is not rendered at design-time. + Changing the value in AlphaBlend causes the widgetset class to be notified of the change at run-time when a handle has been allocated for the form instance. A change to the property value is not rendered at design-time.

      AlphaBlend and AlphaBlendValue are used in the implementation of the InitializeWnd method, and passed as arguments to methods in the widgetset class when either of the values are changed. @@ -5257,7 +5304,7 @@ Indicates if the form can automatically show or hide scroll bars.

      - AutoScroll is a Boolean property which indicates if the form can automatically show or hide its scroll bars. Set AutoScroll to True to enable scroll bars when the form size is too small to display its content in its entirety. AutoScroll can only be True when the BorderStyle for the form is bsSizeable or bsSizeToolWin, and may be changed to False at run-time when BorderStyle is changed to another value. + AutoScroll is a Boolean property which indicates if the form can automatically show or hide its scroll bars. Set AutoScroll to True to enable scroll bars when the form size is too small to display its content in its entirety. AutoScroll can only be True when the BorderStyle for the form is bsSizeable or bsSizeToolWin, and may be changed to False at run-time when BorderStyle is changed to another value.

      @@ -5345,7 +5392,9 @@ The background color for the form. - Color is a TColor property with the background color used for the form. Color is re-declared in TCustomForm to use either clDefault or clBtnFace as the default value for the property. clDefault is used when the UseCLDefault compiler define exists, and indicates that the color is resolved to the value in a Parent control (when assigned). +

      + Color is a TColor property with the background color used for the form. Color is re-declared in TCustomForm to use either clDefault or clBtnFace as the default value for the property. clDefault is used when the UseCLDefault compiler define exists, and indicates that the color is resolved to the value in a Parent control (when assigned). +

      TControl.Color @@ -5506,7 +5555,7 @@ MDIChildren is a read-only indexed TCustomForm property which provides access to the child forms in a Multi-Document Interface (MDI) application. In an MDI application, one of the forms acts as the main form for the application, and is the container for its MDI child forms. In addition, an MDI child form can be nested in another MDI child form.

      - Historically, support for MDI is dependent on the underlying widgetset or platform. Some widgetsets provide better support for MDI than others. The consensus is that the QT/QT5 widgetsets offers the best level of support for MDI applications. + Historically, support for MDI is dependent on the underlying widgetset or platform. Some widgetsets provide better support for MDI than others. The consensus is that the QT/QT5 widgetsets offers the best level of support for MDI applications.

      The form role is determined by the value in the FormStyle property. fsMDIForm is used for the main form, and fsMDIChild for the child forms. MDIChildren is relevant when the current form instance uses one of these MDI form style values. @@ -5596,7 +5645,7 @@

    poMainFormCenter
    - Uses the monitor in TApplication.MainForm when the form is not the main form for the application. If it is the main form, the value in DefaultMonitor is used as the monitor where the form is located. + Uses the monitor in TApplication.MainForm when the form is not the main form for the application. If it is the main form, the value in DefaultMonitor is used as the monitor where the form is located.
    poOwnerFormCenter
    @@ -5885,7 +5934,7 @@ OnShortcut is a TShortcutEvent property that represents the event handler signalled (when assigned) to detect and handle a shortcut key for the form instance. OnShortcut is called from the IsShortcut method used to examine keystroke events intercepted and forwarded by the Application.

    - The Msg argument contains the key event examined in the handler. Handled indicates that the key is handled by the event when set to True. + The Msg argument contains the key event examined in the handler. Handled indicates that the key is handled by the event when set to True.

    @@ -5953,11 +6002,11 @@

    - If true, the Font will be the same as the one from the Parent. + If True, the Font will be the same as the one from the Parent. The default value for the property is False in TCustomForm.

    - While ParentFont is True, all changes to the font in the parent will also be applied to the font for the control. This synchronizes them, keeping them set to the same values. If changes are made directly to the Font property in the control, then ParentFont is automatically be set to False. + While ParentFont is True, all changes to the font in the parent will also be applied to the font for the control. This synchronizes them, keeping them set to the same values. If changes are made directly to the Font property in the control, then ParentFont is automatically be set to False.

    @@ -6007,7 +6056,7 @@

    - RestoredTop is a read-only Integer property which contains the top coordinate for the form when its size is altered in WMSize or WMMove message handlers. The property value is applied when the asynchronous queued event handler for the form is executed, and calls the DoOnChangeBounds method. + RestoredTop is a read-only Integer property which contains the top coordinate for the form when its size is altered in WMSize or WMMove message handlers. The property value is applied when the asynchronous queued event handler for the form is executed, and calls the DoOnChangeBounds method.

    @@ -6071,7 +6120,7 @@

    - Re-declared in TCustomForm to use a different storage specifier than the ancestor class. In TCustomForm, visibility is not tied to an Action or an ActionLink; it uses the value in the Visible property. + Re-declared in TCustomForm to use a different storage specifier than the ancestor class. In TCustomForm, visibility is not tied to an Action or an ActionLink; it uses the value in the Visible property.

    @@ -6139,7 +6188,9 @@ Creates an association between the class type and its widgetset class. - WSRegisterClass is an overridden class procedure used to register the widgetset class used to create new instances of the form. +

    + WSRegisterClass is an overridden class procedure used to register the widgetset class used to create new instances of the form. +

    TCustomForm.WSRegisterClass @@ -6413,7 +6464,7 @@ AForm.SessionProperties := 'Top;Left;WindowState;Image1.Visible;Image1.Transpare

    - DoAddDockClient is an overridden method used to add the control in Client to the docked form. It calls the inherited method on entry to set the Parent in Client to the current class instance. It sets the Align property in Client to alAlign to align the control to the bounds for the docked form. Values in the BorderSpacing property in Client are reset to 0; the current class instance provides the BorderSpacing values for the docked control. At run-time, the Visible property is set to True to display the docked form after the Client has been added. + DoAddDockClient is an overridden method used to add the control in Client to the docked form. It calls the inherited method on entry to set the Parent in Client to the current class instance. It sets the Align property in Client to alAlign to align the control to the bounds for the docked form. Values in the BorderSpacing property in Client are reset to 0; the current class instance provides the BorderSpacing values for the docked control. At run-time, the Visible property is set to True to display the docked form after the Client has been added.

    @@ -6512,7 +6563,7 @@ AForm.SessionProperties := 'Top;Left;WindowState;Image1.Visible;Image1.Transpare

    - Use BorderStyle to get or set the appearance of the form's border. The default value in TCustomDockForm is bsSizeToolWin. + Use BorderStyle to get or set the appearance of the form's border. The default value in TCustomDockForm is bsSizeToolWin.

    This property is slightly different (has a different base type) from the TCustomControl.BorderStyle property. When the form is put into another control the window borders depend on the widgetset. There are no borders under GTK. @@ -6562,7 +6613,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True during ActivateHint. + True during ActivateHint. @@ -6738,7 +6789,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True when ThemeServices are used for the background. + True when ThemeServices are used for the background. @@ -6754,7 +6805,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True when ThemeServices are used to draw the foreground for the hint window. + True when ThemeServices are used to draw the foreground for the hint window. @@ -6820,7 +6871,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');

    HideInterval
    Set to 3000 milliseconds (3 seconds)
    AutoHide
    -
    Set to False
    +
    Set to False

    Create uses the default size from the class type for the control to set the initial bounds for the hint window. @@ -6878,7 +6929,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');

    - ActivateHintData is an extended version of ActivateHint. It provides the additional AData argument which contains a pointer to values which can be used to construct the text displayed in the hint window. + ActivateHintData is an extended version of ActivateHint. It provides the additional AData argument which contains a pointer to values which can be used to construct the text displayed in the hint window.

    The implementation in THintWindow does not use the values in AData. The method must be overridden in a descendent class to use the additional hint data in AData. @@ -6930,7 +6981,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True when the hint rectangle was successfully moved by the specified amounts. + True when the hint rectangle was successfully moved by the specified amounts. @@ -6970,7 +7021,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the message is used for hint windows, False for all other messages. + True if the message is used for hint windows, False for all other messages. @@ -7072,7 +7123,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Does the hint disappear (get hidden) after a while?

    - If AutoHide is TRUE, the hint disappears after an interval specified by HideInterval. + If AutoHide is True, the hint disappears after an interval specified by HideInterval.

    @@ -7160,7 +7211,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True when monitor information was successfully retrieved. + True when monitor information was successfully retrieved. TMonitorInfo with values retrieved for the OS or platform. @@ -7987,7 +8038,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); SetFocusedForm sends a CM_DEACTIVATE message to the form instance in FocusedForm (when assigned).

    - The return value indicates if the focus state has changed during form deactivation, and may return False if deactivation failed. FocusedForm is set to Nil if deactivation failed. + The return value indicates if the focus state has changed during form deactivation, and may return False if deactivation failed. FocusedForm is set to Nil if deactivation failed.

    Otherwise, AForm is saved to the FocusedForm property and a CM_ACTIVATE message is performed. The return value is False if the activation failed. @@ -8003,7 +8054,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - False if activation or deactivation fails. True on success or when no action is needed. + False if activation or deactivation fails. True on success or when no action is needed. @@ -8132,7 +8183,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); AddHandler is a procedure used to add a screen notification handler to the list of handlers in the TScreen instance.

    - HandlerType is a TScreenNotification enumeration value that defines the situation(s) where the screen handler can be executed. See TScreenNotification for more information about values in the enumeration. + HandlerType is a TScreenNotification enumeration value that defines the situation(s) where the screen handler can be executed. See TScreenNotification for more information about values in the enumeration.

    Handler is a TMethod record with pointers to the code and optional data executed when the handler is invoked. @@ -8370,9 +8421,9 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Constructor for the class instance. -

    +

    Create is the overridden constructor for the class instance, and calls the inherited method on entry. -

    +

    Create allocates resources needed for properties, including: Fonts, Monitors, CustomForms, CustomFormsZOrdered, and DataModules. Resources for internal members are also allocated.

    @@ -8476,7 +8527,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); MoveFormToFocusFront is a method used to move the form specified in ACustomForm to the top of the Z-order. This means that it appears on top of all other visible forms for the application.

    - MoveFormToFocusFront is called when the focused control is changed in the TCustomForm instance. It is also called from the ShowModal method in TCustomForm. + MoveFormToFocusFront is called when the focused control is changed in the TCustomForm instance. It is also called from the ShowModal method in TCustomForm.

    It ensures that ACustomForm is moved to the first position in CustomForms (the top of the Z-order). When ACustomForm is a TForm instance, it is also moved to the first position in the Forms property. Calls MoveFormToZFront to ensure that the form is moved to the first position in the CustomFormsZOrdered property. @@ -8563,7 +8614,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the form is used on the screen. + True if the form is used on the screen. Form instance to locate in the Z-ordered forms for the screen. @@ -8720,7 +8771,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True when OnFormAdded should be the first entry in the list of handlers for the type. + True when OnFormAdded should be the first entry in the list of handlers for the type. @@ -8745,7 +8796,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Form remove handler added in the method. - True if the handler should be stored as the first routine for the type. + True if the handler should be stored as the first routine for the type. @@ -8769,7 +8820,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the handler should be the first in the list for the type. + True if the handler should be the first in the list for the type. @@ -8792,7 +8843,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the handler should be the first in the list for the type. + True if the handler should be the first in the list for the type. @@ -8815,7 +8866,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the handler should be the first in the list for the type. + True if the handler should be the first in the list for the type. @@ -8949,7 +9000,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); MonitorFromWindow is a TMonitor function used to locate monitor where the form represented by the specified window Handle is displayed.

    - MonitorDefault is a TMonitorDefaultTo enumeration value which indicates the monitor used when the display area for the form is not found on a monitor. See TMonitorDefaultTo for more information about the values in the enumeration and their meanings. + MonitorDefault is a TMonitorDefaultTo enumeration value which indicates the monitor used when the display area for the form is not found on a monitor. See TMonitorDefaultTo for more information about the values in the enumeration and their meanings.

    MonitorFromWindow calls MonitorFromWindow in the widgetset class to get a monitor handle used to locate the monitor in the Monitors property. The UpdatedMonitor method is called to ensure that Monitors contains up-to-date values for the available monitors. @@ -9116,7 +9167,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); The TCustomForm instance which has the focus.

    - ActiveCustomForm is a read-only TCustomForm property which contains the active custom form instance which has focus on the screen. The property value is updated in TCustomForm methods like SetFocusedControl and MoveToDefaultPosition. It is also updated in TApplication methods like ControlDestroyed. + ActiveCustomForm is a read-only TCustomForm property which contains the active custom form instance which has focus on the screen. The property value is updated in TCustomForm methods like SetFocusedControl and MoveToDefaultPosition. It is also updated in TApplication methods like ControlDestroyed.

    Use ActiveForm to get the TForm instance that has focus on the screen. @@ -9176,7 +9227,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); RealCursor is a read-only TCursor property which provides the current shape for the cursor taking temporary cursors into account.

    - Temporary cursors are added and removed using the BeginTempCursor and EndTempCursor methods. When a temporary cursor exists, RealCursor returns the most recent cursor shape added to the internal list using BeginTempCursor. If the internal list is empty, the value in Cursor is returned as the property value. + Temporary cursors are added and removed using the BeginTempCursor and EndTempCursor methods. When a temporary cursor exists, RealCursor returns the most recent cursor shape added to the internal list using BeginTempCursor. If the internal list is empty, the value in Cursor is returned as the property value.

    The value from RealCursor is used in the SetCursor method to determine the value stored in the Cursor property, and passed as an argument to SetCursor in the widgetset class. @@ -9634,7 +9685,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); PrimaryMonitor is a read-only TMonitor property with the primary monitor for the system. The property value is determined by checking for the TMonitor instance in Monitors with its Primary property set to True. The property value is Nil if a monitor is not found with its Primary property set to True.

    - The property value is used in the MoveToDefaultPosition method in TCustomForm. It is also used in widgetset classes to select the monitor for a dialog when the main form for an application has not been assigned. + The property value is used in the MoveToDefaultPosition method in TCustomForm. It is also used in widgetset classes to select the monitor for a dialog when the main form for an application has not been assigned.

    @@ -9788,7 +9839,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');     - Set Cancel to True to prevent the session from ending. + Set Cancel to True to prevent the session from ending. @@ -9848,7 +9899,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Done is a variable Boolean parameter which indicates if the event handler has finished processing. When set to False, subsequent idle event handlers can be called. When set to True, the idle state processing has been completed.

    - TIdleEvent is the type used for the OnIdle event handler in TApplication. The event handler is signalled when the application becomes idle. The event handler can return False in Done to allow other idle event handlers to be signalled. The idle event handlers are called repeatedly until Done is set to True. + TIdleEvent is the type used for the OnIdle event handler in TApplication. The event handler is signalled when the application becomes idle. The event handler can return False in Done to allow other idle event handlers to be signalled. The idle event handlers are called repeatedly until Done is set to True.

    Use the TIdleEvent event handler type to provide short duration event handlers which ensure that the application remains responsive. @@ -9860,7 +9911,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Object for the event notification. - Set to True when processing is done. + Set to True when processing is done. @@ -9997,7 +10048,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Text for hint display event. - True if the hint can be displayed. + True if the hint can be displayed. Hint info structure for the hint. @@ -10260,7 +10311,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Management information for asynchronous callbacks.

    - Two queues are used in TAsyncCallQueues. New calls are added to the Next queue. Cur contains the callbacks currently being processed in the queue. + Two queues are used in TAsyncCallQueues. New calls are added to the Next queue. Cur contains the callbacks currently being processed in the queue.

    When the application starts processing the calls, the Next queue becomes the Cur queue, and a new Next queue is created. This simplifies thread-safe addition in subsequent calls. @@ -10391,7 +10442,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - Widgetset dependent. For Windows, it is True unless in a remote desktop connection. For other widgetsets it is False. + Widgetset dependent. For Windows, it is True unless in a remote desktop connection. For other widgetsets it is False. @@ -10572,7 +10623,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); GetCurrentHelpFile is a String function used to get the help file name for the active form or application.

    - GetCurrentHelpFile checks for an active form in the Screen singleton. If a form is active, the file name in its HelpFile property is used as the return value. If a form is not active, the HelpFile in the Application instance is used. + GetCurrentHelpFile checks for an active form in the Screen singleton. If a form is active, the file name in its HelpFile property is used as the return value. If a form is not active, the HelpFile in the Application instance is used.

    @@ -10825,7 +10876,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');     - True when HelpManager is not Nil. + True when HelpManager is not Nil. @@ -10840,7 +10891,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True when the action was handled. + True when the action was handled. @@ -10985,16 +11036,16 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True when called from the widgetset. + True when called from the widgetset. - Always returns False for a GUI application. + Always returns False for a GUI application. - False for a GUI application. + False for a GUI application. @@ -11007,7 +11058,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); The internal array of handlers is checked for a TMethodList which uses the application handler type. If it exists, each of the methods in the list are signalled, in reverse order, using the value in Done as a control flag. While Done is True, the handlers are continuously called in the loop. If any handler in the list sets Done to False, the method is exited.

    - NotifyIdleHandler is called from the Idle method. It occurs after the ReleaseComponents and ProcessAsyncCallQueue methods have been called. It is also called after the OnIdle event handler in the TApplication has been signalled (when assigned) and when the Done argument to the event handler is True. + NotifyIdleHandler is called from the Idle method. It occurs after the ReleaseComponents and ProcessAsyncCallQueue methods have been called. It is also called after the OnIdle event handler in the TApplication has been signalled (when assigned) and when the Done argument to the event handler is True.

    @@ -11044,7 +11095,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Notifies all Activate handlers for the application.

    - NotifyActivateHandler signals the OnActivate event handler (when assigned) using the TApplication instance as the Sender for the notification event. The CallNotifyEvents method in the TMethodList is called to signal each of the routines for the handler type. + NotifyActivateHandler signals the OnActivate event handler (when assigned) using the TApplication instance as the Sender for the notification event. The CallNotifyEvents method in the TMethodList is called to signal each of the routines for the handler type.

    NotifyActivateHandler is called when an application is initially executed, and when focus is acquired from a different application. @@ -11063,7 +11114,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); NotifyDeactivateHandler is a method used to signal all of the deactivate handlers for the application. OnDeactivate is signalled (when assigned) using the application instance as an argument.

    - CallNotifyEvents is executed for each of the handlers in the TMethodList for the ahtDeactivate notification type. Use AddOnDeactivateHandler and RemoveOnDeactivateHandler to maintain an additional handler for the notification type. + CallNotifyEvents is executed for each of the handlers in the TMethodList for the ahtDeactivate notification type. Use AddOnDeactivateHandler and RemoveOnDeactivateHandler to maintain an additional handler for the notification type.

    NotifyDeactivateHandler is called from the Deactivate method, and occurs when focus is changed to another application or the application is closed. @@ -11110,7 +11161,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - Always returns False. + Always returns False. Not used in the implementation. @@ -11134,7 +11185,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True when the message was handled. + True when the message was handled. @@ -11311,7 +11362,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Returns the command line argument at the specified position.

    - GetParams is an overridden String function in TApplication used to get the argument at the specified position in the command line. It re-implements the read access specifier for the property from the ancestor class, and does not call the inherited method. + GetParams is an overridden String function in TApplication used to get the argument at the specified position in the command line. It re-implements the read access specifier for the property from the ancestor class, and does not call the inherited method.

    Index is the ordinal position for the requested parameter value. Index must be in the range 0..ParamCount-1 or an EListError exception is raised. Position 0 contains the name of the executable file for the application. @@ -11370,7 +11421,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Hint display is cancelled and suppressed while the application is shutting down. The action component for the application is set to Nil to prevent execution of associated actions during shutdown.

    - Destroy frees resources allocated in the application instance, including the Icon and any Icon handles currently in use. Handlers added to application instance are also freed. + Destroy frees resources allocated in the application instance, including the Icon and any Icon handles currently in use. Handlers added to application instance are also freed.

    Destroy calls the inherited destructor, and discards any pending asynchronous calls not previously handled for the application instance. Exception handling is restored to the state on entry to the Create constructor. Finally, the Application class instance is set to Nil. @@ -11511,7 +11562,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); The method name is slightly misleading, and kept only for Delphi compatibility. The method can actually create any kind of component.

    - CreateForm creates a Component instance of the given class, and sets the pointer to the component variable. If it is a form, it will be added to the list of forms in the application. + CreateForm creates a Component instance of the given class, and sets the pointer to the component variable. If it is a form, it will be added to the list of forms in the application.

    A splash form is shown immediately. @@ -11554,7 +11605,11 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Inserts an asynchronous call into the queue. - This is thread safe. + +

    + This is thread safe. +

    +     Exceptions on various inconsistencies of the queue. @@ -11570,7 +11625,11 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Removes all calls added via QueueAsyncCall. - This is thread safe. + +

    + This is thread safe. +

    +     Exceptions on various inconsistencies of the queue. @@ -11618,7 +11677,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');     - True when the Action was handled in the event handler. + True when the Action was handled in the event handler. The Action to execute in the event handler. @@ -11639,7 +11698,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the action was updated in the event handler. + True if the action was updated in the event handler. The action updated in the event handler. @@ -11709,13 +11768,13 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); If the help context was handled in DoOnHelp, not additional actions are performed in the method. Otherwise, the ShowHelpOrErrorForContext is called to handle the help request.

    - The return value is False if the help context could not be handled using any of these options. + The return value is False if the help context could not be handled using any of these options.

    - True if the help request was handled in the method. + True if the help request was handled in the method. Help context displayed in the method. @@ -11756,7 +11815,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the Help Table of Contents was successfully displayed by the application. + True if the Help Table of Contents was successfully displayed by the application. @@ -11774,7 +11833,9 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Removes the StayOnTop attribute from all forms in the application. - Builds a list of forms for use in the RestoreStayOnTop method. +

    + Builds a list of forms for use in the RestoreStayOnTop method. +

    @@ -11799,7 +11860,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the application is waiting for a message event. + True if the application is waiting for a message event.

    The return value is True when AppWaiting has been included in the Flags for the application. @@ -11808,7 +11869,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the application is in AppWaiting state. + True if the application is in AppWaiting state. @@ -11827,7 +11888,11 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Called when the the mouse is over a control with a Hint. - Does nothing. + +

    + Does nothing. +

    +     @@ -11913,10 +11978,16 @@ HintWindow.ActivateHint(Rect, 'This is the hint');

    Several constants are declared in the LCLType unit.

    -

    Add (better: OR) an icon constant and a buttons constant. For example:

    +

    + Add (better: OR) an icon constant and a buttons constant. For example: +

    MB_ABORTRETRYIGNORE + MB_ICONQUESTION -

    Causes the application to display a query (?) icon in a box with three buttons: ABORT RETRY IGNORE.

    -

    Buttons can be one of:

    +

    + Causes the application to display a query (?) icon in a box with three buttons: ABORT RETRY IGNORE. +

    +

    + Buttons can be one of: +

    • MB_OK
    • MB_OKCANCEL
      • @@ -11925,7 +11996,9 @@ HintWindow.ActivateHint(Rect, 'This is the hint');
    • MB_YESNO
    • MB_RETRYCANCEL
    -

    The icon can be one of:

    +

    + The icon can be one of: +

    • MB_ICONHAND
    • MB_ICONQUESTION
      • @@ -11950,7 +12023,9 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Called when a modal form display is started. - Invokes all OnModalBegin handlers when entering Modal state. +

      + Invokes all OnModalBegin handlers when entering Modal state. +

      @@ -11960,7 +12035,9 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Called when a modal form is closed. - Invokes all OnModalEnd handlers when exiting Modal state. +

      + Invokes all OnModalEnd handlers when exiting Modal state. +

      @@ -12024,7 +12101,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); The DoIdleActions method is called to update the actions for Visible and Enabled forms, and to hide visible splash screen forms (FormStyle is fsSplash).

      - When the Wait argument is set to True, the AppWaitMessage method in the widgetset class is called to capture an message on the handles for the application. This action is not performed when Wait is False. + When the Wait argument is set to True, the AppWaitMessage method in the widgetset class is called to capture an message on the handles for the application. This action is not performed when Wait is False.

      Idle calls the DoOnIdleEnd method to signal the OnIdleEnd event handler and any application handlers using the ahtIdleEnd handler type. @@ -12872,7 +12949,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');

      - The return value is set to True if the key code in the message is handled by the application or one of the enabled forms or controls in the application. + The return value is set to True if the key code in the message is handled by the application or one of the enabled forms or controls in the application.

      IsShortCut signals the OnShortcut event handler (when assigned) to determine if the accelerator is handled at the application level. If it is handled in OnShortcut, no additional actions are performed in the method. @@ -12887,13 +12964,13 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Finally, the main form for the application is checked by calling its IsShortCut method.

      - The return value is False when the shortcut is not handled in any of the preceding calls to IsShortCut. + The return value is False when the shortcut is not handled in any of the preceding calls to IsShortCut.

      - True when the shortcut is handled. + True when the shortcut is handled. @@ -12982,7 +13059,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');

      - Calls GetFormatSettingsUTF8 or GetFormatSettings, depending on use of UTF-8 in the RTL, when UpdateFormatSettings is set to True. This applies to Windows platforms only. + Calls GetFormatSettingsUTF8 or GetFormatSettings, depending on use of UTF-8 in the RTL, when UpdateFormatSettings is set to True. This applies to Windows platforms only.

      @@ -13014,7 +13091,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');       - True when the language code uses right-to-left reading. + True when the language code uses right-to-left reading. ISO language code examined in the method. @@ -13093,7 +13170,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True if the application is focused. + True if the application is focused.

      Active is a read-only Boolean property which indicates if the application is focused. Returns True if the AppActive flag has been included in the Flags for the application. @@ -13140,7 +13217,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); The default value for the property is adbDefault and indicates that the application uses the default capabilities provided by the widgetset.

      - DoubleBuffered is a platform-specific property. Only the Windows platform implements double buffering (at the widgetset level) in the current LCL version. Changing the value for the property to True has no effect if double buffering is not implemented for the widgetset used in the Application. + DoubleBuffered is a platform-specific property. Only the Windows platform implements double buffering (at the widgetset level) in the current LCL version. Changing the value for the property to True has no effect if double buffering is not implemented for the widgetset used in the Application.       @@ -13444,7 +13521,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Changing the value in the property causes the Widgetset class to be notified of the new property value.

      - MainFormOnTaskBar is a platform-dependent property. It may not be implemented for all platforms supported for the Lazarus application. In addition, some platforms which display task bar thumbnails (like Windows Vista) may require the property to be set to True. + MainFormOnTaskBar is a platform-dependent property. It may not be implemented for all platforms supported for the Lazarus application. In addition, some platforms which display task bar thumbnails (like Windows Vista) may require the property to be set to True.

      The default value for the property is normally set in the Lazarus project file (.lpr) used to compile the application. @@ -13572,7 +13649,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Event handler signalled to update actions used in the application.

      - OnActionUpdate is a TActionEvent property with the event handler signalled to update actions used in the application. OnActionUpdate is signalled from the UpdateAction method called when the CM_UPDATEACTIONS control message is handled in the application. + OnActionUpdate is a TActionEvent property with the event handler signalled to update actions used in the application. OnActionUpdate is signalled from the UpdateAction method called when the CM_UPDATEACTIONS control message is handled in the application.

      @@ -13684,7 +13761,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); OnIdleEnd is a TNotifyEvent property with the event handler signalled when the application leaves the Idle state.

      - It is signalled from the DoOnIdleEnd method, and occurs after the AppWaitMessage method in the widgetset class has been completed. It occurs before the NotifyIdleEndHandler method is called to process other application handlers using the ahtIdleEnd type. + It is signalled from the DoOnIdleEnd method, and occurs after the AppWaitMessage method in the widgetset class has been completed. It occurs before the NotifyIdleEndHandler method is called to process other application handlers using the ahtIdleEnd type.

      Use OnIdle to perform actions needed when the application enters the idle state. @@ -13753,7 +13830,9 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Event handler signalled when a message dialog in the application has been completed. - Used in the CustomDraw interface. +

      + Used in the CustomDraw interface. +

      @@ -14034,7 +14113,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Scaled is a Boolean property which indicates if the application can be scaled between differing display densities (Pixels per Inch) at run-time. The default value for the property is normally set in the project file used to compile the application and its forms and controls.

      - When Scaled is set to True, the application allows the design-time PixelsPerInch value to be adjusted to reflect the run-time value. Forms, frames, image lists, and other controls also have a Scaled property which determines if the feature is enabled for that particular class type. If Scaled is set to False in TApplication, the feature is disabled for all of the other class types. Scaled (at the application-level) is normally checked before the component- or control-level setting. + When Scaled is set to True, the application allows the design-time PixelsPerInch value to be adjusted to reflect the run-time value. Forms, frames, image lists, and other controls also have a Scaled property which determines if the feature is enabled for that particular class type. If Scaled is set to False in TApplication, the feature is disabled for all of the other class types. Scaled (at the application-level) is normally checked before the component- or control-level setting.

      @@ -14663,7 +14742,8 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - IsDesignMsg - receives a message from Sender, and returns True if it is a design message. + IsDesignMsg - receives a message from Sender, and returns True if it is a design message. + @@ -14797,7 +14877,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');

      - TFormPropertyStorage is a TControlPropertyStorage descendant which extends the ancestor class to read and write form values. It provides additional methods called when a form is created, closed, or freed. TFormPropertyStorage is the base class for descendants like TCustomIniPropStorage, TCustomJSONPropStorage, and TCustomXMLPropStorage. + TFormPropertyStorage is a TControlPropertyStorage descendant which extends the ancestor class to read and write form values. It provides additional methods called when a form is created, closed, or freed. TFormPropertyStorage is the base class for descendants like TCustomIniPropStorage, TCustomJSONPropStorage, and TCustomXMLPropStorage.

      @@ -14935,7 +15015,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');
    • VK_RWIN

    - The return value is a set type with the TShiftState values corresponding to the virtual key codes. It may be an empty set when none of the virtual keys are detected. + The return value is a set type with the TShiftState values corresponding to the virtual key codes. It may be an empty set when none of the virtual keys are detected.

    @@ -15102,7 +15182,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - Specifies a Boolean function type used to implement the routine assigned to the IsFormDesign variable. + Specifies a Boolean function type used to implement the routine assigned to the IsFormDesign variable. TIsFormDesignFunction is a Boolean function type used in the IsFormDesign variable. @@ -15112,7 +15192,9 @@ HintWindow.ActivateHint(Rect, 'This is the hint');     - Returns True when the form has csDesignInstance in its component state. + + Returns True when the form has csDesignInstance in its component state. + @@ -15148,10 +15230,10 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Control is the TControl instance examined in the method. The Parent property is used to navigate to preceding parent controls until a TCustomForm instance is found.

    - TopForm indicates if the top-most form instance in the hierarchy is needed. When set to False, the first TCustomForm instance found in the control hierarchy is used. Otherwise, all Parent controls in the hierarchy are examined until a Parent control has not been assigned. + TopForm indicates if the top-most form instance in the hierarchy is needed. When set to False, the first TCustomForm instance found in the control hierarchy is used. Otherwise, all Parent controls in the hierarchy are examined until a Parent control has not been assigned.

    - The return value can contain the value in Control if it is a TCustomForm descendant and no other form instances are used in the control hierarchy. This is Delphi compatible. + The return value can contain the value in Control if it is a TCustomForm descendant and no other form instances are used in the control hierarchy. This is Delphi compatible.

    @@ -15168,7 +15250,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');     - True if the top-most form instance in the control hierarchy is needed. + True if the top-most form instance in the control hierarchy is needed. @@ -15259,7 +15341,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Control examined in the routine. - True if all parent forms are located in the routine. + True if all parent forms are located in the routine. @@ -15335,7 +15417,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - True when the key is used as an accelerator. + True when the key is used as an accelerator. The virtual key (uppercase ASCII) to find. @@ -15474,14 +15556,14 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - When True every form must have a resource (e.g. a .res file). An exception is raised if the resource is missing when creating a form. + When True every form must have a resource (e.g. a .res file). An exception is raised if the resource is missing when creating a form.

    - The form resource is the .lfm file compiled into the executable of your application. For this flag, it does not matter if it was compiled via an .lrs file or via fpcres. The resource is automatically loaded by TForm and its descendants when created using the Create(Owner) method. + The form resource is the .lfm file compiled into the executable of your application. For this flag, it does not matter if it was compiled via an .lrs file or via fpcres. The resource is automatically loaded by TForm and its descendants when created using the Create(Owner) method.

    - If the resource file is missing, there is something wrong with either a resource or the unit which contains the faulty form. If the flag is False, you will see a blank form and probably search a long time what is wrong. If you set this flag to True, you get an exception. + If the resource file is missing, there is something wrong with either a resource or the unit which contains the faulty form. If the flag is False, you will see a blank form and probably search a long time what is wrong. If you set this flag to True, you get an exception.

    For creating forms without resources, you have 3 options: @@ -15489,15 +15571,13 @@ HintWindow.ActivateHint(Rect, 'This is the hint');

    • Create a TForm class (not a descendant).
    • Construct your form using the CreateNew() constructor.
      • -
    • It is also possible to disable the exception by setting the global - variable RequireDerivedFormResource to False.
      • +
    • + It is also possible to disable the exception by setting the global + variable RequireDerivedFormResource to False. +

    - History: - Before 0.9.31 there was no exception. Therefore some resource-less forms - might use the standard constructor Create(Owner) and will now get - exceptions. This change is Delphi compatible and compatible with - TFrame and TDataModule components. + History: Before 0.9.31 there was no exception. Therefore some resource-less forms might use the standard constructor Create(Owner) and will now get exceptions. This change is Delphi compatible and compatible with TFrame and TDataModule components.