From fc1e0c535feddb32a8349beff99cd75cce3ad06e Mon Sep 17 00:00:00 2001 From: juha Date: Tue, 2 Jun 2020 06:56:51 +0000 Subject: [PATCH] Docs: Documentation updates for LCL. Issue #37147, patch from Don Siders. git-svn-id: trunk@63275 - --- docs/xml/lcl/comctrls.xml | 54 +- docs/xml/lcl/forms.xml | 1377 +++++++++++++++++++++++++++---------- 2 files changed, 1052 insertions(+), 379 deletions(-) diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 97f6f24778..7e38dcefb5 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -17931,24 +17931,6 @@

TTreeViewOption - enumerated type containing the permissible values for Options in TreeViews.

- 
-            tvoAllowMultiselect,
-            tvoAutoExpand,
-            tvoAutoInsertMark,
-            tvoAutoItemHeight,
-            tvoHideSelection,
-            tvoHotTrack,
-            tvoKeepCollapsedNodes,
-            tvoReadOnly,
-            tvoRightClickSelect,
-            tvoRowSelect,
-            tvoShowButtons,
-            tvoShowLines,
-            tvoShowRoot,
-            tvoShowSeparators,
-            tvoToolTips,
-            tvoNoDoubleClickExpand
-
@@ -18022,6 +18004,15 @@ Show tooltip (hint) for a tree-item when the item is too long to fit by width and mouse is over it. Same as ToolTips property. + + Prevents toggling the expanded state for the treeview item when it is double clicked + + + Treeview item is drawn using settings from theme services + + + Indicates if empty space can be be drawn below unselected items in the treeview + @@ -18457,6 +18448,18 @@ + + + + + + + + + + + + @@ -19224,6 +19227,21 @@ + + + + + + + + + + + + + + + GetNodeDrawAreaHeight - returns the height for the area in which node is drawn diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index 6ab3d6f534..8d8d41e081 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -11,7 +11,7 @@ Contains types and classes used to implement Forms, which are the basis for the Lazarus Graphical User Interface - + @@ -19,7 +19,7 @@ - + @@ -62,17 +62,14 @@ Represents the Position and Size of a Form on Screen -

poDesigned - The Form appears exactly as it is positioned and sized in the Form Designer

-

poDefault - The window manager decides how the form is to appear, in a default position and size

-

poDefaultPosOnly - keeps the Designed size, but position determined by windowmanager

-

poDefaultSizeOnly - keeps the Designed position, but size determined by windowmanager

-

poScreenCenter - Centers the form on screen

-

poDeskTopCenter - Centers the form on desktop

-

poMainFormCenter - Centers the Form on the Main Form

-

poOwnerFormCenter - Centers the Form on Owner form

-

poWorkAreaCenter - Centers the Form on working area

+

+ TPosition is an enumerated type with values that describe the policy used to position and size a form instance in an application. TPosition is the type used to implement the Position property in TCustomForm. TPosition is used in the implementation of the MoveToDefaultPosition method in TCustomForm. +

- + + + + The Form appears exactly as it is positioned and sized in the Form Designer. @@ -112,28 +109,23 @@ Represents the actual State of the window on the screen -

The actual meaning of each value depends on the platform:

+

+ The actual meaning of each value depends on the platform: +

Windows and Mac OS X
These operating systems support all values.
X11
-
The window state is a hint sent to the Window Manager, so more primitive Window Managers might ignore these hints.
+
+ The window state is a hint sent to the Window Manager, so more primitive Window Managers might ignore these hints. +
Windows CE
-
In Windows CE platforms where Application.ApplicationType = atKeyPadDevice or atPDA (like in Windows Phone, PocketPC and Windows Mobile), wsMinimized and wsNormal are understood as wsMaximized, which is the normal state for windows in this platform. An exception are windows with BorderStyle=bsDialog or bsNone, which are allowed to have a custom position and size. For more information please read http://wiki.lazarus.freepascal.org/Windows_CE_Development_Notes#Positioning_and_size_of_Dialogs_and_Forms
+
+ In Windows CE platforms where Application.ApplicationType = atKeyPadDevice or atPDA (like in Windows Phone, PocketPC and Windows Mobile), wsMinimized and wsNormal are understood as wsMaximized, which is the normal state for windows in this platform. An exception are windows with BorderStyle=bsDialog or bsNone, which are allowed to have a custom position and size. For more information please read the Lazarus Wiki article. +
Android
In this platform windows are always fullscreen.
-

The valid values for this enumerated type are:

-
-
wsNormal
-
The window appears normal
-
wsMinimized
-
The window is minimized and is not shown in the screen, but only in the taskbar
-
wsMaximized
-
The window appears maximized
-
wsFullScreen
-
The window appears in full screen mode, as much as allowed by the platform
-
@@ -144,14 +136,14 @@ The window is minimized and is not shown in the screen, but only in the taskbar - The window appears maximized. The exact behavior is up to the window manager, but usually the window appear occupying all of the work area of a monitor. - to the full monitor? + + The window appears maximized. The exact behavior is up to the window manager, but usually the window appear occupying all of the work area of a monitor. + The window appears in full screen mode, when allowed by the platform. It will, for example, attempt to appear on the top of taskbars and other static platform user interface elements. - ? @@ -179,15 +171,27 @@ - Action taken when a new value is assigned to , and no OnHint handler is available + + Represents a standard action used to get a Hint value + +

+ TCustomHintAction is a TCustomAction descendant. TCustomHintAction publishes the Hint property available in the ancestor. TCustomHintAction is the base class for THintAction defined in the StdActns unit. +

+

+ TCustomHintAction is used in TApplication when setting the value for its Hint property and its OnHint event handler has not been assigned. TCustomHintAction is also used in the ExecuteAction method in TStatusBar when its AutoHint property is enabled. +

