From d83d653b18d3ee8ed5586657bd9106d47d10124a Mon Sep 17 00:00:00 2001 From: dsiders Date: Sat, 13 May 2023 00:28:43 +0100 Subject: [PATCH] Docs: LCL/menus. Updates TMenuItem.Hint topic for changes in 98f806bb. Issue# 40220. --- docs/xml/lcl/menus.xml | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/docs/xml/lcl/menus.xml b/docs/xml/lcl/menus.xml index 159763cff4..f9f9111459 100644 --- a/docs/xml/lcl/menus.xml +++ b/docs/xml/lcl/menus.xml @@ -2944,11 +2944,41 @@ ID). -Hint: shown in a statusbar if the main window has one and if the -statusbar has AutoHint set to True. +Contains hint text displayed for the menu item. - + +

+Hint is a TTranslateString property with the text +displayed as a hint for the menu item. Its value may be overwritten with the +Caption from an Action assigned to the menu item. As a TTranslateString +property, the value can be localized using the i18n facilities in the Lazarus +IDE when enabled for a project. +

+

+The hint text is displayed on the TStatusBar for a form when its AutoHint +property is enabled. For a top-level menu item, the hint text does not appear +until a menu item is selected / activated on the TMainMenu instance. Once an +item has been selected on the menu, hint text is displayed whenever the mouse +is hovered a menu item or when a new menu item is selected. +

+

+Hint is also assigned to the Hint property in Application (TApplication) for +use in its OnShowHint event handler. +

+
+ +Modified in LCL version 2.4.0 to use the TTranslateString type instead of +String. + + + +TCustomAction.Caption +TCustomAction.AutoCheck +TStatusBar.AutoHint +TApplication.Hint +TApplication.OnShowHint +TTranslateString