paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-27 10:20:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL, LazUtils. Updates topics for changes in 53fe133e.

Browse Source 
(cherry picked from commit 6bcaef208f)
This commit is contained in:
dsiders 2021-11-16 00:07:27 +00:00 committed by Maxim Ganetsky
parent 48beacf452
commit 454da4cb26
3 changed files with 51 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/xml/lazutils/graphtype.xml
View File

@ -24,14 +24,26 @@
<element name="SysUtils"/>
<element name="Types"/>
<element name="Math"/>
<element name="System.UITypes"/>
<element name="FPCAdds"/>
<element name="LazLoggerBase"/>
<element name="TGraphicsColor">
<short>Defines the Integer range type with values that can be used for colors.</short>
<descr/>
<descr>
<p>
TGraphicsColor is an alias to the range type used for color constants. The base type for the definition is dependent on the FPC compiler version used to build the LazUtils package.
</p>
<p>
Starting in FPC version 3.2.3, the base type is the TColor type defined in the System.UITypes namespace in the FPC run-time library (RTL). For previous compiler versions, the base type is the numeric range -$7FFFFFFF-1..$7FFFFFFF.
</p>
<p>
This is done to prevent type conflicts when both System.UITypes and LCL/LazUtils units are used.
</p>
</descr>
<seealso>
<link id="#lcl.graphics.TColor">TColor</link>
<!-- link id="#rtl.system.uitypes.TColor"/ -->
</seealso>
</element>

11
docs/xml/lcl/graphics.xml
View File

@ -49,6 +49,7 @@
<element name="FPReadTiff"/>
<element name="FPTiffCmn"/>
<element name="FPReadGif"/>
<element name="System.UITypes"/>
<element name="LCLVersion"/>
<element name="LCLStrConsts"/>
<element name="LCLType"/>
@ -68,7 +69,14 @@
<element name="PColor">
<short>Pointer to the TColor type.</short>
<descr/>
<descr>
<p>
The base type used for the definition is dependent on the FPC compiler version used to build the LCL. Starting in FPC version 3.2.3, the base type is the type defined in the System.UITypes namespace in the FPC run-time library (RTL). For previous compiler versions, the base type is a pointer to TColor.
</p>
<p>
This is done to prevent type conflicts when both System.UITypes and LCL units are used.
</p>
</descr>
<seealso/>
</element>
<element name="TColor">
@ -104,6 +112,7 @@
</p>
</descr>
<seealso>
<link id="#lazutils.graphtype.TGraphicsColor">TGraphicsColor</link>
<link id="ColorToRGB"/>
<link id="RGBToColor"/>
<link id="clBlack"/>

34
docs/xml/lcl/lcltype.xml
View File

@ -17,6 +17,7 @@
<!-- unresolved external references -->
<element name="UTF8Bidi"/>
<element name="Windows"/>
<element name="System.UITypes"/>
<element name="Classes"/>
<element name="SysUtils"/>
@ -6916,16 +6917,35 @@
<descr/>
<seealso/>
</element>
<!-- alias type Visibility: default -->
<element name="COLORREF">
<short/>
<descr/>
<seealso/>
<short>Represents color constants in the LCL.</short>
<descr>
<p>
COLORREF is the type used for color constants defined in the LCL. It is interchangeable with the TColorRef type; TColorRef is an alias for COLORREF.
</p>
<p>
The base type used for the definition is dependent on the compiler version used to build the LCL. Starting in FPC version 3.2.3, the base type is the TColorRef type defined in the System.UITypes namespace in the FPC run-time library (RTL). For previous compiler versions, the base type is Cardinal.
</p>
<p>
This is done to prevent type conflicts when both System.UITypes and LCL units are used.
</p>
<p>
Values in COLORREF (and TColorRef) are normally OR'd with the value $80000000 to prevent interference with other MS color enumeration values.
</p>
</descr>
<seealso>
<link id="TColorRef"/>
<!-- link id="#rtl.system.uitypes.TColorRef"/ -->
</seealso>
</element>
<!-- alias type Visibility: default -->
<element name="TColorRef">
<short>TColor, TColorRef.</short>
<short>Represents color constants in the LCL.</short>
<descr>
<p>
TColorRef is an alias for the COLORREF type, and is used for color constants defined in the LCL.
</p>
<p>
Values from 0..$FFFFFF are BGR colors. The lowest 8 bit are the blue component, the middle 8 bit the green component and the highest 8 bit the red component. Use the functions Red, Green, Blue to extract the components, RedGreenBlue to extract all three components and RGBToColor to convert the three colors to a TColor.
</p>
@ -6936,7 +6956,9 @@
A system color can change during run-time, so do not store them. Use system colors only on LCL control Canvas. They probably are not defined for printer canvas and some are not defined on bitmap canvas.
</p>
</descr>
<seealso/>
<seealso>
<link id="COLORREF"/>
</seealso>
</element>
<!-- constant Visibility: default -->
<element name="CLR_NONE">