Medical Imaging Interaction Toolkit  2021.10.99-fd647480
Medical Imaging Interaction Toolkit
berry::IPresentablePart Struct Referenceabstract

#include <berryIPresentablePart.h>

Inheritance diagram for berry::IPresentablePart:
Collaboration diagram for berry::IPresentablePart:

Public Member Functions

 berryObjectMacro (berry::IPresentablePart)
 
 ~IPresentablePart () override
 
virtual void SetBounds (const QRect &bounds)=0
 
virtual void SetVisible (bool isVisible)=0
 
virtual void SetFocus ()=0
 
virtual void AddPropertyListener (IPropertyChangeListener *listener)=0
 
virtual void RemovePropertyListener (IPropertyChangeListener *listener)=0
 
virtual QString GetName () const =0
 
virtual QString GetTitle () const =0
 
virtual QString GetTitleStatus () const =0
 
virtual QIcon GetTitleImage ()=0
 
virtual QString GetTitleToolTip () const =0
 
virtual bool IsDirty () const =0
 
virtual bool IsBusy () const =0
 
virtual bool IsCloseable () const =0
 
virtual QToolBar * GetToolBar ()=0
 
virtual QWidget * GetControl ()=0
 
virtual QString GetPartProperty (const QString &key) const =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
 
- Public Member Functions inherited from berry::ISizeProvider
virtual ~ISizeProvider ()
 
virtual int GetSizeFlags (bool width)=0
 
virtual int ComputePreferredSize (bool width, int availableParallel, int availablePerpendicular, int preferredResult)=0
 

Static Public Attributes

static const int PROP_DIRTY
 
static const int PROP_INPUT
 
static const int PROP_TITLE
 
static const int PROP_CONTENT_DESCRIPTION
 
static const int PROP_PART_NAME
 
static const int PROP_BUSY
 
static const int PROP_TOOLBAR
 
static const int PROP_HIGHLIGHT_IF_BACK
 
static const int PROP_PANE_MENU
 
static const int PROP_PREFERRED_SIZE
 
- Static Public Attributes inherited from berry::ISizeProvider
static const int INF
 

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

This is a skin's interface to the contents of a view or editor. Note that this is essentially the same as IWorkbenchPart, except it does not provide access to lifecycle events and allows repositioning of the part.

Not intended to be implemented by clients.

Since
3.0
3.4 now extends ISizeProvider

Definition at line 36 of file berryIPresentablePart.h.

Constructor & Destructor Documentation

◆ ~IPresentablePart()

berry::IPresentablePart::~IPresentablePart ( )
override

Member Function Documentation

◆ AddPropertyListener()

virtual void berry::IPresentablePart::AddPropertyListener ( IPropertyChangeListener listener)
pure virtual

Adds a listener for changes to properties of this workbench part. Has no effect if an identical listener is already registered.

The properties ids are defined by the PROP_* constants, above.

Parameters
listenera property listener (not null)

◆ berryObjectMacro()

berry::IPresentablePart::berryObjectMacro ( berry::IPresentablePart  )

◆ GetControl()

virtual QWidget* berry::IPresentablePart::GetControl ( )
pure virtual

Returns the menu for this part or null if none

Returns
the menu for this part or null if none Returns an SWT control that can be used to indicate the tab order for this part. This can be returned as part of the result to StackPresentation#GetTabList. Any other use of this control is unsupported. This may return a placeholder control that is only meaningful in the context of getTabList.
the part's control (not null)

◆ GetName()

virtual QString berry::IPresentablePart::GetName ( ) const
pure virtual

Returns the short name of the part. This is used as the text on the tab when this part is stacked on top of other parts.

Returns
the short name of the part (not null)

◆ GetPartProperty()

virtual QString berry::IPresentablePart::GetPartProperty ( const QString &  key) const
pure virtual

Get a property from the part's arbitrary property set.

Note: this is a different set of properties than the ones covered by the PROP_* constants.

Parameters
keyThe property key to retrieve. Must not be null.
Returns
the property, or null if that property is not set.
Since
3.3

◆ GetTitle()

virtual QString berry::IPresentablePart::GetTitle ( ) const
pure virtual

Returns the title of this workbench part. If this value changes the part must fire a property listener event with PROP_TITLE.

The title is used to populate the title bar of this part's visual container.

Returns
the workbench part title (not null)

◆ GetTitleImage()

virtual QIcon berry::IPresentablePart::GetTitleImage ( )
pure virtual

Returns the title image of this workbench part. If this value changes the part must fire a property listener event with PROP_TITLE.

The title image is usually used to populate the title bar of this part's visual container. Since this image is managed by the part itself, callers must not dispose the returned image.

Returns
the title image

◆ GetTitleStatus()

