From 84fe2ee61c7de93c51f3b056ef8e55ab43b6697a Mon Sep 17 00:00:00 2001 From: dsiders Date: Mon, 10 Jul 2023 16:56:58 +0100 Subject: [PATCH] Docs: LCL/interfacebase. Updates topics for TLCLHandle changes in 211d95da. --- docs/xml/lcl/interfacebase.xml | 151 ++++++++++++++++++++++++++++----- 1 file changed, 130 insertions(+), 21 deletions(-) diff --git a/docs/xml/lcl/interfacebase.xml b/docs/xml/lcl/interfacebase.xml index e517c79ba4..4f300d62d8 100644 --- a/docs/xml/lcl/interfacebase.xml +++ b/docs/xml/lcl/interfacebase.xml @@ -51,6 +51,7 @@ this unit to the OnLCLWidgetTypeName function variable in + @@ -887,11 +888,56 @@ be preprocessed or modified prior to starting an application. - - + + +Gets the value for the AppHandle property. + + +

+Always returns 0 (the unassigned handle value) in TWidgetSet. It is overridden +in descendent classes to return the value provided for the platform. +

+ + +Modified in LCL version 4.0 to use the TLCLHandle type instead of the +deprecated THandle type for the property value. + + + +TLCLHandle + + + + +Value for the AppHandle property. + + - - + + +Sets the value for the AppHandle property. + + +

+SetAppHandle has an empty implementation in TWidgetSet. It is overridden in +descendent classes, and generally ensures that an assigned handle is not +unassigned after it has been created. +

+ + +Modified in LCL version 4.0 to use the TLCLHandle type instead of the +deprecated THandle type for the property value. + + + +TLCLHandle + + + + +New value for the AppHandle property. + + Constructor for the class instance. @@ -916,7 +962,7 @@ allocate the TThemeServices instance used in the BeforeDestruction is an overridden method used to perform actions needed prior to freeing the class instance. BeforeDestruction ensures that resources allocated for the ThemeServices property are freed and -nil'd. BeforeDestruction calls the inherited method prior to exit. +nil'd. BeforeDestruction calls the inherited method prior to exit.

@@ -1343,25 +1389,43 @@ Component for the designer flag value. -Creates a timer with the given callback method. - - - - -The timer ID, zero on failure. + +Creates a timer with the given callback method. + + +

+Declared as an abstract virtual method in TWidgetSet. Must be implemented in +a descendent class to use the platform-specific mechanism(s) required for the +implementation. +

+ +Modified in LCL version 4.0 to use the TLCLHandle type instead of the +deprecated THandle type in the return value. + + +TLCLHandle + + +The handle (or ID) for the timer. Zero on failure. + + -The time interval. +The timer interval before the callback is executed. -The callback method. + +The callback method executed when the timer interval has elapsed. + -Destroys a timer. + +Destroys the timer with the specified handle. +

Declared as an abstract virtual method in TWidgetSet. Must be implemented in @@ -1369,26 +1433,44 @@ a descendent class to use the platform-specific mechanism(s) required for the implementation.

+ +Modified in LCL version 4.0 to use the TLCLHandle type instead of the +deprecated THandle type in the TimerHandle parameter. + + +TLCLHandle -False on failure. + +True if the timer was successfully destroyed. False on failure. + -The timer ID. +Handle (or ID) for the timer destroyed in the method. -Native handle for a TApplication instance. + +Native handle for a TApplication instance. +

-AppHandle is a platform-specific property. The meaning and use for -the handle changes from widgetset to widgetset. +AppHandle is a TLCLHandle property with the handle for +the application in the widgetset class instance. AppHandle is a +platform-specific property. The meaning and use for the handle changes from +widgetset to widgetset.

- + +Modified in LCL version 4.0 to use the TLCLHandle type instead of the +deprecated THandle type in the property value. + + +TLCLHandle + @@ -7566,6 +7648,7 @@ the initial value for the edit control on entry. + @@ -7605,6 +7688,7 @@ the initial value for the edit control on entry. + @@ -7635,8 +7719,13 @@ Specifies a function called to load a bitmap image from the specified file or resource and return the handle for the image. + +Modified in LCL version 4.0 to use the TLCLHandle type instead of the +deprecated THandle type in the hInstance parameter. + +TLCLHandle @@ -7661,6 +7750,14 @@ Specifies a function called to load a cursor shape with the specified identifier and return the handle for the cursor image. + +Modified in LCL version 4.0 to use the TLCLHandle type instead of the +deprecated THandle type in the hInstance parameter. + + + +TLCLHandle + @@ -7679,10 +7776,19 @@ Identifier for the cursor shape loaded in the routine. + - + +Modified in LCL version 4.0 to use the TLCLHandle type instead of the +deprecated THandle type in the hInstance parameter. + + + + +TLCLHandle + @@ -7694,18 +7800,21 @@ Identifier for the cursor shape loaded in the routine. + + +