- - !? + + + + + + - The new Hint text + The text used for the Hint @@ -219,10 +223,11 @@ Default - what's this? + Not used in the current LCL version. Scrollbar appears flat + Not used in the current LCL version. Scrollbar sends HotTrack messages @@ -230,7 +235,7 @@ - Class for exception in + Exception class raised in @@ -268,8 +273,6 @@ The virtual scroll range (FRange - ClientSize), at least zero (never negative) - - @@ -279,20 +282,15 @@ - - - The associated - - - The Handle of the associated + The Handle for the associated @@ -301,7 +299,7 @@ - The AutoScroll state of the associated + The AutoScroll state for the associated Please note: GetAutoScroll is not used as the read access specifier for a property. It is used in methods to ensure that the class reflects the current state for its associated control. @@ -321,32 +319,26 @@ - - - - - - True when the associated has a handle allocated @@ -355,18 +347,15 @@ - - Determines the scrollbar Range, using the physical and virtual size for the associated control - Notifies the associated Control of changes @@ -374,7 +363,6 @@ - Checks and updates the new range for scrollbars in the Control @@ -386,7 +374,6 @@ - Handler for the ScrollBar movement messages @@ -395,47 +382,38 @@ Message examined in the method - New value for the property - New value for the property - New value for the property - New value for the property - New value for the property - New value for the property - New value for the property - New value for the property - Updates the state and position for the scroll bar in the associated Control @@ -465,24 +443,29 @@ - Renders scroll information invalid for the control - - - usage? + +

+ InvalidateScrollInfo is used to mark the current TScrollInfo in the control as invalid. This occurs when a new value is assigned to the Position property, and when ScrollHandler applies position information found in TLMScroll messages. Calling InvalidateScrollInfo results in TScrollInfo being updated and applied for scrolling window controls in the UpdateScrollBar method. +

+ + + + + + + - + Get the horizontal scrollbar for the Control - - + TControlScrollBar instance representing the scrollbar - Get the vertical scrollbar for the Control @@ -500,14 +483,33 @@ - True when Visible and Range higher than Page + True when Visible, and Range is larger than the Page size - Creates a scrollbar object for AControl - + Constructor for the class instance + +

+ Create is the constructor for the class instance, and calls the inherited constructor on entry. +

+

+ Create sets the Control and Kind properties to the values specified in the AControl and AKind arguments. Create sets the default values for properties, including: +

+
+
Page
+
Set to 80.
+
Increment
+
Set to 8.
+
Position and Range
+
Set to 0 (zero).
+
Smooth and Tracking
+
Set to False.
+
Visible
+
Set to True.
+
+ - TObject.Create + @@ -518,19 +520,24 @@ - If Source is a TControlScrollBar, copies properties to itself, else performs inherited Assign + + If Source is a TControlScrollBar, copies properties to itself, else performs inherited Assign

- 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.

+ + + + TControlScrollBar instance with the values copied in the method @@ -553,66 +560,145 @@ - Get the ScrollBar of the opposite direction (horz/vert) + Get the ScrollBar with the opposite orientation (horz/vert) for the current instance - + TControlScrollBar instance for the opposite orientation - The currently remaining extent of the Parent Control, depending on ScrollBar visibility + Gets the size for the scroll bar based on the client area in the associated control - return for vertical scrollbar the clientwidth + +

+ ClientSize is an Integer function used to get the size from the client area in the associated control. ClientSize uses the value in Kind to determine whether the height or width for the associated control is used as the return value. For example: +

+
+
sbVertical
+
Returns the client width from the associated control.
+
sbHorizontal
+
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. +

+ + + + + - for vertical scrollbar the clientwidth + Size from the client area in the associated control - The remaining extent of the Parent Control, when the ScrollBar is visible + + Calculates the size of the associated control when the scroll bar is Visible + - Return for vertical scrollbar the clientwidth with the bar, even if Visible=false. +

+ ClientSizeWithBar is an Integer function used to calculate the client area for the associated control when the scroll bar is Visible. The return value contains the calculated value from ClientSize. If the scroll bar is not Visible, additional spacing (for the SM_SWSCROLLBARSPACING system metric) between the scroll bar and its associated control is removed from the return value. +

+

+ ClientSizeWithBar is used in the implementation of the ComputeScrollbars method in TScrollingWinControl when the Range for the scroll bar would exceed the space available on the control, and in the GetPreferredSizeClientFrame method. +

- + + + + + + + - For vertical scrollbar the clientwidth with the bar, even if Visible=false + Size for the client area after adjusting for a visible scroll bar - The remaining extent of the Parent Control, when the ScrollBar is not visible. + + Calculates the size of the associated control when the scroll bar is not Visible - Return for vertical scrollbar the clientwidth without the bar, even if Visible=true. +

+ ClientSizeWithoutBar is an Integer function used to calculate the client area for the associated control when the scroll bar is Visible. The return value contains the calculated value from ClientSize. If the scroll bar is Visible, additional spacing (for the SM_SWSCROLLBARSPACING system metric) between the scroll bar and its associated control is added to the return value. +

+

+ ClientSizeWithoutBar is used in the implementation of the ComputeScrollbars and GetPreferredSizeClientFrame methods in TScrollingWinControl. +

- + + + + + + + - For vertical scrollbar the clientwidth without the bar, even if Visible=true + Size for the client area after adjusting for a hidden scroll bar - The small Position increment, applicable to the scrollbar arrows + + The small Position increment, applicable to the scrollbar arrows + - The amount by which the Position moves if the triangle at either end of the bar is selected. The default value is 8 (pixels). +

+ Increment is a TScrollBarInc property which indicates the amount the client area in the associated control is scrolled when the Up or Down navigation arrows on the scroll bar are clicked. The default value is 8. +

+

+ The value in Increment may be automatically recalculated in the UpdateScrollBar method if the Smooth property is enabled, and the associated control is a TScrollingWinControl descendant. This is done to ensure that Increment contains 10% of the value for the Page property. +

+

+ Increment is used in the ScrollHandler method when updating the Position property for scroll bar messages received in the control. +

- + + + + + + + + + The orientation for the scroll bar: horizontal or vertical - - + +

+ Kind is a read-only TScrollBarKind property which indicates the orientation for the scroll bar. The value for Kind is passed as an argument to the Create constructor, and stored in the property. The value in Kind is used in methods which update properties or state for the control, such as: +

+
    +
  • Position
    • +
  • Range
    • +
  • Page
    • +
  • Tracking
    • +
  • Size
    • +
  • ClientSize
    • +
  • ControlSize
    • +
  • IsScrollBarVisible
    • +
  • GetOtherScrollBar
    • +
  • UpdateScrollBar
    • +
+ + + + + @@ -620,11 +706,12 @@

- The amount by which the scroll indicator moves if the cursor selects the scroll bar above, below or on either side of the scroll indicator. The default value is 80 (pixels). + The amount by which the scroll indicator moves if the cursor selects the scroll bar above, below or on either side of the scroll indicator. The default value is 80.

