LCLProc unit

Useful lower-level helper functions and classes.

lclproc.pas contains lower-level classes and helper routines that are useful in LCL applications.

lclproc.pas is part of the Lazarus Component Library ( LCL).

Classes and records

`TDebugLCLItemInfo`	class	A node in TDebugLCLItems, holding information about a heap object.
`TDebugLCLItems`	class	A list describing dynamically allocated (and destroyed) memory objects.

Procedures and functions

`AddCmdLineParamDesc`	procedure	Adds the help displayed for a command line parameter (and options) to the specified TStringList instance.
`AppendFontFaceSuffixes`	function
`CallInterfaceFinalizationHandlers`	procedure	Calls each of the registered finalization handlers.
`CallInterfaceInitializationHandlers`	procedure	Calls each of the registered initialization handlers.
`ClassCase`	function	Indicates if a TClass instance is found in the specified array.
`CompareCaret`	function	Deprecated. Use LazUtilities.CompareCaret instead.
`CompareDebugLCLItemInfos`	function	Compare function for the TDebugLCLItems AVL tree.
`CompareHandles`	function	Compares two Handles, returning the relative order for the handle values.
`CompareItemWithDebugLCLItemInfo`	function	Compare function for
`ComparePoints`	function	Deprecated. Use LazUtils.ComparePoints instead. Compares the specified TPoint values to get their relative order.
`DbgAppendToFile`	procedure	Appends a line to the given file.
`DbgAppendToFileWithoutLn`	procedure	Appends (pre-formatted) text to an file.
`DbgOutThreadLog`	procedure	Writes a debugging message to the log file for the current thread.
`DbgS`	function	Formats debug output for various argument types (overloaded).
`DbgSaveData`	procedure	Writes data to a file.
`DbgsVKCode`	function	Converts a virtual key code to its String representation.
`DbgSWindowPosFlags`	function	Provides a dump of SetWindowPosition flags.
`DebugLn`	procedure	Deprecated. Use DebugLogger.DebugLn instead.
`DebuglnThreadLog`	procedure	Writes a debugging message to the log file for the current thread which includes the thread identifier.
`DeleteAmpersands`	function	Removes all Ampersand ('&') characters Str, and return the position for the first occurrence.
`ExtractFontFaceSuffixes`	procedure
`ExtractFontWeightSuffix`	function
`GetCompleteText`	function	Finds a string in a list, given its first few characters.
`GetFontFamilyDefaultStretch`	function
`IsEditableTextKey`	function	Indicates if the specified key code has a value allowed in an editable text string.
`IsFontNameDefault`	function	Indicates whether the specified font name contains 'default'.
`KeyAndShiftStateToKeyString`	function	Converts the specified key code and shift modifier to their representation as a String.
`KeyStringIsIrregular`	function	Indicates if the string contains the 'Word(nn)' representation for an unknown key code.
`OwnerFormDesignerModified`	procedure	Executes the routine which notifies the form designer when the specified component has been changed.
`RegisterInterfaceFinalizationHandler`	procedure	Registers an finalization routine needed after the LCL has been finalized.
`RegisterInterfaceInitializationHandler`	procedure	Registers an initialization routine needed before the LCL is initialized.
`RemoveAmpersands`	function	Removes single Ampersand characters, and returns the converted value.
`SendApplicationMessage`	function	Sends an application message using the specified parameter values.
`ShortCutToText`	function	Returns the localized textual representation for a shortcut value.
`ShortCutToTextRaw`	function	Converts a shortcut value to its text representation without localization.
`TextToShortCut`	function	Converts the textual representation for a shortcut to its TShortCut value.
`TextToShortCutRaw`	function	Converts the non-localized textual representation for a shortcut to a TShortCut value.

Types

`TMethodList`	type	A list for method references.
`TOwnerFormDesignerModifiedProc`	procedure type	Hook used to prevent circular unit references.
`TSendApplicationMessageFunction`	procedure type	Hook used to prevent circular unit references.

Variables

`OwnerFormDesignerModifiedProc`	variable	Routine used to notify the form designer which owns the specified component when it has been changed.
`SendApplicationMessageFunction`	variable	Function used to send an application message using the specified parameter values.

Uses

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.