Medical Imaging Interaction Toolkit  2018.4.99-65942676
Medical Imaging Interaction Toolkit
berry::IWorkbenchPartReference Struct Referenceabstract

#include <berryIWorkbenchPartReference.h>

Inheritance diagram for berry::IWorkbenchPartReference:
Collaboration diagram for berry::IWorkbenchPartReference:

Public Member Functions

 berryObjectMacro (berry::IWorkbenchPartReference)
 
 ~IWorkbenchPartReference () override
 
virtual SmartPointer< IWorkbenchPartGetPart (bool restore)=0
 
virtual QIcon GetTitleImage () const =0
 
virtual QString GetTitleToolTip () const =0
 
virtual QString GetId () const =0
 
virtual void AddPropertyListener (IPropertyChangeListener *listener)=0
 
virtual void RemovePropertyListener (IPropertyChangeListener *listener)=0
 
virtual SmartPointer< IWorkbenchPageGetPage () const =0
 
virtual QString GetPartName () const =0
 
virtual QString GetContentDescription () const =0
 
virtual bool IsPinned () const =0
 
virtual bool IsDirty () const =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
 

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

Implements a reference to a IWorkbenchPart. The IWorkbenchPart will not be instanciated until the part becomes visible or the API getPart is sent with true;

This interface is not intended to be implemented by clients.

Definition at line 36 of file berryIWorkbenchPartReference.h.

Constructor & Destructor Documentation

◆ ~IWorkbenchPartReference()

berry::IWorkbenchPartReference::~IWorkbenchPartReference ( )
override

Member Function Documentation

◆ AddPropertyListener()

virtual void berry::IWorkbenchPartReference::AddPropertyListener ( IPropertyChangeListener listener)
pure virtual
See also
IWorkbenchPart::addPropertyListener

◆ berryObjectMacro()

berry::IWorkbenchPartReference::berryObjectMacro ( berry::IWorkbenchPartReference  )

◆ GetContentDescription()

virtual QString berry::IWorkbenchPartReference::GetContentDescription ( ) const
pure virtual

Returns the content description for the part (or the empty string if none)

Returns
the content description for the part

◆ GetId()

virtual QString berry::IWorkbenchPartReference::GetId ( ) const
pure virtual
See also
IWorkbenchPartSite::getId

◆ GetPage()

virtual SmartPointer<IWorkbenchPage> berry::IWorkbenchPartReference::GetPage ( ) const
pure virtual

Returns the workbench page that contains this part

◆ GetPart()

virtual SmartPointer<IWorkbenchPart> berry::IWorkbenchPartReference::GetPart ( bool  restore)
pure virtual

Returns the IWorkbenchPart referenced by this object. Returns null if the editors was not instantiated or it failed to be restored. Tries to restore the editor if restore is true.

◆ GetPartName()

virtual QString berry::IWorkbenchPartReference::GetPartName ( ) const
pure virtual

Returns the name of the part, as it should be shown in tabs.

Returns
the part name

◆ GetPartProperty()

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

Return an arbitrary property from the reference. If the part has been instantiated, it just delegates to the part. If not, then it looks in its own cache of properties. If the property is not available or the part has never been instantiated, it can return null.

Parameters
keyThe property to return. Must not be null.
Returns
The String property, or null.

◆ GetTitleImage()

virtual QIcon berry::IWorkbenchPartReference::GetTitleImage ( ) const
pure virtual
See also
IWorkbenchPart::getTitleImage

◆ GetTitleToolTip()

virtual QString berry::IWorkbenchPartReference::GetTitleToolTip ( ) const
pure virtual
See also
IWorkbenchPart::getTitleToolTip

◆ IsDirty()

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

Returns whether the part is dirty (i.e. has unsaved changes).

Returns
true if the part is dirty, false otherwise

◆ IsPinned()

virtual bool berry::IWorkbenchPartReference::IsPinned ( ) const
pure virtual

Returns true if the part is pinned otherwise returns false.

◆ RemovePropertyListener()

virtual void berry::IWorkbenchPartReference::RemovePropertyListener ( IPropertyChangeListener listener)
pure virtual
See also
IWorkbenchPart::removePropertyListener

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