berry::HandlerUtil Class Reference

#include <berryHandlerUtil.h>

Public Types
typedef ObjectList< ObjectString::Pointer >	StringVectorType

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 44 of file berryHandlerUtil.h.

Member Typedef Documentation

typedef ObjectList<ObjectString::Pointer> berry::HandlerUtil::StringVectorType

Definition at line 56 of file berryHandlerUtil.h.

Member Function Documentation

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

static

Return the active contexts.

Parameters

event

The execution event that contains the application context

Returns

a collection of String contextIds, or null.

Definition at line 84 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_CONTEXT_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariable().

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

static

Return the active contexts.

Parameters

event

The execution event that contains the application context

Returns

a collection of String contextIds. Will not return null.

Exceptions

ExecutionException

If the context variable is not found.

Definition at line 91 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_CONTEXT_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariableChecked().

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

static

Return the active editor.

Parameters

event

The execution event that contains the application context

Returns

the active editor, or null. Return the active editor.

Parameters

event

The execution event that contains the application context

Returns

the active editor. Will not return null.

Exceptions

ExecutionException

If the active editor variable is not found. Return the part id of the active editor.

Parameters

event

The execution event that contains the application context

Returns

the part id of the active editor, or null.

Definition at line 124 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_EDITOR_ID_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariable().

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

static

Return the part id of the active editor.

Parameters

event

The execution event that contains the application context

Returns

the part id of the active editor. Will not return null.

Exceptions

ExecutionException

If the active editor id variable is not found.

Definition at line 131 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_EDITOR_ID_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariableChecked().

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

event

The execution event that contains the application context

Returns

the active menu editor, or null.

Definition at line 292 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_MENU_EDITOR_INPUT_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariable().

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

event

The execution event that contains the application context

Returns

the active menu editor input. Will not return null.

Exceptions

ExecutionException

If the active menu editor input variable is not found.

Definition at line 300 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_MENU_EDITOR_INPUT_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariableChecked().

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

event

The execution event that contains the application context

Returns

the menu IDs, or null.

Definition at line 227 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_MENU_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariable().

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

event

The execution event that contains the application context

Returns

the menu IDs. Will not return null.

Exceptions

ExecutionException

If the active menus variable is not found.

Definition at line 235 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_MENU_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariableChecked().

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

static

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

Parameters

event

The execution event that contains the application context

Returns

the active menu selection, or null.

Definition at line 248 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_MENU_SELECTION_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariable().

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

static

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

Parameters

event

The execution event that contains the application context

Returns

the active menu selection. Will not return null.

Exceptions

ExecutionException

If the active menu selection variable is not found.

Definition at line 256 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_MENU_SELECTION_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariableChecked().

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

static

Return the active part.

Parameters

event

The execution event that contains the application context

Returns

the active part, or null.

Definition at line 144 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_PART_NAME(), berry::SmartPointer< TObjectType >::GetPointer(), and GetVariable().

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

static

Return the active part.

Parameters

event

The execution event that contains the application context

Returns

the active part. Will not return null.

Exceptions

ExecutionException

If the active part variable is not found.

Definition at line 151 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_PART_NAME(), berry::SmartPointer< TObjectType >::Cast(), berry::SmartPointer< TObjectType >::GetPointer(), and GetVariableChecked().

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

static

Return the part id of the active part.

Parameters

event

The execution event that contains the application context

Returns

the part id of the active part, or null.

Definition at line 164 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_PART_ID_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariable().

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

static

Return the part id of the active part.

Parameters

event

The execution event that contains the application context

Returns

the part id of the active part. Will not return null.

Exceptions

ExecutionException

If the active part id variable is not found.

Definition at line 171 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_PART_ID_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariableChecked().

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

static

Return the active part site.

Parameters

event

The execution event that contains the application context

Returns

the active part site, or null.

Definition at line 184 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_SITE_NAME(), berry::SmartPointer< TObjectType >::GetPointer(), and GetVariable().

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

static

Return the active part site.

Parameters

event

The execution event that contains the application context

Returns

the active part site. Will not return null.

Exceptions

ExecutionException

If the active part site variable is not found.

Definition at line 192 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_SITE_NAME(), berry::SmartPointer< TObjectType >::Cast(), berry::SmartPointer< TObjectType >::GetPointer(), and GetVariableChecked().

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

static

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

Parameters

event

The 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

event

The execution event that contains the application context

Returns

the active shell. Will not return null.

Exceptions

ExecutionException

If the active shell variable is not found. Return the active workbench window.

Parameters

event

The execution event that contains the application context

Returns

the active workbench window, or null.

Definition at line 270 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_WORKBENCH_WINDOW_NAME(), berry::SmartPointer< TObjectType >::GetPointer(), and GetVariable().

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

static

Return the active workbench window.

Parameters

event

The execution event that contains the application context

Returns

the active workbench window. Will not return null.

Exceptions

ExecutionException

If the active workbench window variable is not found.

Definition at line 278 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_WORKBENCH_WINDOW_NAME(), berry::SmartPointer< TObjectType >::Cast(), berry::SmartPointer< TObjectType >::GetPointer(), and GetVariableChecked().

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

