berry::MenuUtil Class Reference

#include <berryMenuUtil.h>

Static Public Member Functions
static QString	MenuUri (const QString &id)
static QString	MenuAddition (const QString &id, const QString &location, const QString &refId)
static QString	MenuAddition (const QString &id)
static QString	ToolbarUri (const QString &id)
static QString	ToolbarAddition (const QString &id, const QString &location, const QString &refId)
static QString	ToolbarAddition (const QString &id)

Static Public Attributes
static QString	WORKBENCH_MENU
static QString	MAIN_MENU
static QString	MAIN_TOOLBAR
static QString	ANY_POPUP
static QString	QUERY_BEFORE
static QString	QUERY_AFTER
static QString	QUERY_ENDOF
static QString	SHOW_IN_MENU_ID

Detailed Description

Provides utilities and constants for use with the new menus API.

This class is not intended to be subclassed by clients. This class is not intended to be instantiated by clients.

Definition at line 31 of file berryMenuUtil.h.

Member Function Documentation

QString berry::MenuUtil::MenuAddition ( const QString &  id, const QString &  location, const QString &  refId  )

static

Parameters

id	The id of the menu
location	The relative location specifier
refId	The id of the menu element to be relative to

Returns

A location URI formatted with the given parameters

Definition at line 41 of file berryMenuUtil.cpp.

References MenuUri().

Referenced by MenuAddition().

QString berry::MenuUtil::MenuAddition ( const QString &  id )

static

Convenience method to create a standard menu addition The resulting string has the format: "menu:[id]?after=additions"

Parameters

id	The id of the root element to contribute to

Returns

The formatted string

Definition at line 47 of file berryMenuUtil.cpp.

References MenuAddition().

QString berry::MenuUtil::MenuUri ( const QString &  id )

static

Parameters

id	The menu's id

Returns

The locator URI for a menu with the given id

Definition at line 36 of file berryMenuUtil.cpp.

Referenced by MenuAddition().

QString berry::MenuUtil::ToolbarAddition ( const QString &  id, const QString &  location, const QString &  refId  )

static

Parameters

id	The id of the toolbar
location	The relative location specifier
refId	The id of the toolbar element to be relative to

Returns

A location URI formatted with the given parameters

Definition at line 57 of file berryMenuUtil.cpp.

References ToolbarUri().

Referenced by ToolbarAddition().

QString berry::MenuUtil::ToolbarAddition ( const QString &  id )

static

Convenience method to create a standard toolbar addition The resulting string has the format: "toolbar:[id]?after=additions"

Parameters

id	The id of the root element to contribute to

Returns

The formatted string

Definition at line 63 of file berryMenuUtil.cpp.

References ToolbarAddition().

QString berry::MenuUtil::ToolbarUri ( const QString &  id )

static

Parameters

id	The toolbar's id

Returns

The lcoation URI for a toolbar with the given id

Definition at line 52 of file berryMenuUtil.cpp.

Referenced by ToolbarAddition().

Member Data Documentation

QString berry::MenuUtil::ANY_POPUP

static

-Any- Popup Menu

Definition at line 48 of file berryMenuUtil.h.

QString berry::MenuUtil::MAIN_MENU

static

Main Menu

Definition at line 43 of file berryMenuUtil.h.

QString berry::MenuUtil::MAIN_TOOLBAR

static

Main ToolBar

Definition at line 45 of file berryMenuUtil.h.

QString berry::MenuUtil::QUERY_AFTER

static

Valid query attribute. Usage menu:menu.id?after=contribution.id.

Definition at line 58 of file berryMenuUtil.h.

QString berry::MenuUtil::QUERY_BEFORE

static

Valid query attribute. Usage menu:menu.id?before=contribution.id.

Definition at line 53 of file berryMenuUtil.h.

QString berry::MenuUtil::QUERY_ENDOF

static

Valid query attribute. Usage menu:menu.id?endof=contribution.id.

This menu contribution will be placed at the end of the group defined by contribution.id (usually right in front of the next group marker or separator). Further contribution processing can still place other contributions after this one.

Definition at line 69 of file berryMenuUtil.h.

QString berry::MenuUtil::SHOW_IN_MENU_ID

static

Contributions of targets to this location will be included with the show in menu.

Definition at line 75 of file berryMenuUtil.h.

QString berry::MenuUtil::WORKBENCH_MENU

static

Workbench Menu. On supported platforms, this menu is shown when no workbench windows are active

Definition at line 41 of file berryMenuUtil.h.

---

The documentation for this class was generated from the following files:

• berryMenuUtil.h
• berryMenuUtil.cpp