TApplication.ActivateHint procedure
Configures a hint window for the specified mouse position.
Declaration
procedure 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:
- HintPause
- HintHidePause
- HintHidePausePerChar
- HintShortPause
ActivateHint is used in the implementation of the DoOnMouseMove
and ShowHintWindow methods.
See also
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.