+ Position of the slider, 0..Range-Page @@ -635,18 +722,29 @@ + - Enables smooth scrolling, with automatic adjustment of Increment and Page. + + Enables smooth scrolling, with automatic adjustment of Increment and Page - Smooth scrolling uses an Increment of 10%, and a Page size of 90% of the visible client area. +

+ Smooth is a Boolean property that indicates if the associated control is scrolled using an Increment value computed to be 10% of the Page size for the scroll bar. Set Smooth to True when the scroll bar should use a scrolling increment based on the size of the client area in the associated control. When Smooth is set to False, the Increment property determines the size for the scroll operation when the Up or Down arrows are clicked. +

+

+ Smooth is used in the UpdateScrollBar method, and when set to True causes the value in Increment to be recalculated using the proportional size value. Smooth is relevant when the associated control is descended from TScrollingWinControl. +

+

+ The default value for the property is False. +

+ + - ? @@ -682,7 +780,7 @@ - Definitely hides the scrollbar when False (default True) + Hides the scrollbar when False (default True)

The scrollbar widget is visible only if (Visible=True) and (Range>Page). @@ -1004,12 +1102,10 @@ - - Owner for the class instance + Owner of the class instance - @@ -1093,8 +1189,6 @@ - - @@ -1218,7 +1312,7 @@ Design-time Pixels Per Inch for the designer surface

- DesignTimePPI is an Integer property that contains the display density (or Pixels Per Inch) used on the designer surface. The default value for the property is 96 (pixels). + DesignTimePPI is an Integer property that contains the display density (or Pixels Per Inch) used on the designer surface. The default value for the property is 96.

The property value is normally set when the component is loaded using the LCL streaming mechanism. It can be assigned at design-time to the value in ADesignTimePPI only when the new value matches the display density for the current Screen where the designer surface is used. The value can be changed at run-time, but the programmer must ensure that the value is valid for the intended usage. @@ -1463,7 +1557,6 @@ - @@ -1473,7 +1566,6 @@ Owner of the class instance - @@ -1526,10 +1618,10 @@ - + - Visual elements in window title bars; depends on window manager support. + Represents a visual element in a window title bar; depends on window manager support

@@ -1558,9 +1650,7 @@ Window has an Help button - - The preferred monitor for showing a form @@ -1597,7 +1687,6 @@ Place the form on the same monitor as the currently active form. If there is no such form then use the primary monitor. - Form state flags @@ -1705,7 +1794,6 @@ Uses the default rules from the platform for showing the form in the TaskBar - platform? Always show the form in the TaskBar @@ -1774,16 +1862,24 @@ - Type of an form OnCloseQuery handler - - + Specifies an OnCloseQuery handler event handler + +

+ TCloseQueryEvent is an object procedure type which specifies the event handler signalled to determine if a form can be closed. +

+

+ TCloseQueryEvent is the type used to implement the OnCloseQuery property in TCustomForm. An application must implement an object procedure using the signature for the event handler to allow responding to the notification. +

+ + + + The form that received an Close request Set to False to deny closing - ? @@ -1922,12 +2018,6 @@ - - The last active control, used to detect focus changes - - - - Used to track Focus changes (Enter/Exit events) @@ -2176,29 +2266,76 @@ Called when the Focus changed - - - ? + +

+ SetWindowFocus is a procedure used to ensure that the active control in the form instance has the inpout focus when the forms receives focus. At run-time, the control in ActiveControl (when assigned) is used as the active control. At design-time, the active control is the design surface for the current form instance. +

+

+ No actions are performed in the method when a handle has not been allocated for the active control, or the control cannot be focused. +

+

+ SetWindowFocus calls the SetFocus routine in LCLIntf to change the focus to the handle for the active control, and when successful calls the Perform method in the control to post the CM_UIACTIVATE control message. +

+

+ SetWindowFocus is used in the implementation of the SetFocus and SetActive methods. +

+ + + + + + + - Adds a form notification handler of the specified type - + Adds a form notification handler with the specified type and code + +

+ AddHandler is a procedure used to add a form notification handler to the list of handlers in the form instance. +

+

+ HandlerType is a TFormHandlerType enumeration value that defines the situation(s) where the form handler can be executed. See TFormHandlerType 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. +

+

+ AsFirst indicates if the handler should be inserted as the initial handler in the method list (when True), or appended to the end of the list (when False). +

+

+ AddHandler calls RaiseGDBException to raise an exception when the pointer to the Code in Handler has not been assigned. +

+

+ AddHandler ensures that a TMethodList exists for handlers using the value in HandlerType, and calls the Add method in the TMethodList to store the Handler at the position needed for AsFirst. +

+

+ AddHandler is called from the implementation of more specialized methods like AddHandlerClose, AddHandlerCreate, and AddHandlerFirstShow. +

+ + + Raises a catchable exception if the Code has not been assigned for the form Handler. + + + + + + - + Form handler type added in the method - + Code to execute for the form handler - + True if the new form handler becomes the first handler in the list of handlers Removes a form notification handler of the specified type @@ -2233,7 +2370,7 @@ - + Handles the LM_ACTIVATE message which activates or deactivates the form @@ -2241,22 +2378,19 @@ - + Handles the LM_CLOSEQUERY message used to close the window - what does Result=0 mean? + + + What does Result=0 mean? + It means that WndProc should ignore the result because the message was already handled. + + - - - - - - - - @@ -2265,6 +2399,14 @@ + + + + + + + + @@ -2370,17 +2512,19 @@ - FActionLists is a local variable holding lists of actions associated with the Form - - + + FActionLists is a local variable holding lists of actions associated with the Form + - When a control is not Active, sets the Focus to the first control in the TabOrder for the form. + When a control is not Active, sets the Focus to the first control in the TabOrder for the form + + Notifies the OnActivate handler @@ -2388,13 +2532,16 @@ - Does nothing - + An empty implementation in TCustomForm + + Just like VCL. + Can be implemented in a descendant to perform actions needed when the active form is changed. + - ? Excludes borders from the given rectangle + TWinControl.AdjustClientRect @@ -2404,7 +2551,8 @@ Locks form updates (AutoSize), until EndFormUpdate - Nested calls are allowed (pairs of Begin/EndFormUpdate). + + Nested calls are allowed (pairs of Begin/EndFormUpdate). @@ -2413,9 +2561,22 @@ - + + Initializes parameters used to create the handle for the form instance + +

