Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Static Public Member Functions | List of all members
berry::ISources Struct Reference
BlueBerry Plugins » org.blueberry.ui.qt

#include <berryISources.h>

Static Public Member Functions

static int WORKBENCH ()
 
static int ACTIVE_CONTEXT ()
 
static const QString ACTIVE_CONTEXT_NAME ()
 
static int ACTIVE_ACTION_SETS ()
 
static const QString ACTIVE_ACTION_SETS_NAME ()
 
static int ACTIVE_SHELL ()
 
static const QString ACTIVE_SHELL_NAME ()
 
static int ACTIVE_WORKBENCH_WINDOW_SHELL ()
 
static const QString ACTIVE_WORKBENCH_WINDOW_SHELL_NAME ()
 
static int ACTIVE_WORKBENCH_WINDOW ()
 
static const QString ACTIVE_WORKBENCH_WINDOW_NAME ()
 
static int ACTIVE_WORKBENCH_WINDOW_SUBORDINATE ()
 
static const QString ACTIVE_WORKBENCH_WINDOW_IS_TOOLBAR_VISIBLE_NAME ()
 
static const QString ACTIVE_WORKBENCH_WINDOW_IS_PERSPECTIVEBAR_VISIBLE_NAME ()
 
static const QString ACTIVE_WORKBENCH_WINDOW_IS_STATUS_LINE_VISIBLE_NAME ()
 
static const QString ACTIVE_WORKBENCH_WINDOW_ACTIVE_PERSPECTIVE_NAME ()
 
static int ACTIVE_EDITOR ()
 
static const QString ACTIVE_EDITOR_NAME ()
 
static const QString ACTIVE_EDITOR_INPUT_NAME ()
 
static int ACTIVE_EDITOR_ID ()
 
static const QString ACTIVE_EDITOR_ID_NAME ()
 
static int ACTIVE_PART ()
 
static const QString ACTIVE_PART_NAME ()
 
static int ACTIVE_PART_ID ()
 
static const QString ACTIVE_PART_ID_NAME ()
 
static int ACTIVE_SITE ()
 
static const QString ACTIVE_SITE_NAME ()
 
static const QString SHOW_IN_SELECTION ()
 
static const QString SHOW_IN_INPUT ()
 
static int ACTIVE_CURRENT_SELECTION ()
 
static const QString ACTIVE_CURRENT_SELECTION_NAME ()
 
static int ACTIVE_MENU ()
 
static const QString ACTIVE_MENU_NAME ()
 
static const QString ACTIVE_MENU_SELECTION_NAME ()
 
static const QString ACTIVE_MENU_EDITOR_INPUT_NAME ()
 
static const QString ACTIVE_FOCUS_CONTROL_NAME ()
 
static const QString ACTIVE_FOCUS_CONTROL_ID_NAME ()
 

Detailed Description

A source is type of event change that can occur within the workbench. For example, the active workbench window can change, so it is considered a source. Workbench services can track changes to these sources, and thereby try to resolve conflicts between a variety of possible options. This is most commonly used for things like handlers and contexts.

This interface defines the source that are known to the workbench at compile-time. These sources can be combined in a bit-wise fashion. So, for example, a ACTIVE_PART | ACTIVE_CONTEXT source includes change to both the active context and the active part.

The values assigned to each source indicates its relative priority. The higher the value, the more priority the source is given in resolving conflicts. Another way to look at this is that the higher the value, the more "local" the source is to what the user is currently doing. This is similar to, but distinct from the concept of components. The nesting support provided by components represent only one source (ACTIVE_SITE) that the workbench understands.

Note that for backward compatibility, we must reserve the lowest three bits for Priority instances using the old HandlerSubmission mechanism. This mechanism was used in Eclipse 3.0.

Note in 3.3:

Currently, source variables are not extensible by user plugins, and the number of bits available for resolving conflicts is limited. When the variable sources become user extensible a new conflict resolution mechanism will be implemented.

