Medical Imaging Interaction Toolkit  2018.4.99-08619e4f
Medical Imaging Interaction Toolkit
berry::IWorkbenchWindowConfigurer Struct Referenceabstract

#include <berryIWorkbenchWindowConfigurer.h>

Inheritance diagram for berry::IWorkbenchWindowConfigurer:
Collaboration diagram for berry::IWorkbenchWindowConfigurer:

Public Member Functions

 berryObjectMacro (berry::IWorkbenchWindowConfigurer)
 
 ~IWorkbenchWindowConfigurer () override
 
virtual SmartPointer< IWorkbenchWindowGetWindow ()=0
 
virtual SmartPointer< IWorkbenchConfigurerGetWorkbenchConfigurer ()=0
 
virtual SmartPointer< IActionBarConfigurerGetActionBarConfigurer ()=0
 
virtual QString GetTitle ()=0
 
virtual void SetTitle (const QString &title)=0
 
virtual bool GetShowMenuBar () const =0
 
virtual void SetShowMenuBar (bool show)=0
 
virtual bool GetShowToolBar () const =0
 
virtual void SetShowToolBar (bool show)=0
 
virtual bool GetShowStatusLine () const =0
 
virtual void SetShowStatusLine (bool show)=0
 
virtual bool GetShowPerspectiveBar () const =0
 
virtual void SetShowPerspectiveBar (bool show)=0
 
virtual bool GetShowProgressIndicator () const =0
 
virtual void SetShowProgressIndicator (bool show)=0
 
virtual Qt::WindowFlags GetWindowFlags () const =0
 
virtual void SetWindowFlags (Qt::WindowFlags windowFlags)=0
 
virtual QPoint GetInitialSize () const =0
 
virtual void SetInitialSize (QPoint initialSize)=0
 
virtual void AddEditorAreaTransfer (const QStringList &transferTypes)=0
 
virtual void ConfigureEditorAreaDropListener (IDropTargetListener *dropTargetListener)=0
 
virtual QMenuBar * CreateMenuBar ()=0
 
virtual QWidget * CreateToolBar (QWidget *parent)=0
 
virtual QWidget * CreatePageComposite (QWidget *parent)=0
 
virtual bool SaveState (SmartPointer< IMemento > memento)=0
 
- Public Member Functions inherited from berry::Object
virtual QString GetClassName () const
 
virtual Reflection::TypeInfo GetTypeInfo () const
 
virtual QList< Reflection::TypeInfoGetSuperclasses () 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
 

Additional Inherited Members

- Public Types inherited from berry::Object
typedef Object Self
 
typedef berry::SmartPointer< SelfPointer
 
typedef berry::SmartPointer< const SelfConstPointer
 
typedef berry::WeakPointer< SelfWeakPtr
 
typedef berry::WeakPointer< const SelfConstWeakPtr
 
- Static Public Member Functions inherited from berry::Object
static const char * GetStaticClassName ()
 
static Reflection::TypeInfo GetStaticTypeInfo ()
 
static QList< Reflection::TypeInfoGetStaticSuperclasses ()
 
- 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
 

Detailed Description

Interface providing special access for configuring workbench windows.

Window configurer objects are in 1-1 correspondence with the workbench windows they configure. Clients may use Get/SetData to associate arbitrary state with the window configurer object.

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.

See also
IWorkbenchConfigurer::GetWindowConfigurer()
WorkbenchAdvisor::PreWindowOpen()
Note
This interface is not intended to be implemented by clients.

Definition at line 50 of file berryIWorkbenchWindowConfigurer.h.

Constructor & Destructor Documentation

◆ ~IWorkbenchWindowConfigurer()

berry::IWorkbenchWindowConfigurer::~IWorkbenchWindowConfigurer ( )
override

Definition at line 18 of file berryIWorkbenchWindowConfigurer.cpp.

Member Function Documentation

◆ AddEditorAreaTransfer()

virtual void berry::IWorkbenchWindowConfigurer::AddEditorAreaTransfer ( const QStringList &  transferTypes)
pure virtual

Adds the given drag and drop Mime types to the ones supported for drag and drop on the editor area of this workbench window.

The workbench advisor would ordinarily call this method from the PreWindowOpen callback. A newly-created workbench window supports no drag and drop transfer types.