virtual QString berry::IPresentablePart::GetTitleStatus ( ) const
pure virtual

Returns the status message from the part's title, or the empty string if none. This is a substring of the part's title. A typical title will consist of the part name, a separator, and a status message describing the current contents.

Presentations can query getName() and getTitleStatus() if they want to display the status message and name separately, or they can use getTitle() if they want to display the entire title.

Returns
the status message or the empty string if none (not null)

◆ GetTitleToolTip()

virtual QString berry::IPresentablePart::GetTitleToolTip ( ) const
pure virtual

Returns the title tool tip text of this workbench part. If this value changes the part must fire a property listener event with PROP_TITLE.

The tool tip text is used to populate the title bar of this part's visual container.

Returns
the workbench part title tool tip (not null)

◆ GetToolBar()

virtual QToolBar* berry::IPresentablePart::GetToolBar ( )
pure virtual

Returns the local toolbar for this part, or null if this part does not have a local toolbar. Callers must not dispose or downcast the return value.

Returns
the local toolbar for the part, or null if none

◆ IsBusy()

virtual bool berry::IPresentablePart::IsBusy ( ) const
pure virtual

Return true if the the receiver is currently in a busy state.

Returns
boolean true if busy

◆ IsCloseable()

virtual bool berry::IPresentablePart::IsCloseable ( ) const
pure virtual

Returns true iff this part can be closed

Returns
true iff this part can be closed
Since
3.1

◆ IsDirty()

virtual bool berry::IPresentablePart::IsDirty ( ) const
pure virtual

Returns true iff the contents of this part have changed recently. For editors, this indicates that the part has changed since the last save. For views, this indicates that the view contains interesting changes that it wants to draw the user's attention to.

Returns
true iff the part is dirty

◆ RemovePropertyListener()

virtual void berry::IPresentablePart::RemovePropertyListener ( IPropertyChangeListener listener)
pure virtual

Remove a listener that was previously added using addPropertyListener.

Parameters
listenera property listener (not null)

◆ SetBounds()

virtual void berry::IPresentablePart::SetBounds ( const QRect &  bounds)
pure virtual

Sets the bounds of this part.

Parameters
boundsbounding rectangle (not null)

◆ SetFocus()

virtual void berry::IPresentablePart::SetFocus ( )
pure virtual

Forces this part to have focus.

◆ SetVisible()

virtual void berry::IPresentablePart::SetVisible ( bool  isVisible)
pure virtual

Notifies the part whether or not it is visible in the current perspective. A part is visible iff any part of its widgetry can be seen.

Parameters
isVisibletrue if the part has just become visible, false if the part has just become hidden

Member Data Documentation

◆ PROP_BUSY

const int berry::IPresentablePart::PROP_BUSY
static

The property id for isBusy.

Definition at line 71 of file berryIPresentablePart.h.

◆ PROP_CONTENT_DESCRIPTION

const int berry::IPresentablePart::PROP_CONTENT_DESCRIPTION
static

The property id for IWorkbenchPart2.getContentDescription()

Definition at line 61 of file berryIPresentablePart.h.

◆ PROP_DIRTY

const int berry::IPresentablePart::PROP_DIRTY
static

The property id for isDirty.

Definition at line 45 of file berryIPresentablePart.h.

◆ PROP_HIGHLIGHT_IF_BACK

const int berry::IPresentablePart::PROP_HIGHLIGHT_IF_BACK
static

The property id for highlighting the part if it is not in front.

Definition at line 82 of file berryIPresentablePart.h.

◆ PROP_INPUT

const int berry::IPresentablePart::PROP_INPUT
static

The property id for getEditorInput.

Definition at line 50 of file berryIPresentablePart.h.

◆ PROP_PANE_MENU

const int berry::IPresentablePart::PROP_PANE_MENU
static

The property id for pane menu changes

Definition at line 87 of file berryIPresentablePart.h.

◆ PROP_PART_NAME

const int berry::IPresentablePart::PROP_PART_NAME
static

The property id for IWorkbenchPart2.getContentDescription()

Definition at line 66 of file berryIPresentablePart.h.

◆ PROP_PREFERRED_SIZE

const int berry::IPresentablePart::PROP_PREFERRED_SIZE
static

The property id for preferred size changes

Since
3.4

Definition at line 93 of file berryIPresentablePart.h.

◆ PROP_TITLE

const int berry::IPresentablePart::PROP_TITLE
static

The property id for getTitle, getTitleImage and getTitleToolTip.

Definition at line 56 of file berryIPresentablePart.h.

◆ PROP_TOOLBAR

const int berry::IPresentablePart::PROP_TOOLBAR
static

The property id for toolbar changes

Definition at line 76 of file berryIPresentablePart.h.


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