Medical Imaging Interaction Toolkit  2022.04.99-8b707dbd Medical Imaging Interaction Toolkit
berry::WorkbenchPreferenceConstants Struct Reference

#include <berryWorkbenchPreferenceConstants.h>

Static Public Attributes

static const QString OPEN_NEW_PERSPECTIVE

static const QString OPEN_PERSPECTIVE_WINDOW

static const QString OPEN_PERSPECTIVE_PAGE

static const QString OPEN_PERSPECTIVE_REPLACE

static const QString NO_NEW_PERSPECTIVE

static const QString DEFAULT_PERSPECTIVE_ID

static const QString PRESENTATION_FACTORY_ID

static const QString DOCK_PERSPECTIVE_BAR

static const QString PERSPECTIVE_BAR_SIZE

static const QString INITIAL_FAST_VIEW_BAR_LOCATION

static const QString PREFERRED_SASH_LAYOUT

static const QString TOP_RIGHT

static const QString TOP_LEFT

static const QString LEFT

static const QString BOTTOM

static const QString RIGHT

static const QString SHOW_INTRO

static const QString SHOW_TEXT_ON_PERSPECTIVE_BAR

static const QString SHOW_OPEN_ON_PERSPECTIVE_BAR

static const QString HELP_CONTENTS_ACTION_TEXT

static const QString HELP_SEARCH_ACTION_TEXT

static const QString DYNAMIC_HELP_ACTION_TEXT

static const QString ENABLE_ANIMATIONS

static const QString USE_COLORED_LABELS

static const QString KEY_CONFIGURATION_ID

static const QString EDITOR_MINIMUM_CHARACTERS

static const QString VIEW_MINIMUM_CHARACTERS

static const QString SHOW_SYSTEM_JOBS

static const QString CURRENT_THEME_ID

static const QString CLOSE_EDITORS_ON_EXIT

static const QString SHOW_PROGRESS_ON_STARTUP

static const QString SHOW_MEMORY_MONITOR

static const QString USE_WINDOW_WORKING_SET_BY_DEFAULT

static const QString SHOW_FILTERED_TEXTS

static const QString ENABLE_DETACHED_VIEWS

static const QString PROMPT_WHEN_SAVEABLE_STILL_OPEN

static const QString PERSPECTIVE_BAR_EXTRAS

static const QString LOCK_TRIM

static const QString ENABLE_NEW_MIN_MAX

static const QString DISABLE_NEW_FAST_VIEW

static const QString ENABLE_32_STICKY_CLOSE_BEHAVIOR

static const QString VIEW_TAB_POSITION

static const QString EDITOR_TAB_POSITION

static const QString SHOW_MULTIPLE_EDITOR_TABS

static const QString DISABLE_OPEN_EDITOR_IN_PLACE

Detailed Description

Preference ids exposed by the BlueBerry Platform User Interface. These preference settings can be obtained from the UI plug-in's preference store.

PlatformUI::PLUGIN_ID
Note
This class is not intended to be extended by clients.

Definition at line 28 of file berryWorkbenchPreferenceConstants.h.

◆ BOTTOM

 const QString berry::WorkbenchPreferenceConstants::BOTTOM
static

Constant to be used when referring to the bottom of the workbench window.

INITIAL_FAST_VIEW_BAR_LOCATION
Since
3.0

Definition at line 178 of file berryWorkbenchPreferenceConstants.h.

◆ CLOSE_EDITORS_ON_EXIT

 const QString berry::WorkbenchPreferenceConstants::CLOSE_EDITORS_ON_EXIT
static

A preference value indicating whether editors should be closed before saving the workbench state when exiting. The default is false.

Since
3.1

Definition at line 387 of file berryWorkbenchPreferenceConstants.h.

◆ CURRENT_THEME_ID

 const QString berry::WorkbenchPreferenceConstants::CURRENT_THEME_ID
static

Workbench preference for the current theme.

Since
3.1

Definition at line 378 of file berryWorkbenchPreferenceConstants.h.

◆ DEFAULT_PERSPECTIVE_ID

 const QString berry::WorkbenchPreferenceConstants::DEFAULT_PERSPECTIVE_ID
static

A named preference indicating the default workbench perspective.

Definition at line 84 of file berryWorkbenchPreferenceConstants.h.

