From 29293b283c76b58f7651c9620d3fe4836551ab04 Mon Sep 17 00:00:00 2001
From: dsiders
Date: Thu, 15 Jun 2023 18:54:18 +0100
Subject: [PATCH] Docs: LCL,LazUtils/various. Adds and updates topics for
changes in b0a3e49d.
---
docs/xml/lazutils/lazversion.xml | 63 ++++++++++++++++++++++++++++++++
docs/xml/lcl/interfacebase.xml | 6 +++
docs/xml/lcl/lclplatformdef.xml | 5 ++-
3 files changed, 72 insertions(+), 2 deletions(-)
diff --git a/docs/xml/lazutils/lazversion.xml b/docs/xml/lazutils/lazversion.xml
index c816dabe0b..64547d4e24 100644
--- a/docs/xml/lazutils/lazversion.xml
+++ b/docs/xml/lazutils/lazversion.xml
@@ -21,6 +21,22 @@ numbers in the lclversion.pas unit.
+
+
+Type used for the OnLCLWidgetTypeName function variable.
+
+
+
+Used in the GetLCLWidgetTypeName routine to get the name for the widgetset on the current platform.
+
+
+
+
+
+
+
+
+
Major version number for the Lazarus IDE.
@@ -89,6 +105,53 @@ Added in revision 57504, and available since Lazarus 1.8.4.
+
+
+
+Variable which contains the handler routine signalled to get the name for the
+current LCL widgetset.
+
+
+
+The value for the variable is assigned in the initialization section for the
+interfacebase.pp unit. It is set to the GetLCLWidgetTypeName
+routine in that unit. Please note that the GetLCLWidgetTypeName routine exists
+in both units; this one calls the other.
+
+
+
+
+InterfaceBase.GetLCLWidgetTypeName
+
+
+
+
+
+Routine called to get the type name for the widgetset class used on the
+platform.
+
+
+
+GetLCLWidgetTypeName signals the OnLCLWidgetTypeName
+event handler (when assigned) to get the type name for the widgetset. The
+return value contains the String from LCLPlatformDirNames that represents the
+TLCLPlatform for the widgetset. If OnLCLWidgetTypeName has not been assigned,
+the return value is an empty string ('').
+
+
+
+
+InterfaceBase.GetLCLWidgetTypeName
+LCLPlatformDirNames
+TLCLPlatform
+
+
+
+
+String representation for the widgetset class used for the platform.
+
+
+
diff --git a/docs/xml/lcl/interfacebase.xml b/docs/xml/lcl/interfacebase.xml
index b3c3546508..6736f6742e 100644
--- a/docs/xml/lcl/interfacebase.xml
+++ b/docs/xml/lcl/interfacebase.xml
@@ -16,6 +16,11 @@ Provides a platform-independent widgetset class and helper functions.
define a platform-independent widgetset class (TWidgetSet) and
helper functions.
+
+Modified in LCL version 2.4.0 to assign the GetLCLWidgetTypeName routine in
+this unit to the OnLCLWidgetTypeName function variable in
+lazversion.pas during unit initialization.
+
interfacebase.pp is part of the Lazarus Component Library
(LCL).
@@ -40,6 +45,7 @@ helper functions.
+Pointer to an event handler routine.
diff --git a/docs/xml/lcl/lclplatformdef.xml b/docs/xml/lcl/lclplatformdef.xml
index a536e84b13..46f6cddbe1 100644
--- a/docs/xml/lcl/lclplatformdef.xml
+++ b/docs/xml/lcl/lclplatformdef.xml
@@ -214,13 +214,14 @@ Descriptive name for the requested widgetset directory.
Gets the value in the BuildLCLWidgetType variable.
-Used in the lazbuild utility to get the target widgetset used for
- the various platform defines.
+Used by the GetDefaultLCLWidgetType routine (in interfacebase.pp)
+to get the type and name for the target widgetset.