Medical Imaging Interaction Toolkit  2018.4.99-ae21cdc4
Medical Imaging Interaction Toolkit
berry::HandlerUtil Class Reference

#include <berryHandlerUtil.h>

Public Types

typedef ObjectList< ObjectString::PointerStringVectorType
 

Static Public Member Functions

static Object::ConstPointer GetVariable (const ExecutionEvent::ConstPointer &event, const QString &name)
 
static Object::ConstPointer GetVariableChecked (const ExecutionEvent::ConstPointer &event, const QString &name)
 
static Object::ConstPointer GetVariable (Object::Pointer context, const QString &name)
 
static StringVectorType::ConstPointer GetActiveContexts (const ExecutionEvent::ConstPointer &event)
 
static StringVectorType::ConstPointer GetActiveContextsChecked (const ExecutionEvent::ConstPointer &event)
 
static IWorkbenchWindow::Pointer GetActiveWorkbenchWindow (const ExecutionEvent::ConstPointer &event)
 
static IWorkbenchWindow::Pointer GetActiveWorkbenchWindowChecked (const ExecutionEvent::ConstPointer &event)
 
static ObjectString::ConstPointer GetActiveEditorId (const ExecutionEvent::ConstPointer &event)
 
static ObjectString::ConstPointer GetActiveEditorIdChecked (const ExecutionEvent::ConstPointer &event)
 
static IWorkbenchPart::Pointer GetActivePart (const ExecutionEvent::ConstPointer &event)
 
static IWorkbenchPart::Pointer GetActivePartChecked (const ExecutionEvent::ConstPointer &event)
 
static ObjectString::ConstPointer GetActivePartId (const ExecutionEvent::ConstPointer &event)
 
static ObjectString::ConstPointer GetActivePartIdChecked (const ExecutionEvent::ConstPointer &event)
 
static IWorkbenchPartSite::Pointer GetActiveSite (const ExecutionEvent::ConstPointer &event)
 
static IWorkbenchPartSite::Pointer GetActiveSiteChecked (const ExecutionEvent::ConstPointer &event)
 
static ISelection::ConstPointer GetCurrentSelection (const ExecutionEvent::ConstPointer &event)
 
static ISelection::ConstPointer GetCurrentSelectionChecked (const ExecutionEvent::ConstPointer &event)
 
static StringVectorType::ConstPointer GetActiveMenus (const ExecutionEvent::ConstPointer &event)
 
static StringVectorType::ConstPointer GetActiveMenusChecked (const ExecutionEvent::ConstPointer &event)
 
static ISelection::ConstPointer GetActiveMenuSelection (const ExecutionEvent::ConstPointer &event)
 
static ISelection::ConstPointer GetActiveMenuSelectionChecked (const ExecutionEvent::ConstPointer &event)
 
static ISelection::ConstPointer GetActiveMenuEditorInput (const ExecutionEvent::ConstPointer &event)
 
static ISelection::ConstPointer GetActiveMenuEditorInputChecked (const ExecutionEvent::ConstPointer &event)
 
static ISelection::ConstPointer GetShowInSelection (const ExecutionEvent::ConstPointer &event)
 
static ISelection::ConstPointer GetShowInSelectionChecked (const ExecutionEvent::ConstPointer &event)
 
static Object::ConstPointer GetShowInInput (const ExecutionEvent::ConstPointer &event)
 
static Object::ConstPointer GetShowInInputChecked (const ExecutionEvent::ConstPointer &event)
 
static bool ToggleCommandState (const SmartPointer< Command > &command)
 
static bool MatchesRadioState (const SmartPointer< ExecutionEvent > &event)
 
static void UpdateRadioState (const SmartPointer< Command > &command, const QString &newState)
 

Detailed Description

Some common utilities for working with handlers in Platform UI.

Note: this class should not be instantiated or extended by clients.

Since
3.3

Definition at line 40 of file berryHandlerUtil.h.

Member Typedef Documentation

◆ StringVectorType

Member Function Documentation

◆ GetActiveContexts()

static StringVectorType::ConstPointer berry::HandlerUtil::GetActiveContexts ( const ExecutionEvent::ConstPointer event)
static

Return the active contexts.

Parameters
eventThe execution event that contains the application context
Returns
a collection of String contextIds, or null.

◆ GetActiveContextsChecked()

static StringVectorType::ConstPointer berry::HandlerUtil::GetActiveContextsChecked ( const ExecutionEvent::ConstPointer event)
static

Return the active contexts.

Parameters
eventThe execution event that contains the application context
Returns
a collection of String contextIds. Will not return null.
Exceptions
ExecutionExceptionIf the context variable is not found.

◆ GetActiveEditorId()

static ObjectString::ConstPointer berry::HandlerUtil::GetActiveEditorId ( const ExecutionEvent::ConstPointer event)
static

Return the active editor.

Parameters
eventThe execution event that contains the application context
Returns
the active editor, or null. Return the active editor.
Parameters
eventThe execution event that contains the application context
Returns
the active editor. Will not return null.
Exceptions
ExecutionExceptionIf the active editor variable is not found. Return the part id of the active editor.
Parameters
eventThe execution event that contains the application context
Returns
the part id of the active editor, or null.

