API reference - Class AbstractMenuNotation used in Ruby API documentation 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:
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 represents the tool bar of the main window. Menus are closely related to the Action class. Actions are used to represent selectable items inside menus, provide the title and other configuration settings. Actions also link the menu items with code. See the Action class description for further details. Public constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
Detailed descriptionvoid _createDescription: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. void _destroyDescription: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. [const] bool _destroyed?Description: Returns a value indicating whether the object was already 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] bool _is_const_object?Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. void _manageDescription: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. void _unmanageDescription: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. [const] Action action(string path)Description: Get the reference to a Action object associated with the given path
void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void delete_item(string path)Description: Delete the item given by the path
void destroyDescription: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [const] string[] group(string group)Description: Get the group members
void insert_item(string path,string name,const Action 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. void 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>">"]. void insert_separator(string path,string name)Description: Insert a new separator before the item given by the path
[const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead [const] bool is_menu?(string path)Description: Query if an item is a menu
[const] bool is_separator?(string path)Description: Query if an item is a separator
This method has been introduced in version 0.19. [const] bool is_valid?(string path)Description: Query if a path is a valid one
[const] string[] items(string path)Description: Get the subitems for a given submenu
[static] new AbstractMenu ptr newDescription: Creates a new object of this class Python specific notes:This method is the default initializer of the object |