diff --git a/docs/xml/lcl/menus.xml b/docs/xml/lcl/menus.xml index 44bfadb14c..4fb6eace06 100644 --- a/docs/xml/lcl/menus.xml +++ b/docs/xml/lcl/menus.xml @@ -140,6 +140,70 @@ both TMenu and TMenuItem, and implemented in the True to rebuild the menu item hierarchy. + + +Represents line reduction modes available for menu items. + + +

+TMenuItemAutoFlag is an enumerated type with values that represent +the line reduction modes available for maintaining menu item instances. +TMenuItemAutoFlag controls when a menu or menu items are checked and +updated to eliminate redundant separators between adjacent menu items. +

+

+TMenuItemAutoFlag is the type used for the AutoLineReduction +property in TMenuItem. +

+ + +Added in LCL version 4.0. + + + + + + + +The parent menu (including a top-level menu item) is automatically examined and +updated when the menu is displayed. + + + + +The parent menu (including a top-level menu item) is automatically examined and +updated when a method which performs the action is explicitly called. + + + + +A menu item is examined and updated using the line reduction applied to the +parent menu item. maParent is not relevant for TMenu (TMainMenu) instances; +they do not have a parent menu item and the value is translated at run-time to +maAutomatic. + + + + + +Range type which represents the valid TMenuItemAutoFlag values for TMenu +instances. + + +

+TMenuAutoFlag is the type used for the AutoLineReduction +property in TMenu and descendent classes. +

+ + +Added in LCL version 4.0. + + + + + + + TMenuActionLink: defines the link between a selected menu item and @@ -948,6 +1012,8 @@ TMenuItem is the type maintained in both the TMenu.Items and + + @@ -1072,6 +1138,32 @@ AssignTo method is called. Action or menu item where values are stored in the method. + + +Indicates whether automatic line reduction is enabled for the menu item. + + +

+GetAutoLineReduction ensures that the setting in the +AutoLineReduction property is translated to either maAutomatic or maManual when +it contains maParent. +

+ + +Added in LCL version 4.0. + + + + + + + + +Returns True when AutoLineReduction is resolved to maParent or +maAutomatic. + + + Updates the image associated with the menu item when it has been changed. @@ -1190,6 +1282,51 @@ the Windows platform only. Calculated height for the menu item. + + +Indicates whether child menu Items need to be updated to hide leading or +trailing separators. + + +

+InternalRethinkLines is called from the RethinkLines and +CheckChildrenHandles methods. The return value indicates whether the visibility +of child menu items which are leading or trailing separators has been updated. +

+

+True indicates that the visibility for one or more of the child menu +items was changed in the method. +

+

+To maintain compatibility with the Delphi VCL behavior, all menu separators are +visible when GetAutoLineReduction returns False. +

+ + +Added in LCL version 4.0. + + + + + + + + + + + + + +Returns Trueif the visibility for one or more of the child menu items +was changed in the method. + + + + +Not used in the current implementation. + + + Gets the value for the Action property. @@ -2397,7 +2534,6 @@ image list is not available or an image index has not been specified. - Indicates if the menu item is configured as a check box or a radio button @@ -2550,6 +2686,37 @@ monitor where menu item is displayed. + + +Performs actions needed to update the visibility of child menu separators and +signal the OnChange event handler for the changes. + + +

+RethinkLines calls the InternalRethinkLines method to toggle the +visibility of examine or update the visible child menu items. If any of the +child Items was changed, the MenuChanged method is called to signal the +OnChange event handler (when assigned) and rebuild (re-display) the submenu. +

+ + +Added in LCL version 4.0. + + + + + + + + + + + +Returns True if the visibility of child menu item(s) was changed in the +method. + + + Removes all handler routines for the specified object instance from the @@ -2900,6 +3067,45 @@ menu item. + + +Indicates the method used to perform line reduction for the menu item and +optionally for its child Items. + + +

+AutoLineReduction is a TMenuItemAutoFlag property which +controls if redundant separators on child Items are automatically hidden on the +submenu. Line reduction causes leading, trailing, or adjacent menu separators +to be hidden. +

+

+maAutomatic and maParent cause redundant separators to be maintained by the +Parent menu item (or menu). Use maManual if line reduction is performed only +when the RethinkLines method is explicitly called. The default value for the +property is maParent and causes the line reduction setting in the Parent to be +applied to the menu item. +

+

+See TMenuItemAutoFlag for more information about the valid values for the +property. +

+

+Changing the value for the property causes the MenuChanged method to be called +to signal the OnChange event handler and to build (display) the menu and its +child Items at run-time. +

+ + +Added in LCL version 4.0. + + + + + + + + The caption text displayed for the menu item. @@ -3476,6 +3682,32 @@ Handles the CM_APPSHOWMENUGLYPHCHANGED message for the menu. Control message examined in the method. + + +Gets the value for the AutoLineReduction property. + + +

+GetAutoLineReduction ensures that the property contains a value +which is valid for the menu. maParent in the child Items is translated to +maAutomatic. +

+ + +Added in LCL version 4.0. + + + + + + + + + +Value for the AutoLineReduction property. + + + Implements the storage specifier for the BiDiMode property. @@ -3498,6 +3730,30 @@ Implements the OnChange event handler used in the Images property. Object for the event notification. + + +Sets the value for the AutoLineReduction property. + + +

+Stores the property value to AutoLineReduction in the Items member. +

+ + +Added in LCL version 4.0. + + + + + + + + + +New value for the AutoLineReduction property. + + + Sets the value for the BiDiMode property. @@ -4091,6 +4347,45 @@ Indicates whether the shortcut key for a menu item is used in the menu. + + +Indicates the method used to perform line reduction for the menu and +optionally for its child Items. + + +

+AutoLineReduction is a TMenuAutoFlag property which +controls if redundant separators on the menu or its child Items are +automatically hidden. Line reduction causes leading, trailing, or adjacent menu +separators to be hidden. +

+

+maAutomatic causes redundant separators to be automatically removed for the +menu. The default value for the property is maAutomatic and causes the line +reduction top be performed automatically. Use maManual if line reduction is +performed only when the RethinkLines method in a child menu item is explicitly +called. +

+

+See TMenuAutoFlag for more information about the valid values for the property. +

+

+The value in AutoLineReduction is used by child menu Items when their +AutoLineReduction property is set to maParent or maAutomatic. +

+ + +Added in LCL version 4.0. + + + + + + + + + + Indicates whether Bi-directional text mode is implemented allowing use with