◆ GetActiveEditorIdChecked()

static ObjectString::ConstPointer berry::HandlerUtil::GetActiveEditorIdChecked ( const ExecutionEvent::ConstPointer event)
static

Return the part id of the active editor.

Parameters
eventThe execution event that contains the application context
Returns
the part id of the active editor. Will not return null.
Exceptions
ExecutionExceptionIf the active editor id variable is not found.

◆ GetActiveMenuEditorInput()

static ISelection::ConstPointer berry::HandlerUtil::GetActiveMenuEditorInput ( const ExecutionEvent::ConstPointer event)
static

Return the active menu editor input, if available. The active menu is a registered context menu.

Parameters
eventThe execution event that contains the application context
Returns
the active menu editor, or null.

◆ GetActiveMenuEditorInputChecked()

static ISelection::ConstPointer berry::HandlerUtil::GetActiveMenuEditorInputChecked ( const ExecutionEvent::ConstPointer event)
static

Return the active menu editor input. The active menu is a registered context menu. Some context menus do not include the editor input which will throw an exception.

Parameters
eventThe execution event that contains the application context
Returns
the active menu editor input. Will not return null.
Exceptions
ExecutionExceptionIf the active menu editor input variable is not found.

◆ GetActiveMenus()

static StringVectorType::ConstPointer berry::HandlerUtil::GetActiveMenus ( const ExecutionEvent::ConstPointer event)
static

Return the menu IDs that were applied to the registered context menu. For example, #CompilationUnitEditorContext.

Parameters
eventThe execution event that contains the application context
Returns
the menu IDs, or null.

◆ GetActiveMenusChecked()

static StringVectorType::ConstPointer berry::HandlerUtil::GetActiveMenusChecked ( const ExecutionEvent::ConstPointer event)
static

Return the menu IDs that were applied to the registered context menu. For example, #CompilationUnitEditorContext.

Parameters
eventThe execution event that contains the application context
Returns
the menu IDs. Will not return null.
Exceptions
ExecutionExceptionIf the active menus variable is not found.

◆ GetActiveMenuSelection()

static ISelection::ConstPointer berry::HandlerUtil::GetActiveMenuSelection ( const ExecutionEvent::ConstPointer event)
static

Return the active menu selection. The active menu is a registered context menu.

Parameters
eventThe execution event that contains the application context
Returns
the active menu selection, or null.

◆ GetActiveMenuSelectionChecked()

static ISelection::ConstPointer berry::HandlerUtil::GetActiveMenuSelectionChecked ( const ExecutionEvent::ConstPointer event)
static

Return the active menu selection. The active menu is a registered context menu.

Parameters
eventThe execution event that contains the application context
Returns
the active menu selection. Will not return null.
Exceptions
ExecutionExceptionIf the active menu selection variable is not found.

◆ GetActivePart()

static IWorkbenchPart::Pointer berry::HandlerUtil::GetActivePart ( const ExecutionEvent::ConstPointer event)
static

Return the active part.

Parameters
eventThe execution event that contains the application context
Returns
the active part, or null.

◆ GetActivePartChecked()

static IWorkbenchPart::Pointer berry::HandlerUtil::GetActivePartChecked ( const ExecutionEvent::ConstPointer event)
static

Return the active part.

Parameters
eventThe execution event that contains the application context
Returns
the active part. Will not return null.
Exceptions
ExecutionExceptionIf the active part variable is not found.

◆ GetActivePartId()

static ObjectString::ConstPointer berry::HandlerUtil::GetActivePartId ( const ExecutionEvent::ConstPointer event)
static

Return the part id of the active part.

Parameters
eventThe execution event that contains the application context
Returns
the part id of the active part, or null.

◆ GetActivePartIdChecked()

static ObjectString::ConstPointer berry::HandlerUtil::GetActivePartIdChecked ( const ExecutionEvent::ConstPointer event)
static

Return the part id of the active part.

Parameters
eventThe execution event that contains the application context
Returns
the part id of the active part. Will not return null.
Exceptions
ExecutionExceptionIf the active part id variable is not found.

◆ GetActiveSite()

static IWorkbenchPartSite::Pointer berry::HandlerUtil::GetActiveSite ( const ExecutionEvent::ConstPointer event)
static

Return the active part site.

Parameters
eventThe execution event that contains the application context
Returns
the active part site, or null.

◆ GetActiveSiteChecked()

static IWorkbenchPartSite::Pointer berry::HandlerUtil::GetActiveSiteChecked ( const ExecutionEvent::ConstPointer event)
static

Return the active part site.

Parameters
eventThe execution event that contains the application context
Returns
the active part site. Will not return null.
Exceptions
ExecutionExceptionIf the active part site variable is not found.

◆ GetActiveWorkbenchWindow()

static IWorkbenchWindow::Pointer berry::HandlerUtil::GetActiveWorkbenchWindow ( const ExecutionEvent::ConstPointer event)
static

