From d7e3d2231f9dfab8f5c22bf1bafcc533abe61f6b Mon Sep 17 00:00:00 2001 From: dsiders Date: Tue, 20 Dec 2022 08:35:00 +0000 Subject: [PATCH] Docs: LCL/lclplatformdef. Adds DirNameToDisplayName and DisplayNameToDirName topics for changes in c45dfb7a. --- docs/xml/lcl/lclplatformdef.xml | 99 ++++++++++++++++++++++++++++++++- 1 file changed, 97 insertions(+), 2 deletions(-) diff --git a/docs/xml/lcl/lclplatformdef.xml b/docs/xml/lcl/lclplatformdef.xml index 6f7c92266e..9bb0749ce1 100644 --- a/docs/xml/lcl/lclplatformdef.xml +++ b/docs/xml/lcl/lclplatformdef.xml @@ -113,13 +113,108 @@ widgetset override has been provided on the command line. Directory name to convert to a TLCLPlatform enumeration value. + + +Gets the descriptive name for the LCL widgetset located in the specified +directory name. + + +

+DirNameToDisplayName is String function used to get the +descriptive name associated with the specified widgetset directory name. +

+

+ADirName contains the widgetset directory handled in the routine. +It is not a full path - or even a relative path - it simply a directory name +like 'qt5' or 'win32'. +

+

+DirNameToDisplayName calls DirNameToLCLPlatform to get the TLCLPlatform +enumeration value for the widgetset directory. If ADirName is not found, the +lpGtk2 platform is assumed. The enumeration value is used an an index into the +LCLPlatformDisplayNames constant where the return value is stored. +

+

+Use DisplayNameToDirName to convert the descriptive name back to the directory +where the widgetset files are found. +

+
+ +Added in LCL 2.4. + + + + + + + +
+ + +Descriptive name for the specified widgetset directory. + + + + +Widgetset directory name converted in the routine. + + + + + +Gets the directory name where the widgetset files are stored for the specified +descriptive name. + + +

+DisplayNameToDirName is a String function used to +convert the specified descriptive name for a widgetset to the directory where +its files are stored. +

+

+The return value refers to a directory located in the +($LazarusDir)/lcl/interfaces directory. +

+

+ADisplayName contains the descriptive name for the widgetset as returned from +DirNameToDisplayName, and should contain a value from the +LCLPlatformDisplayNames constant. Case is not significant for the argument +value. +

+

+DisplayNameToDirName iterates over the values in LCLPlatformDisplayNames to +locate the position for the value in ADisplayName. The corresponding value +from LCLPatformDirNames is used as the return value. If the specified +descriptive name is not found, the value 'gtk2' is used. +

+
+ +Added in LCL 2.4. + + + + + + + +
+ + +Directory name where the files for the specified widgetset are located. + + + + +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. + the various platform defines.