From 34f30ff73f0cbe9e2bf5d9c65dc5b02cbe0bf53e Mon Sep 17 00:00:00 2001 From: dsiders Date: Thu, 28 Mar 2024 15:15:26 +0100 Subject: [PATCH] Docs: LCL/forms. Updates TApplication.ActivateHint topic for changes in 90dbac6a. Issue #40820. --- docs/xml/lcl/forms.xml | 49 +++++++++++++++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 10 deletions(-) diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index 86ac0316b5..e1d9278c16 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -15625,23 +15625,44 @@ Application variables do not contain the same TCustomApplication instance. -Configures a hint window for the specified mouse position. + +Configures a hint window for the specified mouse position. +

-ActivateHint is a procedure used to configure a hint window -display at the coordinates specified in CursorPos. +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.

-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. +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 a hint is not available for the specified mouse position, the -CancelHint method is called. +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.

@@ -15653,11 +15674,19 @@ and ShowHintWindow methods. + + + + + +
-Mouse cursor position used to retrieve the hint information. + +Mouse cursor position used to retrieve the hint control information. +