[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 1600

public procedure TApplication.ActivateHint(

  CursorPos: TPoint;

  CheckHintControlChange: Boolean = False

);

Arguments

CursorPos

  

Mouse cursor position used to retrieve the hint information.

CheckHintControlChange

  

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

Description

ActivateHint is a procedure used to configure a hint window display at the coordinates specified in CursorPos.

ActivateHint retrieves the hint information at the mouse position. If the control for the hint differs from the current hint control, the existing hint is deactivated. The new hint window sets its hint timer and calculates the rectangle for the hint window.

If a hint is not available for the specified mouse position, the CancelHint method is called.

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

See also

TApplication.ShowHintWindow

  

Shows or hides the Hint window for 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.

TApplication.HintPause

  

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

TApplication.OnHint

  

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


Version 3.2 Generated 2024-02-25 Home