+ CreateParams is used to initialize parameters needed to create the handle for the form instance. +

+

+ CreateParams is an overridden procedure in TCustomForm, and calls the inherited method on entry. CreateParams ensures that values in the Params argument are valid. This includes setting the realized parent form and window handle for forms which are not the main form in the application. Style flags are also updated to indicate how the form is displayed in the task bar. +

+ + + + + - + Values examined and updated in the method Creates the widget, updates the widget-dependent properties. @@ -2554,7 +2715,7 @@

- Uses the value in State to determine the action required in the method. The LCL interface is used to detemine if the window state is valid for the widget set. When allowed, the following methods are called for the corresponding TWindowState value: + Uses the value in State to determine the action required in the method. The LCL interface is used to determine if the window state is valid for the widget set. When allowed, the following methods are called for the corresponding TWindowState value:

wsMinimized
@@ -2713,10 +2874,7 @@ Allow form dragging only if it is docked into a site without a DockManager. - - - - + why? @@ -2782,10 +2940,26 @@ - Asks all components to initiate their actions - - - ? + 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 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. +

+

+ Update actions is called for each of the custom forms when the application enters an idle state, and occurs after processing queued asynchronous calls and the OnIdle event handler in the application. +

+ + + + + + + + + The Handle of the MDIForm client (container for MDI children) @@ -2893,13 +3067,18 @@ Bring the form to front if True - Focus the control. If needed bring form to front. - + + Gives focus to the specified control + + +

+ FocusControl is a procedure used to give focus to the control specified in WinControl. FocusControl ensures that the ActiveControl property is updated when needed, and may raise an exception if WinControl cannot be focused. If the form instance was not already Active, the SetFocus method is called. +

+ If the control or one of its parents is not visible or disabled, an exception will be raised (in SetFocus). - when? always? The control receiving the focus @@ -3072,12 +3251,10 @@ - False when no switching allowed - ? + False when the focused control cannot be changed The control that received the focus - ? Sets the bounds for the restored control @@ -3101,7 +3278,7 @@ - Show this form as a modal Dialog + Displays the form as a modal Dialog

Shows the form in a modal state and waits until it is closed by the user or by the program. Modal state means that neither the user nor the program can switch to another form already made visible before calling ShowModal. @@ -3163,10 +3340,10 @@ Here: always False - + Control with the key message for the method - + Key message from the child control @@ -3294,26 +3471,58 @@ - Allows for a translucent form + Allows the form to be drawn with translucency +

+ AlphaBlend is a Boolean property which indicates if the form can be drawn with translucency. When set to True, the form is drawn with a degree of transparency and diffusion. This allows other forms (and their controls) which have a lower Z-Order value to be seen beneath the form. The default value for the property is False. +

+

+ 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 property 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. +

+ + Please note: AlphaBlend requires support from both the Desktop Environment (DE) and the hardware for the system; it may not work on all hardware, or platform / operating system combinations supported as Lazarus targets. + + - somewhat transparent? The translucence level for the form (0=transparent, 255=opaque) - + +

+ AlphaBlendValue is a Byte property which indicates the level of translucency for the form when AlphaBlend is set to True. AlphaBlendValue must be in the range 0..255 (for the Byte data type), where 0 represents 100% transparency and 255 is for full opacity. +

+

+ Changing the value for the property causes the widgetset class to be notified of the change in the property value at run-time when a handle has been allocated for the form. +

+

+ Set AlphaBlend to True to enable translucency for the form. +

+

+ 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. +

+ + Please note: AlphaBlend and AlphaBlendValue require support from both the Desktop Environment (DE) and the hardware for the system; it may not work on all hardware, or platform / operating system combinations supported as Lazarus targets. + + + 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 does not allow display of 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 setting the value in the BorderStyle property 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 setting the value in the BorderStyle property to another value.

@@ -3321,12 +3530,31 @@ - Specifies which icons appear in the title bar of the form + Specifies the icons which appear in the title bar for the form - The icons can represent a system menu, minimize/restore/maximize and close buttons, and an What's this button. +

+ BorderIcons is a TBorderIcons property which contains valued from the TBorderIcon enumeration, and indicates the icons displayed in the title bar for the form instance. The default value for the property includes the following enumeration values: +

+
    +
  • biSystemMenu
    • +
  • biMinimize
    • +
  • biMaximize
    • +
+

+ See TBorderIcon for more information about the enumeration values and their usage. +

+

+ Changing the value in BorderIcons causes the WidgetSetClass for the form instance to be notified of the new values in the property. +

+

+ Values in BorderIcons may be automatically changed at run-time when a new value is assigned to the BorderStyle property; see DefaultBorderIcons for the icons used for a specific border style. +

+ + + @@ -3361,7 +3589,7 @@ The control associated with the Cancel action

- Determines the control associated with the Cancel action (exit from the modal form without changing anything). This is usually a button with the caption 'Cancel', but might be an 'Exit' button or anything else the application programmer decides. This control is selected either by explicitly clicking with the mouse, or by hitting the 'Esc' key. + Determines the control associated with the Cancel action (which exits from the modal form without changing anything). This is usually a button with the caption 'Cancel', but might be an 'Exit' button or anything else the application programmer decides. This control is selected either by explicitly clicking with the mouse, or by hitting the 'Esc' key.

@@ -3370,7 +3598,7 @@ - The text appearing in the title bar + The text displayed in the title bar for the form @@ -3392,7 +3620,7 @@ - The monitor on which the form will appear + The monitor on which the form is displayed

Possible values:

@@ -3401,11 +3629,13 @@
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 use dmMainForm behavior.
+
+ On the same monitor as the currently active form. If there is no active form use dmMainForm behavior. +
@@ -3426,10 +3656,21 @@ - Various state flags for the form - + State flags for the form + +

+ FormState is a read-only TFormState property which contains state flags enacted for the form instance. Values from the TFormStateType enumeration are included in, or excluded from, the set type when corresponding actions occur (or are resolved) for the form instance. +

+

+ See TFormStateType for more information on the values and meanings in the enumeration. +

+

+ FormState is updated when properties for the form instance are changed, and in methods which respond to window and control messages in the form instance. +

+ + @@ -3460,31 +3701,82 @@ The name of the help file for the form - - + +

