Class AbstractMenu (version 0.18)Description: The abstract menu class The abstract menu is a class that stores a main menu and several popup menus in a generic form such that they can be manipulated and converted into GUI objects. Each item can be associated with a Action, which delivers a title, enabled/disable state etc. The Action is either provided when new entries are inserted or created upon initialisation. The abstract menu class provides methods to manipulate the menu structure (the state of the menu items, their title and shortcut key is provided and manipulated through the Action object). Menu items and submenus are referred to by a "path". The path is a string with this interpretation: "" is the root "[<path>.]<name>" is an element of the submenu given by <path>. If <path> is ommitted, this refers to an element in the root "[<path>.]end" refers to the item past the last item of the submenu given by <path> or root "[<path>.]begin" refers to the first item of the submenu given by <path> or root "[<path>.]#<n>" refers to the nth item of the submenu given by <path> or root (n is an integer number) Menu items can be put into groups. The path strings of each group can be obtained with the "group" method. An item is put into a group by appending ":<group-name>" to the item's name. This specification can be used several times. Detached menus (i.e. for use in context menus) can be created as virtual top-level submenus with a name of the form "@<name>".A special detached menu is "@toolbar" which describes all elements placed into the toolbar.
Method Overview
ActionBase action( string path )Description: Get the reference to a Action object associated with the given path
delete_item( string path )Description: Delete the item given by the path
destroyDescription: Explicitly destroy the object Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.
[const] bool destroyedDescription: Tell, if the object was destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.
[const] string[ ] group( string group )Description: Get the group members
insert_item( string path, string name, ActionBase action )Description: Insert a new item before the one given by the path The Action object passed as the third parameter references the handler which both implements the action to perform and the menu item's appearance such as title, icon and keyboard shortcut.
insert_menu( string path, string name, string title )Description: Insert a new submenu before the item given by the path The title string optionally encodes the key shortcut and icon resource in the form <text>["("<shortcut>")"]["<"<icon-resource>">"].
insert_separator( string path, string name )Description: Insert a new separator before the item given by the path
bool is_menu( string path )Description: Query if an item is a menu
bool is_valid( string path )Description: Query if a path is a valid one
string[ ] items( string path )Description: Get the subitems for a given submenu
|