This interface is not intended to be implemented by clients. This interface is not intended to be extended by clients.

See also
org.blueberry.ui.ISourceProvider

Definition at line 70 of file berryISources.h.

Member Function Documentation

int berry::ISources::ACTIVE_ACTION_SETS ( )
static

The priority given when the source includes a particular action set.

Definition at line 42 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_ACTION_SETS_NAME ( )
static

The variable name for the active action sets. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 48 of file berryISources.cpp.

int berry::ISources::ACTIVE_CONTEXT ( )
static

The priority given when the source includes a particular context.

Definition at line 30 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_CONTEXT_NAME ( )
static

The variable name for the active contexts. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 36 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetActiveContexts(), and berry::HandlerUtil::GetActiveContextsChecked().

int berry::ISources::ACTIVE_CURRENT_SELECTION ( )
static

The priority given when the source includes the current selection.

Definition at line 202 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_CURRENT_SELECTION_NAME ( )
static

The variable name for the active selection. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 208 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetCurrentSelection(), and berry::HandlerUtil::GetCurrentSelectionChecked().

int berry::ISources::ACTIVE_EDITOR ( )
static

The priority given when the source includes the active editor part.

Definition at line 124 of file berryISources.cpp.

int berry::ISources::ACTIVE_EDITOR_ID ( )
static

The priority given when the source includes the active editor identifier.

Definition at line 142 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_EDITOR_ID_NAME ( )
static

The variable name for the active editor identifier. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 148 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetActiveEditorId(), and berry::HandlerUtil::GetActiveEditorIdChecked().

const QString berry::ISources::ACTIVE_EDITOR_INPUT_NAME ( )
static

The editor input of the currently active editor.

Definition at line 136 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_EDITOR_NAME ( )
static

The variable name for the active editor part. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 130 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_FOCUS_CONTROL_ID_NAME ( )
static

The variable name for the active focus Control id, when provided by the IFocusService.

Definition at line 244 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_FOCUS_CONTROL_NAME ( )
static

The variable name for the active focus Control, when provided by the IFocusService.

Definition at line 238 of file berryISources.cpp.

int berry::ISources::ACTIVE_MENU ( )
static

The priority given when the source includes the current menu.

Definition at line 214 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_MENU_EDITOR_INPUT_NAME ( )
static

The variable name for the local editor input which is sometimes available while a context menu is visible.

Definition at line 232 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetActiveMenuEditorInput(), and berry::HandlerUtil::GetActiveMenuEditorInputChecked().

const QString berry::ISources::ACTIVE_MENU_NAME ( )
static

The variable name for the active menu. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 220 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetActiveMenus(), and berry::HandlerUtil::GetActiveMenusChecked().

const QString berry::ISources::ACTIVE_MENU_SELECTION_NAME ( )
static

The variable name for the local selection, available while a context menu is visible.

Definition at line 226 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetActiveMenuSelection(), and berry::HandlerUtil::GetActiveMenuSelectionChecked().

int berry::ISources::ACTIVE_PART ( )
static

The priority given when the source includes the active part.

Definition at line 154 of file berryISources.cpp.

int berry::ISources::ACTIVE_PART_ID ( )
static

The priority given when the source includes the active part id.

Definition at line 166 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_PART_ID_NAME ( )
static

The variable name for the active part id. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 172 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetActivePartId(), and berry::HandlerUtil::GetActivePartIdChecked().

const QString berry::ISources::ACTIVE_PART_NAME ( )
static

The variable name for the active part. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 160 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetActivePart(), and berry::HandlerUtil::GetActivePartChecked().

int berry::ISources::ACTIVE_SHELL ( )
static

The priority given when the source includes the currently active shell.

Definition at line 54 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_SHELL_NAME ( )
static

The variable name for the active shell. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 60 of file berryISources.cpp.

int berry::ISources::ACTIVE_SITE ( )
static

