diff --git a/docs/xml/lcl/interfacebase.xml b/docs/xml/lcl/interfacebase.xml index 20881e81f7..b3c3546508 100644 --- a/docs/xml/lcl/interfacebase.xml +++ b/docs/xml/lcl/interfacebase.xml @@ -54,7 +54,6 @@ to add or remove event handlers in the class instance. Pointer to a process event handler routine. -

PProcessEventHandler is an alias to the Pointer type. It is used in widgetset @@ -274,7 +273,9 @@ classes. - + +Structure with the parameters for the message and its result code. + @@ -864,11 +865,13 @@ be preprocessed or modified prior to starting an application. - + + + @@ -917,7 +920,10 @@ it when adequate. - + +TScreenInfo instance with the PPI (Pixels per Inch) and color depth for the +platform. + @@ -926,8 +932,8 @@ Enters a state in which the application waits for system messages.

-Called by Application.Run. Don't call this directly, the LCL will use it when -adequate. +Called by Application.Run. Don't call this directly. The LCL will use it when +needed.

@@ -1007,16 +1013,20 @@ use it when adequate. Sets the icon in the taskbar.

-Don't call this directly, the LCL will use it when adequate. +Don't call this directly. The LCL will use it when needed.

- + +HICON handle for the small icon for the application. + - + +HICON handle for the large icon for the application. + @@ -1029,7 +1039,9 @@ Don't call this directly, the LCL will use it when adequate. - + +Value stored as the Title for the application. + @@ -1042,14 +1054,16 @@ Don't call this directly, the LCL will use it when adequate. - + +True if the application is visible. + Resets all StayOnTop windows to NoTopmost.

-Don't call this directly, the LCL will use it when adequate. +Don't call this directly. The LCL will use it when needed.

@@ -1058,7 +1072,10 @@ Don't call this directly, the LCL will use it when adequate. False on failure.
- + +Indicates if the System Stay On Top flag is removed too. The default value +is False. + @@ -1173,16 +1190,24 @@ class to use the image format and device context needed for the platform. - + +TGraphicsColor value with the color for the specified pixel. + - + +Handle (device context) with the image data examined in the method. + - + +Horizontal coordinate for the pixel examined in the method. + - + +Vertical coordinate for the pixel examined in the method. + @@ -1196,16 +1221,24 @@ class to use the image format and device context needed for the platform. - + +Handle (device context) with the image data updated in the method. + - + +Horizontal coordinate for the pixel updated in the method. + - + +Vertical coordinate for the pixel updated in the method. + - + +Color value for the specified pixel. + @@ -1245,12 +1278,20 @@ AntialiasingMode property is changed. - - + +Sets the flag which indicates a designer is active for the specified component. + + +

+Not used in the current LCL version. +

+
- + +Component for the designer flag value. + @@ -4404,7 +4445,7 @@ point a second time at the end. -Draws a sequence of lines. +Draws a sequence of lines between the specified points.

Use Polyline to connect a set of points on the canvas. @@ -4462,11 +4503,10 @@ The two parameters WParam and LParam will be passed along to the window together with the Msg identification number.

-The difference between SendMessage and PostMessage is the way that they -return control to the calling thread. With SendMessage control is not -returned until the window that the message was sent to has completed -processing the sent message, however with PostMessage control is returned -immediately. +The difference between SendMessage and PostMessage is the way that they return +control to the calling thread. With SendMessage, control is not returned until +target window has completed processing the message. With PostMessage, control +is returned immediately.

@@ -4923,11 +4963,10 @@ The two parameters WParam and LParam will be passed to the message handler, together with the message ID.

-The difference between SendMessage and PostMessage is the way that they -return control to the calling thread. With SendMessage control is not -returned until the window that the message was sent to has completed -processing the sent message, however with PostMessage control is returned -immediately. +The difference between SendMessage and PostMessage is the way that they return +control to the calling thread. With SendMessage, control is not returned until +the target window has completed processing the message. With PostMessage, +control is returned immediately.

@@ -7479,7 +7518,10 @@ AThen. Returns False when AMemSize is zero (0).
- + +Specifies the function called for a given platform to display and execute an +input dialog using the specified values. + @@ -7487,16 +7529,23 @@ AThen. Returns False when AMemSize is zero (0). - + +Value displayed as the caption or title for the input dialog. + - + +Contains the text displayed as the main content for the input dialog. + - + +Returns the value entered in the edit control for the input dialog. Contains +the initial value for the edit control on entry. + @@ -7563,33 +7612,53 @@ AThen. Returns False when AMemSize is zero (0). - + +Specifies a function called to load a bitmap image from the specified file or +resource and return the handle for the image. + - + + + - + +HBitmap handle for the bitmap image loaded in the routine. + - + +Handle for the resource where the specified bitmap is stored. + - + +Name for the bitmap loaded in the routine. + - + +Specifies a function called to load a cursor shape with the specified +identifier and return the handle for the cursor image. + - + +HCursor handle for the specified cursor shape. + - + +Handle for the resource where the specified cursor is stored. + - + +Identifier for the cursor shape loaded in the routine. + @@ -7626,15 +7695,33 @@ AThen. Returns False when AMemSize is zero (0). - - - + +Variable with the function called to load a bitmap from a specified file or +resource and return its handle. + + +

+Called from LoadBitmap implemented for the Windows platform widgetset. +

+
+ + +
- - - + +Variable with the function called to load an icon from a specified file or +resource and return its handle. + + +

+Called from LoadIcon implemented for the Windows platform widgetset. +

+
+ + +
@@ -7646,11 +7733,17 @@ Provides access to the widgetset class instance for the platform. WidgetSet is a unit global TWidgetSet variable with the singleton used to access the widgetset class instance for the platform. WidgetSet contains a TWidgetSet descendant which implements the properties, -methods, and events for a specific platform. +methods, and events for a specific platform. +

+

+The value for the variable is assigned when the CreateWidgetset routine in +forms.pp is called. This occurs during initialization of the +interfaces.pp unit for a given platform.

+CreateWidgetset