Sign in Join
FPDoc Onlineexperiment

THintWindow.ActivateHintData procedure

Member of THintWindowpublicIn unit Forms

An alternate version of ActivateHint with additional data used for the hint display.

Declaration

pascal
procedure ActivateHintData(ARect: TRect; const AHint: string; 
 AData: pointer); virtual

Arguments

ARect

Display rectangle for the hint text.

AHint

Text displayed in the hint window.

AData

Pointer to additional data used to construct the hint text.

Description

ActivateHintData is an alternate version of ActivateHint. It provides the additional AData argument which contains a pointer to values which can be used to construct the text displayed in the hint window.

ActivateHintData stores the value in ARect to the HintRect for the hint window. It ensures that the display rectangle fits within the work area for the monitor where the hint window is displayed. Values in HintRect are adjusted as needed to position and size the window before the hint window becomes visible. ActivateHint is called to display the window with the specified hint text.

The ActivateHintData implementation in THintWindow does not use the value in AData. The method must be overridden in a descendent class to use the additional hint data in the AData argument.

See also

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