THintWindow class

In unit Forms

The pop-up box containing helpful information that appears when the mouse pointer hovers over an object.

Declaration

pascal

THintWindow = class(TCustomForm)

Inheritance

Descends from it: THintWindowRendered TNotifierForm

Description

THintWindow is a TCustomForm descendant used to display text hints. It is not intended for use with child controls.

Usage:

HintWindow := THintWindow.Create(nil);
Rect := HintWindow.CalcHintRect(0, 'This is the hint',nil);
HintWindow.ActivateHint(Rect, 'This is the hint');

Properties

`Alignment`	public	Text alignment used for the hint window.
`HintRect`	public	Contains the bounds used to display the text for the hint.
`HintRectAdjust`	public	Contains the bounds with additional space needed for the hint display.
`HintData`	public	Pointer to data used to formulate text displayed in the hint window.
`HintControl`	public	Windowed control which is the parent for the hint window.
`AutoHide`	public	Does the hint disappear (get hidden) after a while?
`BiDiMode`	public	Indicates whether text controls use in bi-directional reading.
`HideInterval`	public	The time after which the displayed hint disappears.

Methods

`WSRegisterClass`	protected	Registers this component class with the current WidgetSet.
`WMNCHitTest`	protected	Handles the WM_NCHITTEST window message for the hint window.
`ActivateSub`	protected	Sets the bounds for the hint window and configures the auto-hide timer.
`DoShowWindow`	protected	Chooses the active control when the form becomes visible at run-time.
`UpdateRegion`	protected	Updates the Window Region fir the hint window.
`SetColor`	protected	Sets the value for the Color property.
`UseBGThemes`	protected	Indicates if a background from theme services is used when drawing the hint window.
`UseFGThemes`	protected	Indicates if theme services are used for the foreground rendered for the hint window.
`Paint`	protected	Draws the content in the hint window.
`SysHintFont`	protected	System font used to draw text in the hint window.
`Destroy`	public	Destructor for the class instance.
`Create`	public	Constructor for the class instance.
`ActivateHint`	public	Shows the hint window with the specified hint text.
`ActivateWithBounds`	public	Sets the bounds in HintRect and activates the hint window.
`ActivateHintData`	public	An alternate version of ActivateHint with additional data used for the hint display.
`CalcHintRect`	public	Determines the display rectangle needed the specified hint text.
`OffsetHintRect`	public	Moves the hint rectangle by the specified amounts.
`InitializeWnd`	public	Initializes the widget, also for AlphaBlend and AllowDropFiles.
`IsHintMsg`	public	Indicates if the specified message is relevant to a hint window display.
`ReleaseHandle`	public	Destroys an allocated handle for the widget.
`SetBounds`	public	Applies the argument values to the bounds for the control.
`GetControlClassDefaultSize`	public	Returns the default dimensions for new instances of the class.

Events

`OnMouseDown`	public	Event handler signalled when a mouse down event is handled for the control.
`OnMouseUp`	public	Event handler signalled when a mouse up event is handled for the control.
`OnMouseMove`	public	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseLeave`	public	Event handler signalled when the mouse pointer has left the control.