Note that drag and drop to the editor area requires adding one or more transfer types (using AddEditorAreaTransfer) and configuring a drop target listener (with ConfigureEditorAreaDropListener) capable of handling any of those transfer types.

Parameters
transfera drag and drop transfer object
See also
#configureEditorAreaDropListener
org.blueberry.ui.part.EditorInputTransfer

◆ berryObjectMacro()

berry::IWorkbenchWindowConfigurer::berryObjectMacro ( berry::IWorkbenchWindowConfigurer  )

◆ ConfigureEditorAreaDropListener()

virtual void berry::IWorkbenchWindowConfigurer::ConfigureEditorAreaDropListener ( IDropTargetListener dropTargetListener)
pure virtual

Configures the drop target listener for the editor area of this workbench window.

The workbench advisor ordinarily calls this method from the PreWindowOpen callback. A newly-created workbench window has no configured drop target listener for its editor area.

Note that drag and drop to the editor area requires adding one or more transfer types (using AddEditorAreaTransfer) and configuring a drop target listener (with ConfigureEditorAreaDropListener) capable of handling any of those transfer types.

Parameters
dropTargetListenerthe drop target listener that will handle requests to drop an object on to the editor area of this window
See also
AddEditorAreaTransfer

◆ CreateMenuBar()

virtual QMenuBar* berry::IWorkbenchWindowConfigurer::CreateMenuBar ( )
pure virtual

Creates the menu bar for the window's shell.

This should only be called if the advisor is defining custom window contents in CreateWindowContents, and may only be called once. The caller must set it in the shell using Shell.setMenuBar(Menu) but must not make add, remove or change items in the result. The menu bar is populated by the window's menu manager. The application can add to the menu manager in the advisor's FillActionBars method instead.

Returns
the menu bar, suitable for setting in the shell

◆ CreatePageComposite()

virtual QWidget* berry::IWorkbenchWindowConfigurer::CreatePageComposite ( QWidget *  parent)
pure virtual

Creates the page composite, in which the window's pages, and their views and editors, appear.

This should only be called if the advisor is defining custom window contents in WorkbenchWindowAdvisor::CreateWindowContents(), and may only be called once. The caller must lay out the page composite appropriately within the parent, but must not add, remove or change items in the result. The page composite is populated by the workbench.

Parameters
parentthe parent composite
Returns
the page composite, suitable for laying out in the parent

◆ CreateToolBar()

virtual QWidget* berry::IWorkbenchWindowConfigurer::CreateToolBar ( QWidget *  parent)
pure virtual

Creates the tool bar control.

This should only be called if the advisor is defining custom window contents in CreateWindowContents, and may only be called once. The caller must lay out the tool bar appropriately within the parent, but must not add, remove or change items in the result (hence the return type of QWidget). The tool bar is populated by the window's tool bar manager. The application can add to the tool bar manager in the advisor's FillActionBars method instead.

Parameters
parentthe parent widget
Returns
the tool bar control, suitable for laying out in the parent

◆ GetActionBarConfigurer()

virtual SmartPointer<IActionBarConfigurer> berry::IWorkbenchWindowConfigurer::GetActionBarConfigurer ( )
pure virtual

Returns the action bar configurer for this workbench window.

Returns
the action bar configurer

◆ GetInitialSize()

virtual QPoint berry::IWorkbenchWindowConfigurer::GetInitialSize ( ) const
pure virtual

Returns the size to use for the window's shell when it is created.

Returns
the initial size to use for the shell

◆ GetShowMenuBar()

virtual bool berry::IWorkbenchWindowConfigurer::GetShowMenuBar ( ) const
pure virtual

Returns whether the underlying workbench window has a menu bar.

The initial value is true.

Returns
true for a menu bar, and false for no menu bar

◆ GetShowPerspectiveBar()

virtual bool berry::IWorkbenchWindowConfigurer::GetShowPerspectiveBar ( ) const
pure virtual

Returns whether the underlying workbench window has a perspective bar (the perspective bar provides buttons to quickly switch between perspectives).

The initial value is false.

Returns
true for a perspective bar, and false for no perspective bar

◆ GetShowProgressIndicator()

virtual bool berry::IWorkbenchWindowConfigurer::GetShowProgressIndicator ( ) const
pure virtual

Returns whether the underlying workbench window has a progress indicator.

The initial value is false.

Returns
true for a progress indicator, and false for no progress indicator

