1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
Documentation for LCL (Lazarus Component Library) and LazUtils (Lazarus
Utilities) are published under the Creative Commons Attribution-ShareAlike 4.0
International public license.
https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt
https://gitlab.com/freepascal.org/lazarus/lazarus/-/blob/main/docs/cc-by-sa-4-0.txt
Copyright (c) 1997-2025, by the Lazarus Development Team.
-->
<fpdoc-descriptions>
<package name="lazutils">
<!--
======================================================================
LazVersion
======================================================================
-->
<module name="LazVersion">
<short>
Contains constants which identify the version numbers for the Lazarus IDE
installed on the local system.
</short>
<descr>
<p>
Values in the unit are used as the basis for corresponding LCL version
numbers in the <file>lclversion.pas</file> unit.
</p>
<p>
<b>Please note that version numbers used for Lazarus, and the LCL and LazUtils
libraries were changed starting with version 3.0.</b> They continue to use a
four-part version numbering scheme, like 3.0.0.1, where the component values
are:
</p>
<ul>
<li>Major version number</li>
<li>Minor version number</li>
<li>Release number</li>
<li>Patch level</li>
</ul>
<p>
Starting in version 3.0, the release part of the full version number is no
longer maintained. While still included in the full version value, the release
number will always be 0 (zero) starting with version 3.0. Major and minor
version numbers are used to identify a release or a fixes branch.
</p>
<p>
An even minor version number, like 3.0 or 3.2, represents a general
availability release. An odd minor version number no longer indicates that it
is a development (or trunk) version. Instead, an odd minor version number
like 3.1 or 3.3 represents a fixes branch. For example: 3.1 would contain bug
fixes for the 3.0 release and would be used as the basis for the 3.2
release. Development (or trunk) versions are always represented as minor
version number 99; i.e. 3.99 is the development branch for the future 4.0
release. Also, selected commits from this branch are cherry picked to the 3.X
family.
</p>
<p>
Patch numbers identify a release candidate or a general availability release.
For example: 3.0.0 RC1 has the full version value of 3.0.0.1. RC2 has the
value 3.0.0.2, and the released product could be 3.0.0.3.
</p>
<p>
<file>lazversion.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>
<element name="TLCLWidgetTypeNameEvent">
<short>
Type used for the OnLCLWidgetTypeName function variable.
</short>
<descr>
<p>
Used in the GetLCLWidgetTypeName routine to get the name for the widgetset on
the current platform.
</p>
</descr>
<seealso>
<link id="OnLCLWidgetTypeName"/>
<link id="GetLCLWidgetTypeName"/>
</seealso>
</element>
<element name="laz_major">
<short>Major version number for the Lazarus IDE.</short>
<descr>
<p>
For the Lazarus version number 2.3.0.42, the value in laz_major is 2.
</p>
</descr>
<seealso/>
<version>
Added in revision 57504, and available since Lazarus 1.8.4.
</version>
</element>
<element name="laz_minor">
<short>Minor version number for the Lazarus IDE.</short>
<descr>
<p>
For the Lazarus version number 2.3.0.42, the value in laz_minor is 3.
</p>
<p>
<b>Please note:</b> Starting with Lazarus version 3.0, laz_minor is
incremented by 1 for each new release or fixes branch. For example: 3.0, 3.1,
3.2, etc. An even minor version number, like 3.0 or 3.2, represents a general
availability release. An odd minor version number no longer indicates that it
is a development (or trunk) version. Instead, an odd minor version number
like 3.1 or 3.3 represents a fixes branch. For example: 3.1 would contain bug
fixes for the 3.0 release and would be used as the basis for the 3.2 release.
Development (or trunk) versions are always represented as minor version number
99; i.e. 3.99 is the development branch for the future 4.0 release. Also,
selected commits from this branch are cherry picked to the 3.X family.
</p>
</descr>
<seealso/>
<version>
<p>
Added in revision 57504, and available since Lazarus 1.8.4.
</p>
<p>
Usage context modified in Lazarus version 3.0.
</p>
</version>
</element>
<element name="laz_release">
<short>Release number for the Lazarus IDE.</short>
<descr>
<p>
For the Lazarus version number 2.3.0.42, the value in laz_release is 0.
</p>
<p>
<b>Please note:</b> Starting with Lazarus 3.0, the release number is no longer
maintained and will always contain 0 (zero). Releases are represented using
the major and minor version numbers: 3.0, 3.1, 3.2, etc.
</p>
</descr>
<seealso/>
<version>
<p>
Added in revision 57504, and available since Lazarus 1.8.4.
</p>
<p>
No longer maintained starting with Lazarus 3.0.
</p>
</version>
</element>
<element name="laz_patch">
<short>Patch level for the Lazarus IDE.</short>
<descr>
<p>
For the Lazarus version number 2.3.0.42, the value in laz_patch is 42.
</p>
</descr>
<seealso/>
<version>
<p>
Added in revision 57504, and available since Lazarus 1.8.4.
</p>
</version>
</element>
<element name="laz_fullversion">
<short>Numeric version number for the Lazarus IDE.</short>
<descr>
<p>
For the Lazarus version number 2.3.0.42, the value in laz_fullversion is
2030042.
</p>
</descr>
<seealso/>
<version>
Added in revision 57504, and available since Lazarus 1.8.4.
</version>
</element>
<element name="laz_version">
<short>String with the full version number for the Lazarus IDE.</short>
<descr>
<p>
For the Lazarus version number 3.0.0.3, the value in laz_version is
'3.0.0.3'.
</p>
</descr>
<seealso/>
<version>
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"/>
</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>
</fpdoc-descriptions>
|
