Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
berry::IPerspectiveDescriptor Struct Referenceabstract

#include <berryIPerspectiveDescriptor.h>

Inheritance diagram for berry::IPerspectiveDescriptor:
Collaboration diagram for berry::IPerspectiveDescriptor:

Public Member Functions

 berryObjectMacro (berry::IPerspectiveDescriptor)
 
 ~IPerspectiveDescriptor () override
 
virtual QString GetDescription () const =0
 
virtual QString GetId () const =0
 
virtual QIcon GetImageDescriptor () const =0
 
virtual QString GetLabel () const =0
 
virtual QStringList GetCategoryPath () const =0
 
virtual QStringList GetKeywordReferences () 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

A perspective descriptor describes a perspective in an IPerspectiveRegistry.

A perspective is a template for view visibility, layout, and action visibility within a workbench page. There are two types of perspective: a predefined perspective and a custom perspective.

  • A predefined perspective is defined by an extension to the workbench's perspective extension point ("org.blueberry.ui.perspectives"). The extension defines a id, label, and IPerspectiveFactory. A perspective factory is used to define the initial layout for a page.
  • A custom perspective is defined by the user. In this case a predefined perspective is modified to suit a particular task and saved as a new perspective. The attributes for the perspective are stored in a separate file in the workbench's metadata directory.

Within a page the user can open any of the perspectives known to the workbench's perspective registry, typically by selecting one from the workbench's Open Perspective menu. When selected, the views and actions within the active page rearrange to reflect the perspective.

This interface is not intended to be implemented by clients.

See also
IPerspectiveRegistry

Definition at line 56 of file berryIPerspectiveDescriptor.h.

Constructor & Destructor Documentation

◆ ~IPerspectiveDescriptor()

berry::IPerspectiveDescriptor::~IPerspectiveDescriptor ( )
override

Member Function Documentation

◆ berryObjectMacro()

berry::IPerspectiveDescriptor::berryObjectMacro ( berry::IPerspectiveDescriptor  )

◆ GetCategoryPath()

virtual QStringList berry::IPerspectiveDescriptor::GetCategoryPath ( ) const
pure virtual

Returns true if this perspective is predefined by an extension.

Returns
boolean whether this perspective is predefined by an extension Return the category path of this descriptor
the category path of this descriptor

◆ GetDescription()

virtual QString berry::IPerspectiveDescriptor::GetDescription ( ) const
pure virtual

Returns the description of this perspective. This is the value of its "description" attribute.

Returns
the description
Since
3.0

◆ GetId()

virtual QString berry::IPerspectiveDescriptor::GetId ( ) const
pure virtual

Returns this perspective's id. For perspectives declared via an extension, this is the value of its "id" attribute.

Returns
the perspective id

◆ GetImageDescriptor()

virtual QIcon berry::IPerspectiveDescriptor::GetImageDescriptor ( ) const
pure virtual

Returns the descriptor of the image to show for this perspective. If the extension for this perspective specifies an image, the descriptor for it is returned. Otherwise a default image is returned.

Returns
the descriptor of the image to show for this perspective

◆ GetKeywordReferences()

virtual QStringList berry::IPerspectiveDescriptor::GetKeywordReferences ( ) const
pure virtual

Returns a list of ids belonging to keyword reference extensions.

The keywords listed in each referenced id can be used to filter this perspective.

Returns
A list of ids for keyword reference extensions.

◆ GetLabel()

virtual QString berry::IPerspectiveDescriptor::GetLabel ( ) const
pure virtual

Returns this perspective's label. For perspectives declared via an extension, this is the value of its "label" attribute.

Returns
the label

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