◆ GetShowStatusLine()

virtual bool berry::IWorkbenchWindowConfigurer::GetShowStatusLine ( ) const
pure virtual

Returns whether the underlying workbench window has a status line.

The initial value is true.

Returns
true for a status line, and false for no status line

◆ GetShowToolBar()

virtual bool berry::IWorkbenchWindowConfigurer::GetShowToolBar ( ) const
pure virtual

Returns whether the underlying workbench window has a tool bar.

The initial value is true.

Returns
true for a tool bar, and false for no tool bar

◆ GetTitle()

virtual QString berry::IWorkbenchWindowConfigurer::GetTitle ( )
pure virtual

Returns the title of the underlying workbench window.

Returns
the window title

◆ GetWindow()

virtual SmartPointer<IWorkbenchWindow> berry::IWorkbenchWindowConfigurer::GetWindow ( )
pure virtual

Returns the underlying workbench window.

Returns
the workbench window

◆ GetWindowFlags()

virtual Qt::WindowFlags berry::IWorkbenchWindowConfigurer::GetWindowFlags ( ) const
pure virtual

Returns the style bits to use for the window's main widget when it is created. The default is 0.

Returns
the style bits

◆ GetWorkbenchConfigurer()

virtual SmartPointer<IWorkbenchConfigurer> berry::IWorkbenchWindowConfigurer::GetWorkbenchConfigurer ( )
pure virtual

Returns the workbench configurer.

Returns
the workbench configurer

◆ SaveState()

virtual bool berry::IWorkbenchWindowConfigurer::SaveState ( SmartPointer< IMemento memento)
pure virtual

Saves the current state of the window using the specified memento.

Parameters
mementothe memento in which to save the window's state
Returns
a status object indicating whether the save was successful
See also
IWorkbenchConfigurer::RestoreWorkbenchWindow(IMemento::Pointer)

◆ SetInitialSize()

virtual void berry::IWorkbenchWindowConfigurer::SetInitialSize ( QPoint  initialSize)
pure virtual

Sets the size to use for the window's shell when it is created. This method has no effect after the shell is created. That is, it must be called within the WorkbenchAdvisor::PreWindowOpen() callback.

Parameters
initialSizethe initial size to use for the shell

◆ SetShowMenuBar()

virtual void berry::IWorkbenchWindowConfigurer::SetShowMenuBar ( bool  show)
pure virtual

Sets whether the underlying workbench window has a menu bar.

Parameters
showtrue for a menu bar, and false for no menu bar

◆ SetShowPerspectiveBar()

virtual void berry::IWorkbenchWindowConfigurer::SetShowPerspectiveBar ( bool  show)
pure virtual

Sets whether the underlying workbench window has a perspective bar (the perspective bar provides buttons to quickly switch between perspectives).

Parameters
showtrue for a perspective bar, and false for no perspective bar

◆ SetShowProgressIndicator()

virtual void berry::IWorkbenchWindowConfigurer::SetShowProgressIndicator ( bool  show)
pure virtual

Sets whether the underlying workbench window has a progress indicator.

Parameters
showtrue for a progress indicator, and false for no progress indicator

◆ SetShowStatusLine()

virtual void berry::IWorkbenchWindowConfigurer::SetShowStatusLine ( bool  show)
pure virtual

Sets whether the underlying workbench window has a status line.

Parameters
showtrue for a status line, and false for no status line

◆ SetShowToolBar()

virtual void berry::IWorkbenchWindowConfigurer::SetShowToolBar ( bool  show)
pure virtual

Sets whether the underlying workbench window has a tool bar.

Parameters
showtrue for a tool bar, and false for no tool bar

◆ SetTitle()

virtual void berry::IWorkbenchWindowConfigurer::SetTitle ( const QString &  title)
pure virtual

Sets the title of the underlying workbench window.

Parameters
titlethe window title

◆ SetWindowFlags()

virtual void berry::IWorkbenchWindowConfigurer::SetWindowFlags ( Qt::WindowFlags  windowFlags)
pure virtual

Sets the style bits to use for the window's main widget when it is created. This method has no effect after the widget is created. That is, it must be called within the WorkbenchAdvisor::PreWindowOpen() callback.

For more details on the applicable style bits, see the documentation for Qt::WindowFlags.

Parameters
windowFlagsthe style bits

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