◆ DISABLE_NEW_FAST_VIEW

 const QString berry::WorkbenchPreferenceConstants::DISABLE_NEW_FAST_VIEW
static

A named preference for disabling opening a new fast view from the fast view bar controls ("Show View as a fast view" button or "New Fast View" submenu).

Value is of type boolean.

The default is false.

Since
3.3

Definition at line 483 of file berryWorkbenchPreferenceConstants.h.

◆ DISABLE_OPEN_EDITOR_IN_PLACE

 const QString berry::WorkbenchPreferenceConstants::DISABLE_OPEN_EDITOR_IN_PLACE
static

Workbench preference id for whether the workbench may open editors in-place. Note that editors will only be opened in-place if this preference is false and if the current platform supports in-place editing.

Boolean-valued: false if editors may be opened in-place, and true if editors should never be opened in-place.

The default value for this preference is: false

Since
3.4

Definition at line 549 of file berryWorkbenchPreferenceConstants.h.

◆ DOCK_PERSPECTIVE_BAR

 const QString berry::WorkbenchPreferenceConstants::DOCK_PERSPECTIVE_BAR
static

A named preference indicating where the perspective bar should be docked. The default value (when this preference is not set) is TOP_RIGHT.

This preference may be one of the following values: TOP_RIGHT, TOP_LEFT, or LEFT.

Since
3.0

Definition at line 105 of file berryWorkbenchPreferenceConstants.h.

◆ DYNAMIC_HELP_ACTION_TEXT

 const QString berry::WorkbenchPreferenceConstants::DYNAMIC_HELP_ACTION_TEXT
static

A named preference for the text of the Dynamic Help action.

String-valued. If not specified, "&Dynamic Help" is used.

The default value for this preference is: null

Since
3.1

Definition at line 298 of file berryWorkbenchPreferenceConstants.h.

◆ EDITOR_MINIMUM_CHARACTERS

 const QString berry::WorkbenchPreferenceConstants::EDITOR_MINIMUM_CHARACTERS
static

Workbench preference identifier for the minimum width of editor tabs. By default, Eclipse does not define this value and allows SWT to determine this constant. We use -1 internally to signify "use default".

The default value for this preference is -1.

Since
3.1

Definition at line 352 of file berryWorkbenchPreferenceConstants.h.

◆ EDITOR_TAB_POSITION

 const QString berry::WorkbenchPreferenceConstants::EDITOR_TAB_POSITION
static

An named preference for whether or not tabs are on the top or bottom for editors. Values are either SWT.TOP or SWT.BOTTOM .

The default value for this preference is: SWT.TOP.

Since
3.4

Definition at line 518 of file berryWorkbenchPreferenceConstants.h.

◆ ENABLE_32_STICKY_CLOSE_BEHAVIOR

 const QString berry::WorkbenchPreferenceConstants::ENABLE_32_STICKY_CLOSE_BEHAVIOR
static

A named preference for enabling the 3.2 behavior for closing sticky views. When not enabled a sticky view is closed in all perspectives when the view is closed.

The default value for this preference is: false; use the 3.2 behaviour.

Since
3.3

Definition at line 496 of file berryWorkbenchPreferenceConstants.h.

◆ ENABLE_ANIMATIONS

 const QString berry::WorkbenchPreferenceConstants::ENABLE_ANIMATIONS
static

A named preference for enabling animations when a layout transition occurs

The default value for this preference is: true (show animations when a transition occurs)

Since
3.1

Definition at line 310 of file berryWorkbenchPreferenceConstants.h.

◆ ENABLE_DETACHED_VIEWS

 const QString berry::WorkbenchPreferenceConstants::ENABLE_DETACHED_VIEWS
static

Stores whether or not views may be detached. The default is true.

Since
3.2

Definition at line 428 of file berryWorkbenchPreferenceConstants.h.

◆ ENABLE_NEW_MIN_MAX

 const QString berry::WorkbenchPreferenceConstants::ENABLE_NEW_MIN_MAX
static

A named preference for providing the 3.3 presentation's min/max behaviour

The default value for this preference is: false; use the 3.2 behaviour.

Since
3.3

Definition at line 468 of file berryWorkbenchPreferenceConstants.h.

