[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'Forms' (#lcl)

TApplication.ActivateHint

Configures a hint window for the specified mouse position.

Declaration

Source position: forms.pp line 1596

public procedure TApplication.ActivateHint(

  CursorPos: TPoint;

  CheckHintControlChange: Boolean = False

);

Arguments

CursorPos

  

Mouse cursor position used to retrieve the hint control information.

CheckHintControlChange

  

Indicates if hint controls are used to compared existing and new hint windows.

Description

ActivateHint is a procedure used to configure and control a hint window displayed at the coordinates specified in CursorPos. ActivateHint retrieves the control with hint information at the specified mouse position.

CheckHintControlChange indicates whether the active Hint control is compared to the control under the mouse position to determine if the active hint control has changed. When set to False, only the mouse leaving the hint rectangle causes the window to be updated. When set to True, a change of control at the mouse position also causes the hint window to be updated.

If the hint control at the specified coordinates differs from the one in the active hint, an existing hint is deactivated. The new hint window sets its hint timer and calculates the rectangle for the hint window.

If hint text is not available for the specified control and mouse position, the CancelHint method is called instead.

Use the following properties to control the interval for the timer which displays or hides a hint window in the application:

ActivateHint is used in the implementation of the DoOnMouseMove and ShowHintWindow methods.

See also

TApplication.ShowHintWindow

  

Shows or hides the hint window for a control in the application.

TApplication.DoOnMouseMove

  

OnMouseMove message handler, updates the Hint.

TApplication.CancelHint

  

Called when the Hint timer has expired to stop showing the Hint.

TApplication.HideHint

  

Hides the Hint window.

TApplication.Hint

  

The current Hint text active for the application.

TApplication.HintPause

  

The delay before a Hint is shown for a form or control.

TApplication.HintHidePause

  

Indicates how long a Hint remains visible after the mouse pointer is moved.

TApplication.HintHidePausePerChar

  

Indicates how long a keystroke extends the time a Hint remains visible (added to HintHidePause).

TApplication.HintShortPause

  

The pause before a different Hint is displayed.

TApplication.OnHint

  

Event handler signalled when a hint is requested in the application.

THintWindow.ActivateHint

  

Shows the hint window with the specified hint text.

THintWindow.HintRect

  

Contains the bounds used to display the text for the hint.

THintWindow.HintControl

  

Windowed control which is the parent for the hint window.


Version 4.0 Generated 2025-05-03 Home