static

Return the current selection.

Parameters

event

The execution event that contains the application context

Returns

the current selection, or null.

Definition at line 205 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_CURRENT_SELECTION_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariable().

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

static

Return the current selection.

Parameters

event

The execution event that contains the application context

Returns

the current selection. Will not return null.

Exceptions

ExecutionException

If the current selection variable is not found.

Definition at line 213 of file berryHandlerUtil.cpp.

References berry::ISources::ACTIVE_CURRENT_SELECTION_NAME(), berry::SmartPointer< TObjectType >::Cast(), and GetVariableChecked().

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

static

Return the ShowInContext input.

Parameters

event

The execution event that contains the application context

Returns

the show in input, or null.

Definition at line 335 of file berryHandlerUtil.cpp.

References GetVariable(), and berry::ISources::SHOW_IN_INPUT().

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

static

Return the ShowInContext input. Will not return null.

Parameters

event

The execution event that contains the application context

Returns

the show in input, or null.

Exceptions

ExecutionException

If the show in input variable is not found.

Definition at line 346 of file berryHandlerUtil.cpp.

References GetVariableChecked(), and berry::ISources::SHOW_IN_INPUT().

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

static

Return the ShowInContext selection.

Parameters

event

The execution event that contains the application context

Returns

the show in selection, or null.

Definition at line 314 of file berryHandlerUtil.cpp.

References berry::SmartPointer< TObjectType >::Cast(), GetVariable(), and berry::ISources::SHOW_IN_SELECTION().

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

static

Return the ShowInContext selection. Will not return null.

Parameters

event

The execution event that contains the application context

Returns

the show in selection, or null.

Exceptions

ExecutionException

If the show in selection variable is not found.

Definition at line 322 of file berryHandlerUtil.cpp.

References berry::SmartPointer< TObjectType >::Cast(), GetVariableChecked(), and berry::ISources::SHOW_IN_SELECTION().

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

static

Extract the variable.

Parameters

event	The execution event that contains the application context
name	The variable name to extract.

Returns

The object from the application context, or null if it could not be found.

Definition at line 50 of file berryHandlerUtil.cpp.

References berry::SmartPointer< TObjectType >::Cast().

Referenced by GetActiveContexts(), GetActiveEditorId(), GetActiveMenuEditorInput(), GetActiveMenus(), GetActiveMenuSelection(), GetActivePart(), GetActivePartId(), GetActiveSite(), GetActiveWorkbenchWindow(), GetCurrentSelection(), GetShowInInput(), GetShowInSelection(), and GetVariableChecked().

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

static

Extract the variable.

Parameters

context	The IEvaluationContext or null
name	The variable name to extract.

Returns

The object from the application context, or null if it could not be found.

Definition at line 72 of file berryHandlerUtil.cpp.

References berry::SmartPointer< TObjectType >::Cast(), and berry::SmartPointer< TObjectType >::IsNotNull().

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

static

Extract the variable.

Parameters

event	The execution event that contains the application context
name	The variable name to extract.

Returns

The object from the application context. Will not return null.

Exceptions

ExecutionException

if the variable is not found.

Definition at line 61 of file berryHandlerUtil.cpp.

References GetVariable(), and berry::SmartPointer< TObjectType >::IsNull().

Referenced by GetActiveContextsChecked(), GetActiveEditorIdChecked(), GetActiveMenuEditorInputChecked(), GetActiveMenusChecked(), GetActiveMenuSelectionChecked(), GetActivePartChecked(), GetActivePartIdChecked(), GetActiveSiteChecked(), GetActiveWorkbenchWindowChecked(), GetCurrentSelectionChecked(), GetShowInInputChecked(), and GetShowInSelectionChecked().

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

event

The execution event that contains the application context

Returns

true whe the values are same, false otherwise

Exceptions

ExecutionException

When the command doesn't have the radio state or the event doesn't have the radio state parameter

Definition at line 378 of file berryHandlerUtil.cpp.

References berry::SmartPointer< TObjectType >::Cast(), berry::SmartPointer< TObjectType >::IsNull(), berry::RadioState::PARAMETER_ID, and berry::RadioState::STATE_ID.

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

static

Toggles the command's state.

Parameters

command

The command whose state needs to be toggled

Returns

the original value before toggling

Exceptions

ExecutionException

When the command doesn't contain the toggle state or when the state doesn't contain a boolean value

Definition at line 358 of file berryHandlerUtil.cpp.

References berry::SmartPointer< TObjectType >::Cast(), berry::SmartPointer< TObjectType >::IsNull(), and berry::RegistryToggleState::STATE_ID.

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

static

Updates the radio state of the command to the given value

Parameters

command	the command whose state should be updated
newState	the new state

Exceptions

ExecutionException

When the command doesn't have a radio state

Definition at line 402 of file berryHandlerUtil.cpp.

References berry::SmartPointer< TObjectType >::IsNull(), and berry::RadioState::STATE_ID.

---

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

• berryHandlerUtil.h
• berryHandlerUtil.cpp