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.

Class overview

Index

Method Overview

ActionBase action( string path ) Get the reference to a Action object associated with the given path

string[ ] items( string path ) Get the subitems for a given submenu

bool is_menu( string path ) Query if an item is a menu

bool is_valid( string path ) Query if a path is a valid one

insert_item( string path, string name, ActionBase action ) Insert a new item before the one given by the path

insert_separator( string path, string name ) Insert a new separator before the item given by the path

insert_menu( string path, string name, string title ) Insert a new submenu before the item given by the path

delete_item( string path ) Delete the item given by the path

[const] string[ ] group( string group ) Get the group members

destroy Explicitly destroy the object

[const] bool destroyed Tell, if the object was destroyed

ActionBase action( string path )

Description: Get the reference to a Action object associated with the given path

path: The path to the item. This must be a valid path.
returns: A reference to a Action object associated with this path

delete_item( string path )

Description: Delete the item given by the path

path: The path to the item to delete

destroy

Description: 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 destroyed

Description: 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

group: The group name
A: vector of all members (by path) of the group

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.

path: The path to the item before which to insert the new item
name: The name of the item to insert
action: The Action object to insert

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>">"].

path: The path to the item before which to insert the submenu
name: The name of the submenu to insert
title: The title of the submenu to insert

Class AbstractMenu (version 0.18)

Method Overview

ActionBase action( string path )

delete_item( string path )

destroy

[const] bool destroyed

[const] string[ ] group( string group )

insert_item( string path, string name, ActionBase action )

insert_menu( string path, string name, string title )

insert_separator( string path, string name )

bool is_menu( string path )

bool is_valid( string path )

string[ ] items( string path )