Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
Public Member Functions | Static Public Attributes | List of all members
berry::IPresentationFactory Class Referenceabstract

#include <berryIPresentationFactory.h>

Public Member Functions

virtual ~IPresentationFactory ()
 
virtual StackPresentation::Pointer CreateEditorPresentation (QWidget *parent, IStackPresentationSite::Pointer site)=0
 
virtual StackPresentation::Pointer CreateViewPresentation (QWidget *parent, IStackPresentationSite::Pointer site)=0
 
virtual StackPresentation::Pointer CreateStandaloneViewPresentation (QWidget *parent, IStackPresentationSite::Pointer site, bool showTitle)=0
 
virtual QString GetId ()=0
 
virtual QWidget * CreateSash (QWidget *parent, int style)=0
 
virtual int GetSashSize (int style)=0
 
virtual void UpdateTheme ()=0
 

Static Public Attributes

static int SASHTYPE_NORMAL
 
static int SASHTYPE_FLOATING
 
static int SASHORIENTATION_HORIZONTAL
 
static int SASHORIENTATION_VERTICAL
 

Detailed Description

This is a factory for presentation objects that control the appearance of editors, views and other components in the workbench.

Since
3.0

Definition at line 32 of file berryIPresentationFactory.h.

Constructor & Destructor Documentation

◆ ~IPresentationFactory()

virtual berry::IPresentationFactory::~IPresentationFactory ( )
virtual

Member Function Documentation

◆ CreateEditorPresentation()

virtual StackPresentation::Pointer berry::IPresentationFactory::CreateEditorPresentation ( QWidget *  parent,
IStackPresentationSite::Pointer  site 
)
pure virtual

Creates an editor presentation for presenting editors.

The presentation creates its controls under the given parent composite.

Parameters
parentthe parent composite to use for the presentation's controls
sitethe site used for communication between the presentation and the workbench
Returns
a newly created part presentation

◆ CreateSash()

virtual QWidget* berry::IPresentationFactory::CreateSash ( QWidget *  parent,
int  style 
)
pure virtual

Creates the Sash control that is used to separate view and editor parts.

Parameters
parentthe parent composite
styleA bit set giving both the 'type' of the desired sash and its orientation (i.e. one 'SASHTYPE' value and one "SASHORIENTATION" value).
Returns
the sash control
Since
3.4

◆ CreateStandaloneViewPresentation()

virtual StackPresentation::Pointer berry::IPresentationFactory::CreateStandaloneViewPresentation ( QWidget *  parent,
IStackPresentationSite::Pointer  site,
bool  showTitle 
)
pure virtual

Creates a standalone stack presentation for presenting a standalone view. A standalone view cannot be docked together with other views. The title of a standalone view may be hidden.

The presentation creates its controls under the given parent composite.

Parameters
parentthe parent composite to use for the presentation's controls
sitethe site used for communication between the presentation and the workbench
showTitletrue to show the title for the view, false to hide it
Returns
a newly created part presentation

◆ CreateViewPresentation()

virtual StackPresentation::Pointer berry::IPresentationFactory::CreateViewPresentation ( QWidget *  parent,
IStackPresentationSite::Pointer  site 
)
pure virtual

Creates a stack presentation for presenting regular docked views.

The presentation creates its controls under the given parent composite.

Parameters
parentthe parent composite to use for the presentation's controls
sitethe site used for communication between the presentation and the workbench
Returns
a newly created part presentation

◆ GetId()

virtual QString berry::IPresentationFactory::GetId ( )
pure virtual

Returns a globally unique identifier for this type of presentation factory. This is used to ensure that one presentation is not restored from mementos saved by a different presentation.

Returns
a globally unique identifier for this type of presentation factory.

◆ GetSashSize()

virtual int berry::IPresentationFactory::GetSashSize ( int  style)
pure virtual

Returns the size of the Sash control that is used to separate view and editor parts.

Parameters
styleA bit set giving both the 'type' of the desired sash and its orientation.
Returns
the sash size
Since
3.4

◆ UpdateTheme()

virtual void berry::IPresentationFactory::UpdateTheme ( )
pure virtual

Applies changes of the current theme to the user interface.

Member Data Documentation

◆ SASHORIENTATION_HORIZONTAL

int berry::IPresentationFactory::SASHORIENTATION_HORIZONTAL
static

Bit value for the createSash method's 'style' parameter.

Since
3.4

Definition at line 52 of file berryIPresentationFactory.h.

◆ SASHORIENTATION_VERTICAL

int berry::IPresentationFactory::SASHORIENTATION_VERTICAL
static

Bit value for the createSash method's 'style' parameter.

Since
3.4

Definition at line 57 of file berryIPresentationFactory.h.

◆ SASHTYPE_FLOATING

int berry::IPresentationFactory::SASHTYPE_FLOATING
static

Bit value for the createSash method's 'style' parameter.

Since
3.4

Definition at line 47 of file berryIPresentationFactory.h.

◆ SASHTYPE_NORMAL

int berry::IPresentationFactory::SASHTYPE_NORMAL
static

Bit value for the createSash method's 'style' parameter.

Since
3.4

Definition at line 42 of file berryIPresentationFactory.h.

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