◆ HELP_CONTENTS_ACTION_TEXT

 const QString berry::WorkbenchPreferenceConstants::HELP_CONTENTS_ACTION_TEXT
static

A named preference for the text of the Help Contents action.

String-valued. If not specified, "&Help Contents" is used.

The default value for this preference is: null

Since
3.0

Definition at line 274 of file berryWorkbenchPreferenceConstants.h.

◆ HELP_SEARCH_ACTION_TEXT

 const QString berry::WorkbenchPreferenceConstants::HELP_SEARCH_ACTION_TEXT
static

A named preference for the text of the Help Search action.

String-valued. If not specified, "S&earch" is used.

The default value for this preference is: null

Since
3.1

Definition at line 286 of file berryWorkbenchPreferenceConstants.h.

◆ INITIAL_FAST_VIEW_BAR_LOCATION

 const QString berry::WorkbenchPreferenceConstants::INITIAL_FAST_VIEW_BAR_LOCATION
static

A named preference indicating where the fast view bar should be docked in a fresh workspace. This preference is meaningless after a workspace has been setup, since the fast view bar state is then persisted in the workbench. This preference is intended for applications that want the initial docking location to be somewhere specific. The default value (when this preference is not set) is the bottom.

LEFT
BOTTOM
RIGHT
Since
3.0

Definition at line 132 of file berryWorkbenchPreferenceConstants.h.

◆ KEY_CONFIGURATION_ID

 const QString berry::WorkbenchPreferenceConstants::KEY_CONFIGURATION_ID
static

Workbench preference id for the key configuration identifier to be treated as the default.

The default value for this preference is "org.eclipse.ui.defaultAcceleratorConfiguration".

Since
3.1

Definition at line 337 of file berryWorkbenchPreferenceConstants.h.

◆ LEFT

 const QString berry::WorkbenchPreferenceConstants::LEFT
static

Constant to be used when referring to the left side of the workbench window.

DOCK_PERSPECTIVE_BAR
INITIAL_FAST_VIEW_BAR_LOCATION
Since
3.0

Definition at line 170 of file berryWorkbenchPreferenceConstants.h.

static

A named preference for whether to show an editor when its input file is selected in the Navigator (and vice versa).

Value is of type boolean.

Definition at line 38 of file berryWorkbenchPreferenceConstants.h.

◆ LOCK_TRIM

 const QString berry::WorkbenchPreferenceConstants::LOCK_TRIM
static

Allows locking the trim to prevent user dragging on startup. The default is false.

Since
3.2

Definition at line 457 of file berryWorkbenchPreferenceConstants.h.

◆ NO_NEW_PERSPECTIVE

 const QString berry::WorkbenchPreferenceConstants::NO_NEW_PERSPECTIVE
static

A preference value indicating that an action should not open a new perspective.

Definition at line 79 of file berryWorkbenchPreferenceConstants.h.

◆ OPEN_NEW_PERSPECTIVE

 const QString berry::WorkbenchPreferenceConstants::OPEN_NEW_PERSPECTIVE
static

A named preference for how a new perspective is opened.

Value is of type QString. The possible values are defined by OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and OPEN_PERSPECTIVE_REPLACE.

OPEN_PERSPECTIVE_WINDOW
OPEN_PERSPECTIVE_PAGE
OPEN_PERSPECTIVE_REPLACE
NO_NEW_PERSPECTIVE

Definition at line 53 of file berryWorkbenchPreferenceConstants.h.

◆ OPEN_PERSPECTIVE_PAGE

 const QString berry::WorkbenchPreferenceConstants::OPEN_PERSPECTIVE_PAGE
static

A preference value indicating that an action should open a new perspective in a new page.

Deprecated:
Opening a Perspective in a new page is no longer supported functionality as of 2.0.

Definition at line 67 of file berryWorkbenchPreferenceConstants.h.

◆ OPEN_PERSPECTIVE_REPLACE

 const QString berry::WorkbenchPreferenceConstants::OPEN_PERSPECTIVE_REPLACE
static

A preference value indicating that an action should open a new perspective by replacing the current perspective.

Definition at line 73 of file berryWorkbenchPreferenceConstants.h.

◆ OPEN_PERSPECTIVE_WINDOW

 const QString berry::WorkbenchPreferenceConstants::OPEN_PERSPECTIVE_WINDOW
