From f4daa8fde97f312f5b0d230698545dc7d725b19d Mon Sep 17 00:00:00 2001 From: dsiders Date: Sat, 27 Nov 2021 00:53:40 +0000 Subject: [PATCH] Docs: LCL/forms. Adds and updates topic content. * Adds new topics in TScreen for BeginScreenCursor, EndScreenCursor. * Corrects spelling errors. (cherry picked from commit c30173193133c6b4008b7e0f5db026d09c0d2d9a) --- docs/xml/lcl/forms.xml | 78 ++++++++++++++++++++++++++++++++++-------- 1 file changed, 63 insertions(+), 15 deletions(-) diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index 6743e961e5..09190e90e2 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -642,7 +642,7 @@ Create is the constructor for the class instance, and calls the inherited constructor on entry.

- Create sets the assocaited control for the class instance and the Kind property to the values specified in the AControl and AKind arguments. Create sets the default values for properties, including: + Create sets the associated control for the class instance and the Kind property to the values specified in the AControl and AKind arguments. Create sets the default values for properties, including:

Page
@@ -696,7 +696,7 @@

- IsScrollBarVisible is a Boolean function used to determine if the scroll bar for the associatied control is visible. The return value defaults to the value in the Visible property. If the handle has been allocated for the control, the GetScrollbarVisible routine from the LCL interface is used to get the visiblity for the scroll bar Kind. + IsScrollBarVisible is a Boolean function used to determine if the scroll bar for the associated control is visible. The return value defaults to the value in the Visible property. If the handle has been allocated for the control, the GetScrollbarVisible routine from the LCL interface is used to get the visibility for the scroll bar Kind.

IsScrollBarVisible is used in the implementation of the ClientSizeWithBar and ClientSizeWithoutBar methods. @@ -5787,7 +5787,7 @@ - Creates an assocation between the class type and its widgetset class. + 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. @@ -7039,6 +7039,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); + @@ -8108,27 +8109,31 @@ HintWindow.ActivateHint(Rect, 'This is the hint');

- BeginTempCursor is a method used to change the cursor shape to the temporary cursor in the ACursor argument. It adds the value in ACursor to an internal list of temporary cursors. The cursor shape is removed when the EndTempCursor method is called. + BeginTempCursor is a method used to change the mouse cursor shape to the temporary cursor in the ACursor argument. It adds the value in ACursor to an internal list of temporary cursors. The cursor shape is removed when the EndTempCursor method is called.

- BeginTempCursor calls SetCursor in the widgetset class to change the cursor shape to the value in Cursors stored at the index in ACursor. + BeginTempCursor calls SetCursor in the widgetset class to change the mouse cursor shape to the value in Cursors stored at the index in ACursor.

- Use EndTempCursor to remove a given cursor shape, and restore the cursor to a previous value. + Use EndTempCursor to remove a given cursor shape, and restore the mouse cursor to a previous value.

+ + + + TCursor - Identifies the temporary cursor shape to apply to the screen. + Identifies the temporary mouse cursor shape to apply to the screen. - Releases a temporary cursor set with BeginTempCursor. + Releases a temporary mouse cursor set with BeginTempCursor.

EndTempCursor is a method used to release the temporary cursor shape in ACursor. It removes the value from the internal list of temporary cursors updated in the BeginTempCursor method. Only the cursor shape in ACursor is removed from the list; other values are left intact. @@ -8140,7 +8145,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); An Exception is raised with the message 'Unbalanced BeginTempCursor/EndTempCursor calls for cursor' if ACursor is not found in the list of temporary cursors.

- Use BeginTempCursor to display and store a temporary cursor shape. + Use BeginTempCursor to display and store a temporary mouse cursor shape.

@@ -8150,7 +8155,11 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - + + + + + TCursor @@ -8166,20 +8175,59 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); + crHourGlass + TCursor - Removes the crHourGlass cursor shape. + Removes the crHourGlass mouse cursor shape.

- Calls EndTempCursor to remove the crHourGlass cursor shape. + Calls EndTempCursor to remove the crHourGlass mouse cursor shape.

crHourGlass + TCursor + + + + + Changes the active cursor to the most recent shape in the internal list of cursors. + +

+ Calls the BeginTempCursor method using the mouse cursor shape currently assigned to the internal member for the screen. +

+

+ Use EndScreenCursor to revert the mouse cursor shape to the value on entry to the method. +

+ + + + + + + + + + + Removes the current mouse cursor shape from the internal list, and restores the previous cursor shape. + + +

+ Calls the EndTempCursor method to remove the current mouse cursor shape from the internal list of cursors. The most recent cursor shape in the internal list is restored when it differs from the value assigned to Cursor. +

+

+ Use BeginScreenCursor to make the value in Cursor the current cursor shape for the screen. +

+ + + + + @@ -8239,7 +8287,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); Indicates the current mouse cursor shape.

- Cursor is a TCursor property which identifies the current cursor shape drawn on the screen. The numeric value is the HCURSOR handle for the image drawn as the cursor shape. Cursor constants (like crHourGlass) defined in the controls.pp unit can be used instead of the numeric value. + Cursor is a TCursor property which identifies the current mouse cursor shape drawn on the screen. The numeric value is the HCURSOR handle for the image drawn as the cursor shape. Cursor constants (like crHourGlass) defined in the controls.pp unit can be used instead of the numeric value.

Cursor is used as an index into the values in the Cursors property where the handle for the TCursorImage resources are stored. Changing the value for the property causes the SetCursor method in the widgetset class to be called to apply the handle in Cursors at the position in Cursor. @@ -8270,10 +8318,10 @@ HintWindow.ActivateHint(Rect, 'This is the hint'); - Provides indexed access to the available cursor shapes for the screen. + Provides indexed access to the available mouse cursor shapes for the screen.

- Cursors is an indexed HCURSOR property which provides access to the handle for a cursor shape by its numeric value. The cursor constants (like crHourGlass) defined in the controls.pp unit can be used instead of the numeric value. + Cursors is an indexed HCURSOR property which provides access to the handle for a mouse cursor shape by its numeric value. The cursor constants (like crHourGlass) defined in the controls.pp unit can be used instead of the numeric value.

Cursors uses an internal TMap instance to store the handle values and provides access using the index values. When the value for the property is read, CreateStandardCursor in the widgetset class is called to retrieve the handle. If it has not been assigned, a temporary TCursorImage is created for the cursor resource and its handle is added to the internal map.