Medical Imaging Interaction Toolkit  2021.10.99-9c07a326
Medical Imaging Interaction Toolkit
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.

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

Definition at line 27 of file berryMenuUtil.h.

Member Function Documentation

◆ MenuAddition() [1/2]

static QString berry::MenuUtil::MenuAddition ( const QString &  id,
const QString &  location,
const QString &  refId 
)
static
Parameters
idThe id of the menu
locationThe relative location specifier
refIdThe id of the menu element to be relative to
Returns
A location URI formatted with the given parameters

◆ MenuAddition() [2/2]

static 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
idThe id of the root element to contribute to
Returns
The formatted string

◆ MenuUri()

static QString berry::MenuUtil::MenuUri ( const QString &  id)
static
Parameters
idThe menu's id
Returns
The locator URI for a menu with the given id

◆ ToolbarAddition() [1/2]

static QString berry::MenuUtil::ToolbarAddition ( const QString &  id,
const QString &  location,
const QString &  refId 
)
static
Parameters
idThe id of the toolbar
locationThe relative location specifier
refIdThe id of the toolbar element to be relative to
Returns
A location URI formatted with the given parameters

◆ ToolbarAddition() [2/2]

static 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
idThe id of the root element to contribute to
Returns
The formatted string

◆ ToolbarUri()

static QString berry::MenuUtil::ToolbarUri ( const QString &  id)
static
Parameters
idThe toolbar's id
Returns
The lcoation URI for a toolbar with the given id

Member Data Documentation

◆ ANY_POPUP

QString berry::MenuUtil::ANY_POPUP
static

-Any- Popup Menu

Definition at line 44 of file berryMenuUtil.h.

◆ MAIN_MENU

QString berry::MenuUtil::MAIN_MENU
static

Main Menu

Definition at line 39 of file berryMenuUtil.h.

◆ MAIN_TOOLBAR

QString berry::MenuUtil::MAIN_TOOLBAR
static

Main ToolBar

Definition at line 41 of file berryMenuUtil.h.

◆ QUERY_AFTER

QString berry::MenuUtil::QUERY_AFTER
static

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

Definition at line 54 of file berryMenuUtil.h.

◆ QUERY_BEFORE

QString berry::MenuUtil::QUERY_BEFORE
static

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

Definition at line 49 of file berryMenuUtil.h.

◆ QUERY_ENDOF

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 65 of file berryMenuUtil.h.

◆ SHOW_IN_MENU_ID

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 71 of file berryMenuUtil.h.

◆ WORKBENCH_MENU

QString berry::MenuUtil::WORKBENCH_MENU
static

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

Definition at line 37 of file berryMenuUtil.h.


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