Return the active shell. Is not necessarily the active workbench window shell.

Parameters
eventThe execution event that contains the application context
Returns
the active shell, or null. Return the active shell. Is not necessarily the active workbench window shell.
Parameters
eventThe execution event that contains the application context
Returns
the active shell. Will not return null.
Exceptions
ExecutionExceptionIf the active shell variable is not found. Return the active workbench window.
Parameters
eventThe execution event that contains the application context
Returns
the active workbench window, or null.

◆ GetActiveWorkbenchWindowChecked()

static IWorkbenchWindow::Pointer berry::HandlerUtil::GetActiveWorkbenchWindowChecked ( const ExecutionEvent::ConstPointer event)
static

Return the active workbench window.

Parameters
eventThe execution event that contains the application context
Returns
the active workbench window. Will not return null.
Exceptions
ExecutionExceptionIf the active workbench window variable is not found.

◆ GetCurrentSelection()

static ISelection::ConstPointer berry::HandlerUtil::GetCurrentSelection ( const ExecutionEvent::ConstPointer event)
static

Return the current selection.

Parameters
eventThe execution event that contains the application context
Returns
the current selection, or null.

◆ GetCurrentSelectionChecked()

static ISelection::ConstPointer berry::HandlerUtil::GetCurrentSelectionChecked ( const ExecutionEvent::ConstPointer event)
static

Return the current selection.

Parameters
eventThe execution event that contains the application context
Returns
the current selection. Will not return null.
Exceptions
ExecutionExceptionIf the current selection variable is not found.

◆ GetShowInInput()

static Object::ConstPointer berry::HandlerUtil::GetShowInInput ( const ExecutionEvent::ConstPointer event)
static

Return the ShowInContext input.

Parameters
eventThe execution event that contains the application context
Returns
the show in input, or null.

◆ GetShowInInputChecked()

static Object::ConstPointer berry::HandlerUtil::GetShowInInputChecked ( const ExecutionEvent::ConstPointer event)
static

Return the ShowInContext input. Will not return null.

Parameters
eventThe execution event that contains the application context
Returns
the show in input, or null.
Exceptions
ExecutionExceptionIf the show in input variable is not found.

◆ GetShowInSelection()

static ISelection::ConstPointer berry::HandlerUtil::GetShowInSelection ( const ExecutionEvent::ConstPointer event)
static

Return the ShowInContext selection.

Parameters
eventThe execution event that contains the application context
Returns
the show in selection, or null.

◆ GetShowInSelectionChecked()

static ISelection::ConstPointer berry::HandlerUtil::GetShowInSelectionChecked ( const ExecutionEvent::ConstPointer event)
static

Return the ShowInContext selection. Will not return null.

Parameters
eventThe execution event that contains the application context
Returns
the show in selection, or null.
Exceptions
ExecutionExceptionIf the show in selection variable is not found.

◆ GetVariable() [1/2]

static Object::ConstPointer berry::HandlerUtil::GetVariable ( const ExecutionEvent::ConstPointer event,
const QString &  name 
)
static

Extract the variable.

Parameters
eventThe execution event that contains the application context
nameThe variable name to extract.
Returns
The object from the application context, or null if it could not be found.

◆ GetVariable() [2/2]

static Object::ConstPointer berry::HandlerUtil::GetVariable ( Object::Pointer  context,
const QString &  name 
)
static

Extract the variable.

Parameters
contextThe IEvaluationContext or null
nameThe variable name to extract.
Returns
The object from the application context, or null if it could not be found.

◆ GetVariableChecked()

static Object::ConstPointer berry::HandlerUtil::GetVariableChecked ( const ExecutionEvent::ConstPointer event,
const QString &  name 
)
static

Extract the variable.

Parameters
eventThe execution event that contains the application context
nameThe variable name to extract.
Returns
The object from the application context. Will not return null.
Exceptions
ExecutionExceptionif the variable is not found.

◆ MatchesRadioState()

static bool berry::HandlerUtil::MatchesRadioState ( const SmartPointer< ExecutionEvent > &  event)
static

Checks whether the radio state of the command is same as the radio state parameter's value

Parameters
eventThe execution event that contains the application context
Returns
true whe the values are same, false otherwise
Exceptions
ExecutionExceptionWhen the command doesn't have the radio state or the event doesn't have the radio state parameter

◆ ToggleCommandState()

static bool berry::HandlerUtil::ToggleCommandState ( const SmartPointer< Command > &  command)
static

Toggles the command's state.

Parameters
commandThe command whose state needs to be toggled
Returns
the original value before toggling
Exceptions
ExecutionExceptionWhen the command doesn't contain the toggle state or when the state doesn't contain a boolean value

◆ UpdateRadioState()

static void berry::HandlerUtil::UpdateRadioState ( const SmartPointer< Command > &  command,
const QString &  newState 
)
static

Updates the radio state of the command to the given value

Parameters
commandthe command whose state should be updated
newStatethe new state
Exceptions
ExecutionExceptionWhen the command doesn't have a radio state

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