+ HelpFile is a String property which contains the name of the help file for the form instance. HelpFile can use a fully-qualified path to the help file if it is not locate in the same directory as the application which implements the form. +

+

+ The value in HelpFile is used in TApplication when it retrieves the help file name from the active form in the application. +

+ + + + + The Icon associated with this Form (in minimized state) - + +

+ Icon is a TIcon property which contains the graphical icon for the form instance. Icon contains the image displayed on the task bar area when a form is minimized. If an Icon is not explicitly assigned for the form, the icon for the Application is used. +

+

+ Assigning a new value to Icon causes existing icon handles to be freed, and the widgetset class is notified to re-create the icon handles. +

+ + Allows the form to intercept keystrokes in child controls - + +

+ KeyPreview is a Boolean property which controls whether the form can intercept key strokes from child controls. When KeyPreview is set to True, the form is allowed to receive KeyDown, KeyUp, and KeyPress events before they are received/applied to the ActiveControl in the form. +

+

+ The default value for the property is False. +

+

+ KeyPreview is used in the implementation of key handling methods in TWinControl. KeyPreview is often enabled for modal dialogs to allow the parent form to handle specific user interactions. +

+ - Provides indexed access to MDI child forms, when this is an MDI form + Provides indexed access to MDI child forms, when this is a MDI form +

+ 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. +

+ + Please note: 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 those MDI from style values. +

+

+ The Integer Index value is used to access the MDI child forms for the current form instance by the ordinal for the requested form. The return value contains the TCustomForm instance at the specified position, as determined using the GetMDIChildren method in the widgetset class. The return value can be Nil when the current form does not use a FormStyle with the value fsMDIForm or fsMDIChild, or when a handle has not yet been allocated for the form instance. The return value is always Nil at design-time. +

+

+ Use MDIChildCount to get the number MDI child forms for the form instance. +

+

+ Use ActiveMDIChild to get the active MDI child form in the application. +

+

+ Set the value in the FormStyle property to indicate that the class is used as a MDI form. +

+ + @@ -3492,27 +3784,67 @@ - The main menu for this form - Drop a TMainMenu on the form to store it here and to show it on the form. + The main menu for the form instance + +

+ Menu is the TMainMenu instance assigned to the form. +

+

+ Assigning a new value to Menu causes other forms on the Screen to be checked for a duplicate menu assignment. A singlular TMainMenu instance cannot be assigned to more than one form. An EInvalidOperation is raised if another form alreasy uses the menu instance. The UpdateMenu method is called when the new property value has been set. +

+ + + - Specifies the return value for a modal form (or dialog) + Specifies the return value for a form (or dialog) displayed modally +

+ ModalResult is a TModalResult property which contains the value derived when the form is displayed modally. Setting a new value for the property causes the widgetset class to be notified when a handle has been allocated for the form. +

+

+ The value in ModalResult is updated when the ShowModal method is called for the form instance. It may is updated in the CloseModal method when CloseQuery is False and CloseAction is caNone. Finally, it is set to mrCancel in the Close method when FormState contains the value fsModal. +

+

+ See TModalResult for more information about the enumertation values and their meanings. +

+ + + + + The Monitor where the form is shown + +

+ Monitor is a read-only TMonitor property wich contains the monitor where the form was displayed. Monitor defaults to the TMonitor instance for the Parent form when it has been assigned. +

+

+ When the parent form has not been assigned, and a handle exists for the form instance, the widgetset class is notified of the current coordinates for the form. The MonitorFromWindow method in the Screen singleton is called to locate the window closest to the the form (using its handle). +

+

+ When neither a parent form nor a window handle are available, the MonitorFromPoint method in the Screen singleton is used to locate the form located at the Top and Left coordinates for the form instance. +

+ + + + + + + - Tracks changes in the focus for the active form or the control on the current form + Tracks changes in the focus for the active form or the last active control for the current form

@@ -3527,12 +3859,24 @@ Defines where popup menus are shown - + +

+ PopupMode is a TPopupMode property which controls the display policy for pop-up forms. The default value for the property is pmNone. See TPopupMode for more information about the values and meanings in the enumeration. +

+

+ Changing the value in PopupMode causes the value in PopupParent to be changed when the property is set to pmAuto or pmNone. At run-time, the widgetset class is notified of the change to the PopupParent property. +

+

+ PopupMode is used in the implementation of the GetRealPopupParent and ShowModal methods. +

+ + + - ??? + ? @@ -3574,72 +3918,181 @@ Handler called when the form is closed. It determines what happens to the form (destroy, hide...). - - + +

+ OnClose is a TCloseEvent property which represents the event handler signalled when a form calls its Close or CloseModal method. +

+

+ OnClose is triggered from the DoClose method immediately before calling any internal form handlers registered for the fhtClose form handler action type. OnClose can be used to detemine the action performed in subsequent form handlers by setting the value in the CloseAction argument. +

+

+ An application must implement and assign an object procedure using the signature for TCloseEvent to respond to the event notification. +

+ + + + + + + - Handler called before the form is closed. It can reject an close request. + Event handler signalled when trying to close a form

- An OnCloseQuery handler can check for unsaved information, ask the user whether it's okay to save or discard changes, or simply reject the close request. + OnCloseQuery is a TCloseQueryEvent property which contains the event handler signalled to determine whether the form can be closed. Set the value in the CanClose argument to True to allow the form instance to be closed. The default value for CanClose is True. +

+

+ Use OnCloseQuery to perform any actions or dialogs needed to confirm that the form can in fact be closed. +

+

+ An application must implement and assign an object procedure using the signature in TCloseQueryEvent to respond to the event notification. +

+

+ OnCloseQuery is signalled from the CloseQuery method, and occurs immediately after MDI child forms have called their CloseQuery methods.

- + + + + + Handler called when the form has been created - - + +

+ OnCreate is a TNotifyEvent property which implements an event handler signalled when a new form instance is created. OnCreate can be used to perform any action needed to configure the new form instance, or update the application where the form is used. +

+

+ OnCreate is triggered from the DoCreate method (when assigned) before signalling any form handlers using the fhtCreate form handler action type. At this point, the initial coordinates for the form have been assigned, but are not realized until until DoCreate has been completed. +

+

+ An application must implement and assign an object procedure using the signature for the handler to allow responding to the notification. +

