diff --git a/docs/xml/lcl/wsreferences.xml b/docs/xml/lcl/wsreferences.xml index 6c1522b04e..062ffa9557 100644 --- a/docs/xml/lcl/wsreferences.xml +++ b/docs/xml/lcl/wsreferences.xml @@ -26,11 +26,68 @@ to a handle in widget set classes and LCL components. -The type used for handles in widget set classes and LCL components. +The type used for handles in LCL applications, components, controls, and widget set classes. - + +

+TLCLHandle is an alias for the PtrUInt (Pointer to +Unsigned Integer) type, and the type used to represent handles in the Lazarus +Component Library (LCL). +

+

+TLCLHandle differentiates the handle type used in LCL from the THandle type +used in the FPC Run-time Library (RTL) and numerous other libraries. It is +needed because the RTL THandle type is a longint (signed) value on 64-bit +Linux platforms and not suitable for use as a window handle in the +multi-platform LCL. +

+

+TLCLHandle is the type used to represent all handles for an application, +controls, and components in the LCL - including those in widgetset class +instances. In the LCL type system, it is equivalent to HWND (and related +identifiers like HDC, HFONT, HICON, HBRUSH, et. al.) used to identify window +objects and resources. TLCLHandle is one of the values that can be returned by +the TWSReference class used for widgetset class references (The other is a +Pointer to the TLCLHandle type). +

+

+TLCLHandle is used in the implementation of classes like: +

+
    +
  • TApplication
  • +
  • TLCLComponent
  • +
  • TLCLReferenceComponent
  • +
  • TCustomBitBtn
  • +
  • TCustomTimer
  • +
  • TCommonDialog
  • +
  • TScreen
  • +
  • TGraphic
  • +
  • TPicture
  • +
  • TSharedRasterImage
  • +
  • TRasterImage
  • +
  • TCustomBitmap
  • +
  • TSharedIcon
  • +
  • TCustomIcon
  • +
  • TIcon
  • +
  • TBrush
  • +
  • TPen
  • +
  • TCursorImage
  • +
  • TChangeLink
  • +
  • TCustomImageListResolution
  • +
  • TCustomImageList
  • +
  • TRegion
  • +
  • TTreeNode
  • +
  • TTreeNodes
  • +
+ +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. + +
LCLType.TLCLHandle +TLCLComponment +TLCLReferenceComponment
@@ -39,7 +96,9 @@ The type used for handles in widget set classes and LCL components. Pointer to a TLCLHandle instance. - + + +