paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-09-12 09:39:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL,LazUtils/various. Adds and updates topics for changes in b0a3e49d.

Browse Source
This commit is contained in:
dsiders 2023-06-15 18:54:18 +01:00
parent 055ae4d900
commit 29293b283c
3 changed files with 72 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
docs/xml/lazutils/lazversion.xml
View File

@ -21,6 +21,22 @@ numbers in the <file>lclversion.pas</file> unit.
</p>
</descr>
<element name="TLCLWidgetTypeNameEvent">
<short>
Type used for the OnLCLWidgetTypeName function variable.
</short>
<descr>
Used in the GetLCLWidgetTypeName routine to get the name for the widgetset on the current platform.
</descr>
<seealso>
<link id="OnLCLWidgetTypeName"/>
<link id="GetLCLWidgetTypeName"/>
</seealso>
</element>
<element name="laz_major">
<short>Major version number for the Lazarus IDE.</short>
<descr>
@ -89,6 +105,53 @@ Added in revision 57504, and available since Lazarus 1.8.4.
</version>
</element>
<element name="OnLCLWidgetTypeName">
<short>
Variable which contains the handler routine signalled to get the name for the
current LCL widgetset.
</short>
<descr>
<p>
The value for the variable is assigned in the initialization section for the
<file>interfacebase.pp</file> 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.
</p>
</descr>
<seealso>
<link id="TLCLWidgetTypeNameEvent"/>
<link id="lcl.interfacebase.GetLCLWidgetTypeName">InterfaceBase.GetLCLWidgetTypeName</link>
</seealso>
</element>
<element name="GetLCLWidgetTypeName">
<short>
Routine called to get the type name for the widgetset class used on the
platform.
</short>
<descr>
<p>
<var>GetLCLWidgetTypeName</var> signals the <var>OnLCLWidgetTypeName</var>
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 ('').
</p>
</descr>
<seealso>
<link id="TLCLWidgetTypeNameEvent"/>
<link id="#lcl.interfacebase.GetLCLWidgetTypeName">InterfaceBase.GetLCLWidgetTypeName</link>
<link id="#lcl.lclplatformdef.LCLPlatformDirNames">LCLPlatformDirNames</link>
<link id="#lcl.lclplatformdef.TLCLPlatform">TLCLPlatform</link>
</seealso>
</element>
<element name="GetLCLWidgetTypeName.Result">
<short>
String representation for the widgetset class used for the platform.
</short>
</element>
</module>
<!-- LazVersion -->
</package>

6
docs/xml/lcl/interfacebase.xml
View File

@ -16,6 +16,11 @@ Provides a platform-independent widgetset class and helper functions.
define a platform-independent widgetset class (<var>TWidgetSet</var>) and
helper functions.
</p>
<remark>
Modified in LCL version 2.4.0 to assign the GetLCLWidgetTypeName routine in
this unit to the OnLCLWidgetTypeName function variable in
<file>lazversion.pas</file> during unit initialization.
</remark>
<p>
<file>interfacebase.pp</file> is part of the Lazarus Component Library
(<b>LCL</b>).
@ -40,6 +45,7 @@ helper functions.
<element name="LazLoggerBase"/>
<element name="GraphType"/>
<element name="GraphMath"/>
<element name="LazVersion"/>
<element name="PEventHandler">
<short>Pointer to an event handler routine.</short>

5
docs/xml/lcl/lclplatformdef.xml
View File

@ -214,13 +214,14 @@ Descriptive name for the requested widgetset directory.
<short>Gets the value in the BuildLCLWidgetType variable.</short>
<descr>
<p>
Used in the <var>lazbuild</var> utility to get the target widgetset used for
the various platform defines.
Used by the GetDefaultLCLWidgetType routine (in <file>interfacebase.pp</file>)
to get the type and name for the target widgetset.
</p>
</descr>
<seealso>
<link id="BuildLCLWidgetType"/>
<link id="TLCLPlatform"/>
<link id="#lcl.interfacebase.GetDefaultLCLWidgetType">InterfaceBase.GetDefaultLCLWidgetType</link>
</seealso>
</element>
<element name="GetBuildLCLWidgetType.Result">