Docs: LCL/wsreferences. Adds and updates topic content.

This commit is contained in:
dsiders 2023-07-17 17:13:06 +01:00
parent cbd558db3b
commit e970946e2d

View File

@ -72,16 +72,18 @@ TLCLHandle is used in the implementation of classes like:
<li>TBrush</li> <li>TBrush</li>
<li>TPen</li> <li>TPen</li>
<li>TCursorImage</li> <li>TCursorImage</li>
<li>TChangeLink</li>
<li>TCustomImageListResolution</li>
<li>TCustomImageList</li> <li>TCustomImageList</li>
<li>TCustomImageListResolution</li>
<li>TChangeLink</li>
<li>TRegion</li> <li>TRegion</li>
<li>TTreeNode</li> <li>TTreeNode</li>
<li>TTreeNodes</li> <li>TTreeNodes</li>
</ul> </ul>
<remark> <remark>
TLCLHandle is the replacement for the redefined THandle alias in LCL versions TLCLHandle is the replacement for the redefined THandle alias in LCL versions
prior to 4.0. THandle is deprecated in LCL 4.0; use TLCLHandle instead. prior to 4.0. THandle is deprecated in LCL 4.0; TLCLHandle is used instead.
THandle is still used in the FPC RTL (and in LazUtils) to represent files,
file or handle streams, sockets, IO devices, processes, etc.
</remark> </remark>
</descr> </descr>
<seealso> <seealso>
@ -95,9 +97,14 @@ prior to 4.0. THandle is deprecated in LCL 4.0; use TLCLHandle instead.
<short> <short>
Pointer to a TLCLHandle instance. Pointer to a TLCLHandle instance.
</short> </short>
<descr/> <descr>
<p>
Used when accessing cached resource items in the LCL.
</p>
</descr>
<seealso> <seealso>
<link id="TLCLHandle"/> <link id="TLCLHandle"/>
<link id="#lcl.lclrescache.ComparePHandleWithResourceCacheItem">ComparePHandleWithResourceCacheItem</link>
</seealso> </seealso>
</element> </element>
@ -105,8 +112,16 @@ Pointer to a TLCLHandle instance.
<short> <short>
Pointer to a widget set reference instance. Pointer to a widget set reference instance.
</short> </short>
<descr/> <descr>
<seealso/> <p>
Used in the implementation of the TLCLReferenceComponent and descendants, and
returned by their WSCreateReference methods.
</p>
</descr>
<seealso>
<link id="#lcl.lclclasses.TLCLReferenceComponent.WSCreateReference">TLCLReferenceComponent.WSCreateReference</link>
<link id="#lcl.imglist.TCustomImageListResolution.WSCreateReference">TCustomImageListResolution.WSCreateReference</link>
</seealso>
</element> </element>
<element name="TWSReference"> <element name="TWSReference">
@ -115,55 +130,99 @@ Represents a reference to a widget set class instance.
</short> </short>
<descr> <descr>
<p> <p>
Abstract (temporary) base object for all references to WS classes. This Abstract (temporary) base object for all references to widgetset classes. This
reference replaces the functionality of a Handle. An object is choosen to reference replaces the functionality of a Handle. An object is used to
disallow assignments using different types of handles. disallow assignments using different types of handles. It is used as the base
class for widgetset descendants like TWSCustomImageListReference,
TWSGDIObjReference, TWSDeviceContextReference, and TWSIconReference.
</p> </p>
</descr> </descr>
<seealso/> <seealso/>
</element> </element>
<!-- private -->
<element name="TWSReference.GetAllocated"/> <element name="TWSReference.GetAllocated"/>
<element name="TWSReference.GetAllocated.Result"/> <element name="TWSReference.GetAllocated.Result"/>
<!-- protected -->
<element name="TWSReference.FRef"> <element name="TWSReference.FRef">
<short/> <short>
Variant record type which allows access to TLCLHandle and Pointer values in
the reference.
</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TWSReference._Clear"> <element name="TWSReference._Clear">
<short/> <short>
<descr/> Clears the handle assigned in the reference.
</short>
<descr>
<p>
Sets the internal Pointer for the reference to <b>Nil</b>.
</p>
<remark>
This method, and the others with a '_' prefix, are temporary and for widgetset
use only. They can be removed at any time, and without any prior notice.
</remark>
</descr>
<seealso/> <seealso/>
</element> </element>
<element name="TWSReference._Init"> <element name="TWSReference._Init">
<short/> <short>
<descr/> Stores the specified handle or pointer to an internal member in the reference.
<seealso/> </short>
<descr>
<remark>
This method, and the others with a '_' prefix, are temporary and for widgetset
use only. They can be removed at any time, and without any prior notice.
</remark>
</descr>
<seealso>
<link id="TLCLHandle"/>
</seealso>
</element> </element>
<element name="TWSReference._Init.APtr"> <element name="TWSReference._Init.APtr">
<short/> <short>
Pointer to the handle stored in the reference.
</short>
</element> </element>
<element name="TWSReference._Init.AHandle"> <element name="TWSReference._Init.AHandle">
<short/> <short>
TLCLHandle instance stored in the reference.
</short>
</element> </element>
<element name="TWSReference._Handle"> <element name="TWSReference._Handle">
<short/> <short/>
<descr/> <descr>
<seealso/> <p>
Gets the TLCLHandle instance assigned to the reference.
</p>
<remark>
This method, and the others with a '_' prefix, are temporary and for widgetset
use only. They can be removed at any time, and without any prior notice.
</remark>
</descr>
<seealso>
<link id="TLCLHandle"/>
</seealso>
</element> </element>
<element name="TWSReference.Allocated"> <element name="TWSReference.Allocated">
<short/> <short>
Contains <b>True</b> if a handle has been assigned in the reference.
</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TWSReference.Ptr"> <element name="TWSReference.Ptr">
<short/> <short>
Returns a Pointer with the handle for the reference.
</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -173,8 +232,11 @@ disallow assignments using different types of handles.
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TWSCustomImageListReference.Handle"> <element name="TWSCustomImageListReference.Handle">
<short/> <short/>
<descr/>
<seealso/>
</element> </element>
<element name="TWSGDIObjReference"> <element name="TWSGDIObjReference">
@ -188,8 +250,11 @@ disallow assignments using different types of handles.
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TWSBitmapReference.Handle"> <element name="TWSBitmapReference.Handle">
<short/> <short/>
<descr/>
<seealso/>
</element> </element>
<element name="TWSBrushReference"> <element name="TWSBrushReference">