+ + + + + + - Handler called when the form is deactivated (lost focus) - + Handler called when the form is deactivated (loses focus) + + OnDeactivate is a TNotifyEvent property which contains an event handler signalled when form is deactivated (loses focus). OnDeactivate is signalled from the Deactivate method (when assigned). + + Handler called when the form is destroyed - - + +

+ OnDestroy is a TNotifyEvent property signalled when the form instance is destroyed. OnDestroy is signalled from the DoDestroy method (when assigned) as one of the steps before destruction of the class instance. Before the event handler is triggered, the form has been hidden and the Menu from the main form in the Application has been unmerged. +

+ + + Handler called when files have been dropped - You enable this feature by setting AllowDropFiles property. +

+ OnDropFiles is a TDropFilesEvent event handler signalled when a File Drag notification is received from the LCL / widgetset interface. +

+

+ The Sender argument contains the current form instance. The FileName argument contains an array with the file names for the drop operation. +

+

+ Set AllowDropFiles to True to enable drog and drop operations, and execution of this event handler. +

+ Handler called when Help is requested - - + +

+ OnHelp is a THelpEvent property which contains the event handler signalled when a Help command is executed for the form instance. Arguments to the event handler identify the command and the context used in the help request. +

+

+ Command contains the help request type, and corresponds to the values used in the Windows WinHelp API. +

+

+ Data is a PtrInt type which points the context information for the help request. +

+

+ The CallHelp argument indicates if handler(s) in the Application instance should be called when the event handler in the form is completed. Set CallHelp to False when the help request has been satified in the event handler. +

+

+ An application must implement and assign an object function using the signature for the handler to respond to the event notification. +

+

+ Set the return value to True if the Help request was successfully executed. +

+

+ The OnHelp event handler for the active form is signalled when the TApplication instance executes its DoOnHelp method. The arguments to the event handler contain the values intercepted in the WMHelp message processing for the application. If the OnHelp event handler has not been assigned for the active form, the OnHelp event handler in the Application singleton is signalled (when assigned). +

+ + + + + + + Handler called when the form is being hidden - - + +

+ OnHide is a TNotifyEvent property that represents the event handler signalled when the form instance is hidden. OnHide is triggered (when assigned) in the DoHide method, and occurs when the CMShowingChanged control message is applied to the Showing property for the form instance. +

+ + + + + + + + + - Handler called when a key is pressed, before further handling of the key + + Handler called when a key is pressed, before further handling of the key + - The handler can interpret the key as an shortcut and act accordingly. +

+ 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. +

- + + + + + + @@ -3667,48 +4120,126 @@ Handler called when the form is minimized, maximized or restored - - + +

+ OnWindowStateChange is a TNotifyEvent property which represents the event handler signalled when the value for the WindowState property is changed. OnWindowStateChange is triggered (when assigned) from the Resizing method, and occurs when the WM_SIZE window message for the action is handled. +

+

+ See TWindowState for details about the values and meanings in the enumeration. +

+ + + + + + + - The initial placement of the form - By default it is in the position that it was placed in the Form Designer + The initial placement for the form + +

+ Position is a TPosition property which indicates the size and position policy used to display the form instance. The default value for the property is poDesigned, and indicates that the coordinates used in the form designer are used at run-time. See TPosition for the other values, and their meanings, available for the property. +

+

+ Changing the value in Position causes the value in AutoSize to be updated when needed, and calls UpdateControlState. No additional actions are performed at design-time. +

+

+ MoveToDefaultPosition is called when a handle exists for the form instance and it has not been displayed yet. +

+ - + + + - The position of the left edge of the form when it is restored (i.e. changes from minimized or maximized) - - + + The Left coordinate for the form when it is restored (i.e. changes from minimized or maximized) + + +

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

+ + + + + + + - The position of the top edge of the form when it is restored (i.e. changes from minimized or maximized) - - + + The Top coordinate for the form when it is restored (i.e. changes from minimized or maximized) + + +

+ 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 aynchronous queued event handler for the form is executed, and calls the DoOnChangeBounds method. +

+ + + + + + + - The width of the form when it is restored (i.e. changes from minimized or maximized) - - + The width of the form when it is resized + +

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

+ + + + + + + - The height of the form when it is restored (i.e. changes from minimized or maximized) - - + The height of the form when it is resized + +

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

+ + + + + + + How the form is represented in the system Task Bar - - + +

+ ShowInTaskBar is a TShowInTaskbar property which indicates how the form is represented on the system task bar. The default value for the property is stDefault, and indicates the default behavior for the widgetset, platform, or operating system is used. See TShowInTaskbar for more information about values in the enumeration and their meanings. +

+

+ ShowInTaskBar is used in conjunction with the TaskBarBehavior property in the Application singleton to determine the effective visibility for the form on the system task bar. For example: The task bar behavior may require grouping related forms under a single form icon. +

+

+ Changing the value for the property causes the effective visibility to be recalculated when the form is not hidden, or a MDI child form. The new effective task bar visibility is posted to the widgetset class. +

+ + + + + + @@ -3728,10 +4259,7 @@ - - - @@ -3778,7 +4306,6 @@ - @@ -3948,8 +4475,8 @@

Usage:

HintWindow := THintWindow.Create(nil); - Rect := HintWindow.CalcHintRect(0,'This is the hint',nil); - HintWindow.ActivateHint(Rect,'This is the hint'); + Rect := HintWindow.CalcHintRect(0, 'This is the hint',nil); + HintWindow.ActivateHint(Rect, 'This is the hint'); @@ -4426,7 +4953,7 @@ Provides information about a physical monitor

- Monitor information is retrieved dynamically from the Operating System, so that all changes are taken into account. TMonitor has properties that reflect its dimensions, use as the primary monitor, and its display density (or Pixels per Inch). + Monitor information is retrieved dynamically from the Operating System. This ensures that any changes to the installed hardware devices or their configuration are taken into account. TMonitor has properties that reflect its dimensions, use as the primary monitor, and its display density (or Pixels per Inch).