static

A preference value indicating that an action should open a new perspective in a new window.

Definition at line 59 of file berryWorkbenchPreferenceConstants.h.

◆ PERSPECTIVE_BAR_EXTRAS

 const QString berry::WorkbenchPreferenceConstants::PERSPECTIVE_BAR_EXTRAS
static

Lists the extra perspectives to show in the perspective bar. The value is a comma-separated list of perspective ids. The default is the empty string.

Since
3.2

Definition at line 449 of file berryWorkbenchPreferenceConstants.h.

◆ PERSPECTIVE_BAR_SIZE

 const QString berry::WorkbenchPreferenceConstants::PERSPECTIVE_BAR_SIZE
static

A preference indication the initial size of the perspective bar. The default value is 160. This preference only works when configurer.setShowPerspectiveBar(true) is set in WorkbenchWindowAdvisor::preWindowOpen()

This preference only uses integer values bug 84603: [RCP] [PerspectiveBar] New API or pref to set default perspective bar size

Since
3.5

Definition at line 117 of file berryWorkbenchPreferenceConstants.h.

◆ PREFERRED_SASH_LAYOUT

 const QString berry::WorkbenchPreferenceConstants::PREFERRED_SASH_LAYOUT
static

A named preference indicating the preferred layout direction of parts inside a sash container. The default value (when this preference is not set) is LEFT.

This preference may be one of the following values: LEFT or RIGHT.

Definition at line 142 of file berryWorkbenchPreferenceConstants.h.

◆ PRESENTATION_FACTORY_ID

 const QString berry::WorkbenchPreferenceConstants::PRESENTATION_FACTORY_ID
static

A named preference indicating the presentation factory to use for the workbench look and feel.

Since
3.0

Definition at line 92 of file berryWorkbenchPreferenceConstants.h.

◆ PROMPT_WHEN_SAVEABLE_STILL_OPEN

 const QString berry::WorkbenchPreferenceConstants::PROMPT_WHEN_SAVEABLE_STILL_OPEN
static

Stores whether or not the workbench prompts for saving when a dirty editor or view is closed, but the Saveable objects are still open in other parts. If true (default), the user will be prompted. If false, there will be no prompt.

Saveable
Since
3.2

Definition at line 440 of file berryWorkbenchPreferenceConstants.h.

◆ RIGHT

 const QString berry::WorkbenchPreferenceConstants::RIGHT
static

Constant to be used when referring to the right side of the workbench window.

INITIAL_FAST_VIEW_BAR_LOCATION
Since
3.0

Definition at line 187 of file berryWorkbenchPreferenceConstants.h.

◆ SHOW_FILTERED_TEXTS

 const QString berry::WorkbenchPreferenceConstants::SHOW_FILTERED_TEXTS
static

Stores whether or not to show the text widget that allows type-ahead search in the case where a FilteredTree is used to display and filter tree items.

Since
3.2

Definition at line 420 of file berryWorkbenchPreferenceConstants.h.

◆ SHOW_INTRO

 const QString berry::WorkbenchPreferenceConstants::SHOW_INTRO
static

A named preference indicating whether the workbench should show the introduction component (if available) on startup.

The default value for this preference is: true (show intro)

Since
3.0

Definition at line 201 of file berryWorkbenchPreferenceConstants.h.

◆ SHOW_MEMORY_MONITOR

 const QString berry::WorkbenchPreferenceConstants::SHOW_MEMORY_MONITOR
static

Stores whether or not to show the memory monitor in the workbench window.

Since
3.1

Definition at line 402 of file berryWorkbenchPreferenceConstants.h.

◆ SHOW_MULTIPLE_EDITOR_TABS

 const QString berry::WorkbenchPreferenceConstants::SHOW_MULTIPLE_EDITOR_TABS
static

Workbench preference id for whether the workbench should show multiple editor tabs.

Boolean-valued: true if editors should show multiple editor tabs, and false if editors should show a single editor tab.

The default value for this preference is: true

Since
3.4

Definition at line 533 of file berryWorkbenchPreferenceConstants.h.

◆ SHOW_OPEN_ON_PERSPECTIVE_BAR

 const QString berry::WorkbenchPreferenceConstants::SHOW_OPEN_ON_PERSPECTIVE_BAR
