From f8fae99933b87b025ba18b8a84787f5da2c4a0be Mon Sep 17 00:00:00 2001 From: dsiders Date: Mon, 30 Aug 2021 23:54:58 +0100 Subject: [PATCH] Docs: LCL/forms. Adds missing topics or content. --- docs/xml/lcl/forms.xml | 131 +++++++++++++++++++++++++++++++++-------- 1 file changed, 108 insertions(+), 23 deletions(-) diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index dfdba164d8..c035cae170 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -6163,9 +6163,9 @@ Usage:

- HintWindow := THintWindow.Create(nil); - Rect := HintWindow.CalcHintRect(0, 'This is the hint',nil); - HintWindow.ActivateHint(Rect, 'This is the hint'); +HintWindow := THintWindow.Create(nil); +Rect := HintWindow.CalcHintRect(0, 'This is the hint',nil); +HintWindow.ActivateHint(Rect, 'This is the hint'); @@ -13389,6 +13389,31 @@ + + + Converts virtual key state codes to TShiftState values. + + +

+ Calls GetKeyState to get the virtual key codes for the following: +

+
    +
  • VK_SHIFT
    • +
  • VK_CONTROL
    • +
  • VK_MENU
    • +
  • VK_LWIN
    • +
  • 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. +

+ + + + + + + Converts a shift state into a key state value compatible with the key state of a Windows API LParam. @@ -13522,9 +13547,21 @@ - - - + + Specifies an event handler signalled to get the form with the designer for a persistent object. + + +

+ TGetDesignerFormEvent is an object function type which specifies an event handler signalled to get the form instance with the designer object for APersistent. The return value contains the TCustomForm instance which contains the designer object for the persistent object, and may be unassigned (Nil) if a form hosting APersistent cannot be located. +

+

+ TGetDesignerFormEvent is the type used for the OnGetDesignerForm variable in the forms unit. +

+ + + + + @@ -13532,8 +13569,11 @@ + - + + 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. @@ -13549,13 +13589,25 @@ - + + Event handler signalled to get the designer form for the specified form or control. + - OnGetDesignerForm is a TGetDesignerFormEvent variable that contains the event handler signalled to get a form with a design surface for the specified form or control. +

+ OnGetDesignerForm is a TGetDesignerFormEvent variable that contains the event handler signalled to get a form with a design surface for the specified form or control. +

+ + + Address of the function used to determine if specified control is a form designer. + + + + + Gets the form instance for the specified Control. @@ -13585,18 +13637,27 @@ - - + + Gets the Form with the designer object for the specified control or persistent object. + + +

+ GetDesignerForm is a TCustomForm function used to get the form instance with the designer object for the specified control or persistent object instance. The function is overloaded to allow use of a TControl or a TPersistent instance to locate the form. +

+

+ The return value contains the top-most TCustomForm instance with a TIDesigner instance for the value in Control or APersistent. The return value is Nil when a form is not found which hosts the specified argument. +

+ - + Form instance with the designer for the specified argument. - + TControl instance used to locate the owner form. - + TPersistent instance used to locate the owner form. @@ -13621,7 +13682,9 @@ - + + Gets the top-most form which hosts the specified control docksite form instances. + @@ -13631,6 +13694,7 @@ + Gets a valid parent form for the specified control. @@ -13657,18 +13721,29 @@ - - + + Gets the designer object for the specified persistent object (or its parent). + + +

+ FindRootDesigner is a TIDesigner function used to get the root designer object for the specified persistent object instance. The TIDesigner instance is found on the Form where the object (or its parent) is hosted in the Lazarus IDE. The return value is Nil when a parent form for APersistent is not found. +

+ - + + TIDesigner instance for the object, or Nil when a parent form is not found. + - + Persistent object examined for a designer instance in the routine. + - + + Gets the control which is the top-most TCustomDesignControl instance for the specified control, or Nil when not a TCustomDesignControl instance. + @@ -13678,9 +13753,19 @@ + - - + + Ensures that a TCustomDesignControl instance is found for the specified control. + + +

+ Calls GetParentDesignControl to get the return value for the function. Raises an EInvalidOperation exception if a TCustomDesignControl instance is not found for the specififed control. +

+

+ Used in methods which perform scaling operations for TCustomForm or TControl instances. +

+ @@ -13765,7 +13850,7 @@ - The TScreen singleton. + The TScreen singleton for the application.