TMonitor is the type returned when reading the TScreen.Monitors property. TMonitor is the type used to implement the TCustomForm.Monitor property. @@ -4617,7 +5144,7 @@ - Type of an screen notification handler, for form related events + Type used for a screen notification handler, for form related events @@ -4628,7 +5155,6 @@ TObject for the event notification - ? @@ -4636,11 +5162,11 @@ - Type for a screen notification handler, for control related events + Type for a screen notification handler used for control related events - + ? @@ -4732,7 +5258,12 @@ - + + The last active control, used to detect focus changes + + + + The last active form, used to detect focus changes @@ -4746,9 +5277,7 @@ - - @@ -4950,8 +5479,10 @@ - Stores the currently active form and control in the last active members. - Notifies all registered handlers of eventual changes. + + Stores the currently active form and control in the last active members. + Notifies all registered handlers of eventual changes. + @@ -5162,8 +5693,10 @@ - Checks whether the form is visible, and whether modal or not blocked by - another modal form + + Checks whether the form is visible, and whether modal or not blocked by + another modal form + ? @@ -5356,7 +5889,8 @@ - Disable all forms except SkipForm. + + Disables all forms except SkipForm.

Used to show modal forms or dialogs.

@@ -5380,8 +5914,8 @@ - Use this method to restore all - previously disabled forms. + + Use this method to restore all previously disabled forms. @@ -5445,6 +5979,28 @@ What to return when no monitor was found + + Override the Cursor property with a temporary value. Use EndTempCursor to release it. + + + + + + Release the temporary cursor set with BeginTempCursor. + + + + + + + + + + + + + + The control which has the Focus for the screen @@ -5478,6 +6034,9 @@ + + Gets the value for the Cursor property taking temporary cursors into account + Provides indexed access to the available cursor shapes for the screen @@ -5543,8 +6102,7 @@ - The total horizontal size of the display. - + The total horizontal size of the display @@ -5603,10 +6161,12 @@ - The Icon font, used with desktop icons - - - ? + The Icon font, used for desktop icons + + IconFont is passed to the InitStockFont method in the widgetset to load the font required. + + + @@ -5625,6 +6185,11 @@ The names of the available (installed) fonts + +

+ Fonts is a read-only TStrings property which contains the names for the fonts available using the EnumFontFamiliesEx routine for the widgetset. Values in Fonts are sorted alphabetically in ascending order. +

+ @@ -5663,8 +6228,7 @@ - The primary monitor typically shows the taskbar. - + The primary monitor typically shows the taskbar @@ -5733,8 +6297,7 @@ - The type of an handler. - + The type of an handler @@ -5744,7 +6307,7 @@ - Defines an event handler signalled to perform exception handling in applications + Defines an event handler signalled to perform exception handling in an application

@@ -5840,41 +6403,45 @@ - - - - ? + Provides access to members in a CM_HINTSHOW control message + + TCMHintShow is a record type used to represent a CM_HINTSHOW control message passed as an argument to control methods. + + + + - + Cardinal value represnting the control message - + Reserved parameter values for the message - + Pointer to the hint information for the control message - + Result returned for the control message - + + TCMHintShowPause is not used in the current LCL implementation. + - ? @@ -5952,22 +6519,24 @@

THintInfoAtMouse is a record type used to store Control and Mouse position information for a hint display.

+

+ THintInfoAtMouse is passed as an argument to the ShowHintWindow method in TApplication. It is also used in the implementation of TApplication methods like ActivateHint and OnHintTimer. +

- ? - + POsition of the mouse cursor for the hint display - + Control for the hint display - + Indicates if hint text is available for form or control @@ -6006,8 +6575,12 @@ Shutting down; set when the application instance is freed - Skip asynchronous callbacks between handling messages - ? + Skip asynchronous callbacks between handled messages + + + Included in Flags when the application is being destroyed. Causes an exception to be raised in QueueAsyncCall. + + Application has been initialized @@ -6017,9 +6590,15 @@ Which keys can be used for the navigation within a form - - - ? + +

+ TApplicationNavigationOption is an enumerated type with values that control the behaviors enabled for navigation in an application. Values from TApplicationNavigationOption are stored in the TApplicationNavigationOptions set type used to implement the Navigation property in TApplication. +

+ + + + + The Tab key moves the Focus to the next (or previous) control in TabOrder. @@ -6044,37 +6623,38 @@ Types of Application notification handlers - - + + TApplicationHandlerType is an enumerated type with values that identify handler categories used in TApplication. + + TApplicationHandlerType is used as an index value for the internal array of TMethodList instances used in TApplication. It is passed as an argument to the AddHandler and RemoveHandler methods in TApplication to identify the method list where the handler is stored. It is also used in the implementation of TApplication methods used to retrieve, execute, or maintain handlers such as: Destroy and RemoveAllHandlersOfObject. + + Application becoming idle - ? - Application becoming busy - ? + Application idle state is ending Handler for KeyDown events, invoked before interface and LCL handlers - ? - Default handler for KeyDown events, invoked after interface - and LCL handlers - ? + + Default handler for KeyDown events, invoked after interface and LCL handlers + Handler invoked on application activated - ? Handler invoked on application deactivated - ? Handler invoked on user input - what's this? + + Used in NotifyUserInputHandler; implemented in Sparta MDI package + Handler invoked on handled exception @@ -6082,11 +6662,10 @@ Handler invoked on session end - what's this? + Used in IntfEndSession. Handler invoked before session ends - ? Handler invoked when the application is minimized @@ -6102,11 +6681,11 @@ Handler invoked on files dropped - ? + Used in IntfDropFiles. Handler invoked on F1 key (help request) - purpose? + Used when OnHelp is not assigned in the application. Handler invoked on Hint request @@ -6177,11 +6756,15 @@ Management information for asynchronous callbacks -

Two queues are used:

-

New calls are added to the Next 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 of further calls.

+

+ Two queues are used: +

+

+ New calls are added to the Next 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. +

@@ -6212,21 +6795,23 @@

TApplicationType identifies the kind of device where the application currently runs. Note that the same application can run on differing device types if it has a flexible user interface.

+

+ TApplicationType is the type used to implement the ApplicationType property in TApplication, and returned from widgetset methods that identify the platform for the interface. +

- ? - + The widgetset will attempt to auto-detect the device type - + For common desktops and notebooks - + For smartphones and other devices with a smallish touchscreen - + Devices without any pointing device, such as keypad feature phones or kiosk machines Enumeration with dialog types for an application @@ -6250,32 +6835,41 @@ Describes the policy for the application of how to show menu and button glyphs -

sbgAlways - show glyphs always (despite system preferences)

-

sbgNever - show glyphs never (despite system preferences)

-

sbgSystem - use system preferences for glyphs showing

