Medical Imaging Interaction Toolkit
2016.11.0
Medical Imaging Interaction Toolkit
|
#include <berryIWorkbenchConfigurer.h>
Public Member Functions | |
berryObjectMacro (berry::IWorkbenchConfigurer)~IWorkbenchConfigurer() | |
virtual IWorkbench * | GetWorkbench ()=0 |
virtual bool | GetSaveAndRestore ()=0 |
virtual void | SetSaveAndRestore (bool enabled)=0 |
virtual IWorkbenchWindowConfigurer::Pointer | RestoreWorkbenchWindow (IMemento::Pointer memento)=0 |
virtual void | EmergencyClose ()=0 |
virtual bool | EmergencyClosing ()=0 |
virtual IWorkbenchWindowConfigurer::Pointer | GetWindowConfigurer (IWorkbenchWindow::Pointer window)=0 |
virtual Object::Pointer | GetData (const QString &key) const =0 |
virtual void | SetData (const QString &key, Object::Pointer data)=0 |
virtual bool | RestoreState ()=0 |
virtual void | OpenFirstTimeWindow ()=0 |
virtual bool | GetExitOnLastWindowClose ()=0 |
virtual void | SetExitOnLastWindowClose (bool enabled)=0 |
Public Member Functions inherited from berry::Object | |
virtual QString | GetClassName () const |
virtual Reflection::TypeInfo | GetTypeInfo () const |
virtual QList< Reflection::TypeInfo > | GetSuperclasses () const |
virtual void | Delete () |
QDebug | Print (QDebug os, Indent Indent=0) const |
virtual QString | ToString () const |
virtual uint | HashCode () const |
virtual bool | operator< (const Object *) const |
void | Register () const |
void | UnRegister (bool del=true) const |
int | GetReferenceCount () const |
void | SetReferenceCount (int) |
void | AddDestroyListener (const MessageAbstractDelegate<> &delegate) const |
void | RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const |
virtual bool | operator== (const Object *) const |
Static Public Attributes | |
static const int | RESTORE_CODE_RESET |
static const int | RESTORE_CODE_EXIT |
Additional Inherited Members | |
Public Types inherited from berry::Object | |
typedef Object | Self |
typedef berry::SmartPointer< Self > | Pointer |
typedef berry::SmartPointer< const Self > | ConstPointer |
typedef berry::WeakPointer< Self > | WeakPtr |
typedef berry::WeakPointer< const Self > | ConstWeakPtr |
Static Public Member Functions inherited from berry::Object | |
static const char * | GetStaticClassName () |
static Reflection::TypeInfo | GetStaticTypeInfo () |
static QList< Reflection::TypeInfo > | GetStaticSuperclasses () |
Protected Member Functions inherited from berry::Object | |
Object () | |
virtual | ~Object () |
virtual QDebug | PrintSelf (QDebug os, Indent indent) const |
virtual QDebug | PrintHeader (QDebug os, Indent indent) const |
virtual QDebug | PrintTrailer (QDebug os, Indent indent) const |
Protected Attributes inherited from berry::Object | |
QAtomicInt | m_ReferenceCount |
QMutex | m_ReferenceCountLock |
Interface providing special access for configuring the workbench.
Note that these objects are only available to the main application (the plug-in that creates and owns the workbench).
This interface is not intended to be implemented by clients.
Definition at line 42 of file berryIWorkbenchConfigurer.h.
berry::IWorkbenchConfigurer::berryObjectMacro | ( | berry::IWorkbenchConfigurer | ) |
|
pure virtual |
Forces the workbench to close due to an emergency. This method should only be called when the workbench is in dire straights and cannot continue, and cannot even risk a normal workbench close (think "out of
memory" or "unable to create shell"). When this method is called, an abbreviated workbench shutdown sequence is performed (less critical steps may be skipped). The workbench advisor is still called; however, it must not attempt to communicate with the user. While an emergency close is in progress, EmergencyClosing()
returns true
. Workbench advisor methods should always check this flag before communicating with the user.
|
pure virtual |
Returns whether the workbench is being closed due to an emergency. When this method returns true
, the workbench is in dire straights and cannot continue. Indeed, things are so bad that we cannot even risk a normal workbench close. Workbench advisor methods should always check this flag before attempting to communicate with the user.
true
if the workbench is in the process of being closed under emergency conditions, and false
otherwise
|
pure virtual |
Returns the data associated with the workbench at the given key.
key | the key |
null
if there is no data at the given key
|
pure virtual |
Returns true
if the workbench should exit when the last window is closed, false
if the window should just be closed, leaving the workbench (and its event loop) running.
If true
, the last window's state is saved before closing, so that it will be restored in the next session. This applies only if GetSaveAndRestore()
returns true
).
If false
, the window is simply closed, losing its state.
If the workbench is left running, it can be closed using IWorkbench::Close()
, or a new window can be opened using IWorkbench::OpenWorkbenchWindow(const QString&, IAdaptable*)
.
The initial value is true
.
true
if the workbench will exit when the last window is closed, false
if the window should just be closed
|
pure virtual |
Returns whether the workbench state should be saved on close and restored on subsequent open.
The initial value is false
.
true
to save and restore workbench state, or false
to forget current workbench state on close.
|
pure virtual |
Returns an object that can be used to configure the given window.
window | a workbench window |
|
pure virtual |
Returns the underlying workbench.
|
pure virtual |
Opens the first time window, using the default perspective and default page input.
This is typically called from the advisor's WorkbenchAdvisor::OpenWindows()
method.
|
pure virtual |
Restores the workbench state saved from the previous session, if any. This includes any open windows and their open perspectives, open views and editors, layout information, and any customizations to the open perspectives.
This is typically called from the advisor's WorkbenchAdvisor::OpenWindows()
method.
|
pure virtual |
Restores a workbench window from the given memento.
memento | the memento from which to restore the window's state |
WorkbenchException | if an error occurred during the restore |
|
pure virtual |
Sets the data associated with the workbench at the given key.
key | the key |
data | the data, or null to delete existing data |
|
pure virtual |
Sets whether the workbench should exit when the last window is closed, or whether the window should just be closed, leaving the workbench (and its event loop) running.
For more details, see GetExitOnLastWindowClose()
.
enabled | true if the workbench should exit when the last window is closed, false if the window should just be closed |
|
pure virtual |
Sets whether the workbench state should be saved on close and restored on subsequent open.
enabled | true to save and restore workbench state, or false to forget current workbench state on close. |
|
static |
Restore status code indicating that the saved state could not be restored, and that the application must exit immediately without modifying any previously saved workbench state.
Definition at line 64 of file berryIWorkbenchConfigurer.h.
|
static |
Restore status code indicating that the saved state could not be restored, but that startup should continue with a reset state.
Definition at line 56 of file berryIWorkbenchConfigurer.h.