The priority given when the source includes the active workbench site. In the case of nesting components, one should be careful to only activate the most nested component.

Definition at line 178 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_SITE_NAME ( )
static

The variable name for the active workbench site. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 184 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetActiveSite(), and berry::HandlerUtil::GetActiveSiteChecked().

int berry::ISources::ACTIVE_WORKBENCH_WINDOW ( )
static

The priority given when the source includes the currently active workbench window.

Definition at line 78 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_WORKBENCH_WINDOW_ACTIVE_PERSPECTIVE_NAME ( )
static

The variable name for the current perspective of the active workbench window. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 117 of file berryISources.cpp.

References ACTIVE_WORKBENCH_WINDOW_NAME().

const QString berry::ISources::ACTIVE_WORKBENCH_WINDOW_IS_PERSPECTIVEBAR_VISIBLE_NAME ( )
static

The variable name for the perspective bar visibility state of the active workbench window. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 103 of file berryISources.cpp.

References ACTIVE_WORKBENCH_WINDOW_NAME().

const QString berry::ISources::ACTIVE_WORKBENCH_WINDOW_IS_STATUS_LINE_VISIBLE_NAME ( )
static

The variable name for the status line visibility state of the active workbench window. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 110 of file berryISources.cpp.

References ACTIVE_WORKBENCH_WINDOW_NAME().

const QString berry::ISources::ACTIVE_WORKBENCH_WINDOW_IS_TOOLBAR_VISIBLE_NAME ( )
static

The variable name for the coolbar visibility state of the active workbench window. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 96 of file berryISources.cpp.

References ACTIVE_WORKBENCH_WINDOW_NAME().

const QString berry::ISources::ACTIVE_WORKBENCH_WINDOW_NAME ( )
static

The variable name for the active workbench window. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 84 of file berryISources.cpp.

Referenced by ACTIVE_WORKBENCH_WINDOW_ACTIVE_PERSPECTIVE_NAME(), ACTIVE_WORKBENCH_WINDOW_IS_PERSPECTIVEBAR_VISIBLE_NAME(), ACTIVE_WORKBENCH_WINDOW_IS_STATUS_LINE_VISIBLE_NAME(), ACTIVE_WORKBENCH_WINDOW_IS_TOOLBAR_VISIBLE_NAME(), berry::HandlerUtil::GetActiveWorkbenchWindow(), and berry::HandlerUtil::GetActiveWorkbenchWindowChecked().

int berry::ISources::ACTIVE_WORKBENCH_WINDOW_SHELL ( )
static

The priority given when the source includes the currently active workbench window shell.

Definition at line 66 of file berryISources.cpp.

const QString berry::ISources::ACTIVE_WORKBENCH_WINDOW_SHELL_NAME ( )
static

The variable name for the active workbench window shell. This is for use with the ISourceProvider and IEvaluationContext.

Definition at line 72 of file berryISources.cpp.

int berry::ISources::ACTIVE_WORKBENCH_WINDOW_SUBORDINATE ( )
static

The priority given when the source includes subordinate properties of the currently active workbench window.

Definition at line 90 of file berryISources.cpp.

const QString berry::ISources::SHOW_IN_INPUT ( )
static

The variable for the showIn input. This is for use with the ISourceProvider and IEvaluationContext.

See also
IShowInSource

Definition at line 196 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetShowInInput(), and berry::HandlerUtil::GetShowInInputChecked().

const QString berry::ISources::SHOW_IN_SELECTION ( )
static

The variable for the showIn selection. This is for use with the ISourceProvider and IEvaluationContext.

See also
IShowInSource

Definition at line 190 of file berryISources.cpp.

Referenced by berry::HandlerUtil::GetShowInSelection(), and berry::HandlerUtil::GetShowInSelectionChecked().

int berry::ISources::WORKBENCH ( )
static

The priority given to default handlers and handlers that are active across the entire workbench.

Definition at line 24 of file berryISources.cpp.

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