+

+ TApplicationShowGlyphs is an enuemrated type with values that indicate the policy for displaying glyphs on menus and buttons. TApplicationShowGlyphs is the type used to implement the ShowButtonGlyphs and ShowMenuGlyphs properties in both TApplication and TApplicationProperties. +

+ + + + - on Button or Tab controls, and menus? - Show glyphs always + Show glyphs always (disregards system preferences) - Show glyphs never + Show glyphs never (disregards system preferences) - Show glyphs according to the platform default + Show glyphs according to the platform or OS preferences How forms are represented in the TaskBar +

+ TTaskBarBehavior is an enumerated type with values that define how forms are displayed in the task bar. TTaskBarBehavior is the type used to implement the TaskBarBehavior property in TApplication. +

+ + Please note: Some Linux window managers do not support task bar behaviors. For example: Cinnamon. + + - ? Show TaskBar buttons according to the platform default @@ -6307,23 +6901,23 @@ - Application management and configuration for a GUI application. - + Application management and configuration for a GUI application

- Provides a message loop, hooks for application event handlers, and more. + TApplication is a TCustomApplication descendant which provides facilities used to manage and configure a GUI application. Properties, methods, and event handlers are provided which allow a program to create, execute, monitor, maintain and destroy an application and its forms. Every GUI application contains an Application variable that represents the TApplication or descendent class instance.

- Includes the useful function MessageBox, a simple dialog intended for displaying error messages, but also usable as an alternative to the various Message Dialogs. -

-

- Other project types have a different Application class. + TApplication provides a message processing loop that includes hooks for event handlers and exception handling, and supports dispatching messages for TCustomAction instances used in application forms. TApplication provides support for Hints and content-sensitive help for forms and controls used in the application. Convenience methods, like MessageBox, are provided to simplify access to dialogs and error messages in the application.

+ + + Needs more (or better) descriptions. + + - or no?? @@ -6966,20 +7560,38 @@ - + Configures a hint window for the specified mouse position +

+ ActivateHint is a procedure used to configure a hint window display at the coordinates specified in CursorPos. +

+

+ ActivateHint retrieves the hint information at the mouse position. If the control for the hint differs from the current hint control, the existing hint is deactivated. The new hint window sets its hint timer and calculates the rectangle for the hint window. +

+

+ If a hint is not availabe for the specified mouse position, the CancelHint method is called. +

+

+ ActivateHint is used in the implementation of the DoOnMouseMove and ShowHintWindow methods. +

+ + + + + + + - ? - + Mouse cursor position used to retrieve the hint information - + Indicates if hint controls are used to compared existing and new hint windows @@ -7160,11 +7772,10 @@ - what? + ? - ? @@ -7275,9 +7886,28 @@ Initializes the widget set (and more) +

+ Initialize is an overridden procedure in TApplication used to perform initialization tasks for the application. Initialize calls the inherited method to provide supprt for instance counting in the custom application. Initialize ensures that the WidgetSet class type is assigned for the application, and that the Screen singleton is initialized and updated. +

+

+ Initialize raises an Exception if WidgetSet has not been assigned, or contains a class type other than TWidgetSet, for the application. +

+

+ Initialize updates the Flags property to include the value AppInitialized when both the LCL interface (Widget set) and the Screen singleton have been configured. +

+

+ Initialize loads the graphic image used in the Icon property. If a resource with the name MAINICON is included in the Lazarus Resource, it is loaded and used as the application icon. Otherwise, FindResource is called to locate and load the named icon from the resource handle. +

+ + Raises an Exception if the Widget Set class is invalid or not assigned. + - + + + + + @@ -8396,7 +9026,7 @@ - Allows to switch between controls by pressing keys + Allows switching between controls using keyboard navigation

These keys can be enabled for navigation:

    @@ -8414,35 +9044,59 @@ - The application terminates when this form is closed. - + The application terminates when this form is closed

    - This property is set when the first form is created via Application.CreateForm and it is not FormStyle=fsSplash. + This property is set when the first form is created using the CreateForm method when FormStyle contains a valueother than fsSplash.

    - The Handle of the MainForm + Window handle for the MainForm in the application +

    + MainFormHandle is a read-only HWND property which contains the handle for the form instance used as the main form in the application. +

    +

    + The value for the property is derived using the OnGetMainFormHandle event handler (when assigned) or a TGetHandleEvent handler assigned in the application. When neither of these mechanisms provides a value other than zero (0), the window handle assigned in the MainForm property is used. +

    +

    + MainFormHandle is used in the implementation of methods in WidgetSet classes, primarily for the Windows platform, and in custom drawn controls. +

    + + - ?     + Controls whether a button is displayed on the task bar for the main form in the application +

    + MainFormOnTaskBar is a Boolean property which determines whether the icon for the main form in the appliciation is displayed on the task bar. When MainFormOnTaskBar is set to True, a button representing the main form is displayed on the task bar area in the window manager. When set to False, the button is not displayed in the task bar area. +

    +

    + 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. +

    +

    + The default value for the property is normally set in the Lazarus project file (.lpr) used to compile the application. +

    + + + - ?     @@ -9316,7 +9970,7 @@ - ??? + ? @@ -9554,14 +10208,14 @@ - + Pointer to focus state information for the last active control in an application ? - Returns the remembered control + Returns the last focused control in an application @@ -9573,7 +10227,7 @@ - Remembers the control in LastFocusedControl + Restores the last focused control in an application to specified value @@ -9671,18 +10325,28 @@ - - + Gets a valid parent form for the specified control + +

    + ValidParentForm is a TCustomForm function used to get a valid parent form for the control specified in the Control argument. TopForm indicates if the return value should contain the absolute root ancestor in the ancestry tree. ValidParentForm calls GetParentForm to get the return value for the routine. +

    +

    + ValidParentForm raises an EInvalidOperation exception with the message in sParentRequired when a valid parent form is not found for the specified control. +

    +     + + Raises an EInvalidOperation exception with the message in sParentRequired when a valid parent form is not found for the specified control. +     - + Form instance that is the parent form for the control - + Control examined in the routine - + True if all parent forms are located in the routine @@ -9968,15 +10632,6 @@ - - Override the Cursor property with a temporary value. Use EndTempCursor to release it. - - - Release the temporary cursor set with BeginTempCursor. - - - Get the Cursor property with taking temporary cursors into account. -