static

A named preference for whether the workbench should show the "open perspective" button on the perspective bar.

Boolean-valued: true, if editors should show "open perspective" button on the perspective bar, false otherwise.

The default value for this preference is: true (show "open perspective" button on the perspective bar)

Since
3.4

Definition at line 247 of file berryWorkbenchPreferenceConstants.h.

static

A named preference for whether the workbench should show the "Other..." menu item in the perspective menu.

Boolean-valued: true, if editors should show text on the "Other..." menu item, false otherwise.

The default value for this preference is: true (show the "Other..." menu item in the perspective menu)

Since
3.4

Definition at line 262 of file berryWorkbenchPreferenceConstants.h.

◆ SHOW_PROGRESS_ON_STARTUP

 const QString berry::WorkbenchPreferenceConstants::SHOW_PROGRESS_ON_STARTUP
static

Stores whether or not to show progress while starting the workbench. The default is false.

Since
3.1

Definition at line 395 of file berryWorkbenchPreferenceConstants.h.

◆ SHOW_SYSTEM_JOBS

 const QString berry::WorkbenchPreferenceConstants::SHOW_SYSTEM_JOBS
static

Stores whether or not system jobs are being shown.

Since
3.1

Definition at line 371 of file berryWorkbenchPreferenceConstants.h.

◆ SHOW_TEXT_ON_PERSPECTIVE_BAR

 const QString berry::WorkbenchPreferenceConstants::SHOW_TEXT_ON_PERSPECTIVE_BAR
static

A named preference for whether the workbench should show text on the perspective bar.

Boolean-valued: true, if editors should show text on the perspective bar, false otherwise.

The default value for this preference is: true (show text on the perspective bar)

Since
3.0

Definition at line 231 of file berryWorkbenchPreferenceConstants.h.

static

A named preference for whether the workbench should show traditional style tabs in editors and views.

Boolean-valued: true if editors and views should use a traditional style of tab and false if editors should show new style tab (3.0 style)

The default value for this preference is: true

Since
3.0

Definition at line 216 of file berryWorkbenchPreferenceConstants.h.

◆ TOP_LEFT

 const QString berry::WorkbenchPreferenceConstants::TOP_LEFT
static

Constant to be used when referring to the top left of the workbench window.

DOCK_PERSPECTIVE_BAR
Since
3.0

Definition at line 160 of file berryWorkbenchPreferenceConstants.h.

◆ TOP_RIGHT

 const QString berry::WorkbenchPreferenceConstants::TOP_RIGHT
static

Constant to be used when referring to the top right of the workbench window.

DOCK_PERSPECTIVE_BAR
Since
3.0

Definition at line 151 of file berryWorkbenchPreferenceConstants.h.

◆ USE_COLORED_LABELS

 const QString berry::WorkbenchPreferenceConstants::USE_COLORED_LABELS
static

A named preference that view implementors can used to determine whether or not they should utilize colored labels.

The default value for this preference is: true (show colored labels)

Since
3.4

Definition at line 323 of file berryWorkbenchPreferenceConstants.h.

◆ USE_WINDOW_WORKING_SET_BY_DEFAULT

 const QString berry::WorkbenchPreferenceConstants::USE_WINDOW_WORKING_SET_BY_DEFAULT
static

Stores whether or not to use the window working set as the default working set for newly created views (without previously stored state). This is a hint that view implementors should honor.

Since
3.2

Definition at line 411 of file berryWorkbenchPreferenceConstants.h.

◆ VIEW_MINIMUM_CHARACTERS

 const QString berry::WorkbenchPreferenceConstants::VIEW_MINIMUM_CHARACTERS
static

Workbench preference identifier for the minimum width of view tabs.

The default value for this preference is 1.

Since
3.2

Definition at line 364 of file berryWorkbenchPreferenceConstants.h.

◆ VIEW_TAB_POSITION

 const QString berry::WorkbenchPreferenceConstants::VIEW_TAB_POSITION
static

An named preference for whether or not tabs are on the top or bottom for views. Values are either SWT.TOP or SWT.BOTTOM .

The default value for this preference is: SWT.TOP.

Since
3.4

Definition at line 507 of file berryWorkbenchPreferenceConstants.h.

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