berry::IViewDescriptor Struct Reference

#include <berryIViewDescriptor.h>

Inheritance diagram for berry::IViewDescriptor:

Collaboration diagram for berry::IViewDescriptor:

Public Member Functions
	berryObjectMacro (berry::IViewDescriptor)
	~IViewDescriptor () override
virtual IViewPart::Pointer	CreateView ()=0
virtual QStringList	GetKeywordReferences () const =0
virtual QStringList	GetCategoryPath () const =0
virtual QString	GetDescription () const =0
QIcon	GetImageDescriptor () const override=0
virtual bool	GetAllowMultiple () const =0
virtual bool	IsRestorable () const =0
virtual bool	IsInternal () const =0
bool	operator== (const Object *) const override=0
Public Member Functions inherited from berry::IWorkbenchPartDescriptor
	berryObjectMacro (berry::IWorkbenchPartDescriptor)
virtual QString	GetId () const =0
virtual QString	GetLabel () const =0
	~IWorkbenchPartDescriptor () override
Public Member Functions inherited from berry::Object
virtual QString	GetClassName () const
virtual Reflection::TypeInfo	GetTypeInfo () const
virtual QList< Reflection::TypeInfo >	GetSuperclasses () 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
Public Member Functions inherited from berry::IAdaptable
virtual Object *	GetAdapter (const QString &adapterType) const =0
template<class A >
A *	GetAdapter ()
virtual	~IAdaptable ()

Additional Inherited Members
Public Types inherited from berry::Object
typedef Object	Self
typedef berry::SmartPointer< Self >	Pointer
typedef berry::SmartPointer< const Self >	ConstPointer
typedef berry::WeakPointer< Self >	WeakPtr
typedef berry::WeakPointer< const Self >	ConstWeakPtr
Static Public Member Functions inherited from berry::Object
static const char *	GetStaticClassName ()
static Reflection::TypeInfo	GetStaticTypeInfo ()
static QList< Reflection::TypeInfo >	GetStaticSuperclasses ()
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 view descriptor. It provides a "description" of a given given view so that the view can later be constructed.

The view registry provides facilities to map from an extension to a IViewDescriptor.

This interface is not intended to be implemented by clients.

See also

org.blueberry.ui.IViewRegistry

Definition at line 42 of file berryIViewDescriptor.h.

Constructor & Destructor Documentation

~IViewDescriptor()

berry::IViewDescriptor::~IViewDescriptor ( )

override

Member Function Documentation

berryObjectMacro()

berry::IViewDescriptor::berryObjectMacro

(

berry::IViewDescriptor

)

CreateView()

virtual IViewPart::Pointer berry::IViewDescriptor::CreateView ( )

pure virtual

Creates an instance of the view defined in the descriptor.

Returns

the view part

Exceptions

CoreException

thrown if there is a problem creating the part

GetAllowMultiple()

virtual bool berry::IViewDescriptor::GetAllowMultiple ( ) const

pure virtual

Returns whether this view allows multiple instances.

Returns

whether this view allows multiple instances

GetCategoryPath()

virtual QStringList berry::IViewDescriptor::GetCategoryPath ( ) const

pure virtual

Returns an array of strings that represent view's category path. This array will be used for hierarchical presentation of the view in places like submenus.

Returns

array of category tokens or null if not specified.

GetDescription()

virtual QString berry::IViewDescriptor::GetDescription ( ) const

pure virtual

Returns the description of this view.

Returns

the description

GetImageDescriptor()

QIcon berry::IViewDescriptor::GetImageDescriptor ( ) const

overridepure virtual

Returns the descriptor for the icon to show for this view.

Implements berry::IWorkbenchPartDescriptor.

GetKeywordReferences()

virtual QStringList berry::IViewDescriptor::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 view.

Returns

A list of ids for keyword reference extensions.

IsInternal()

virtual bool berry::IViewDescriptor::IsInternal ( ) const

pure virtual

Return whether this view should be considered internal, e.g., excluded from view enumerations in the UI.

Returns

whether this view is internal

IsRestorable()

virtual bool berry::IViewDescriptor::IsRestorable ( ) const

pure virtual

Returns whether this view can be restored upon workbench restart.

Returns

whether this view can be restored upon workbench restart

operator==()

bool berry::IViewDescriptor::operator== ( const Object *  ) const

overridepure virtual

A generic comparison method. Override this method in subclasses and cast to your derived class to provide a more detailed comparison.

Reimplemented from berry::Object.

---

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

• berryIViewDescriptor.h