paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-15 20:59:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/forms. Updates TApplication.ActivateHint topic for changes in 90dbac6a. Issue #40820.

Browse Source
This commit is contained in:
dsiders 2024-03-28 15:15:26 +01:00
parent 0e7ed3ccfa
commit 34f30ff73f
1 changed files with 39 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/xml/lcl/forms.xml
View File

@ -15625,23 +15625,44 @@ Application variables do not contain the same TCustomApplication instance.
</element> </element>
<element name="TApplication.ActivateHint"> <element name="TApplication.ActivateHint">
<short>Configures a hint window for the specified mouse position.</short> <short>
Configures a hint window for the specified mouse position.
</short>
<descr> <descr>
<p> <p>
<var>ActivateHint</var> is a procedure used to configure a hint window <var>ActivateHint</var> is a procedure used to configure and control a hint
display at the coordinates specified in <var>CursorPos</var>. window displayed at the coordinates specified in <var>CursorPos</var>.
ActivateHint retrieves the control with hint information at the specified mouse
position.
</p> </p>
<p> <p>
ActivateHint retrieves the hint information at the mouse position. If the <var>CheckHintControlChange</var> indicates whether the active Hint control is
control for the hint differs from the current hint control, the existing hint compared to the control under the mouse position to determine if the active
is deactivated. The new hint window sets its hint timer and calculates the hint control has changed. When set to <b>False</b>, only the mouse leaving the
rectangle for the hint window. hint rectangle causes the window to be updated. When set to <var>True</var>, a
change of control at the mouse position also causes the hint window to be
updated.
</p> </p>
<p> <p>
If a hint is not available for the specified mouse position, the If the hint control at the specified coordinates differs from the one in the
<var>CancelHint</var> method is called. active hint, an existing hint is deactivated. The new hint window sets its hint
timer and calculates the rectangle for the hint window.
</p> </p>
<p> <p>
If hint text is not available for the specified control and mouse position, the
<var>CancelHint</var> method is called instead.
</p>
<p>
Use the following properties to control the interval for the timer which
displays or hides a hint window in the application:
</p>
<ul>
<li>HintPause</li>
<li>HintHidePause</li>
<li>HintHidePausePerChar</li>
<li>HintShortPause</li>
</ul>
<p>
ActivateHint is used in the implementation of the <var>DoOnMouseMove</var> ActivateHint is used in the implementation of the <var>DoOnMouseMove</var>
and <var>ShowHintWindow</var> methods. and <var>ShowHintWindow</var> methods.
</p> </p>
@ -15653,11 +15674,19 @@ and <var>ShowHintWindow</var> methods.
<link id="TApplication.HideHint"/> <link id="TApplication.HideHint"/>
<link id="TApplication.Hint"/> <link id="TApplication.Hint"/>
<link id="TApplication.HintPause"/> <link id="TApplication.HintPause"/>
<link id="TApplication.HintHidePause"/>
<link id="TApplication.HintHidePausePerChar"/>
<link id="TApplication.HintShortPause"/>
<link id="TApplication.OnHint"/> <link id="TApplication.OnHint"/>
<link id="THintWindow.ActivateHint"/>
<link id="THintWindow.HintRect"/>
<link id="THintWindow.HintControl"/>
</seealso> </seealso>
</element> </element>
<element name="TApplication.ActivateHint.CursorPos"> <element name="TApplication.ActivateHint.CursorPos">
<short>Mouse cursor position used to retrieve the hint information.</short> <short>
Mouse cursor position used to retrieve the hint control information.
</short>
</element> </element>
<element name="TApplication.ActivateHint.CheckHintControlChange"> <element name="TApplication.ActivateHint.CheckHintControlChange">
<short> <short>