berry::IEditorReference Struct Reference

#include <berryIEditorReference.h>

Inheritance diagram for berry::IEditorReference:

Collaboration diagram for berry::IEditorReference:

Public Member Functions
	berryObjectMacro (berry::IEditorReference)
	~IEditorReference () override
virtual QString	GetFactoryId ()=0
virtual QString	GetName ()=0
virtual IEditorPart::Pointer	GetEditor (bool restore)=0
virtual IEditorInput::Pointer	GetEditorInput ()=0
Public Member Functions inherited from berry::IWorkbenchPartReference
	berryObjectMacro (berry::IWorkbenchPartReference)
	~IWorkbenchPartReference () override
virtual SmartPointer< IWorkbenchPart >	GetPart (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< IWorkbenchPage >	GetPage () 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::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
virtual bool	operator== (const Object *) const

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

Implements a reference to a editor. The IEditorPart will not be instantiated until the editor becomes visible or the API getEditor is sent with true;

This interface is not intended to be implemented by clients.

Definition at line 33 of file berryIEditorReference.h.

Constructor & Destructor Documentation

~IEditorReference()

berry::IEditorReference::~IEditorReference ( )

override

Member Function Documentation

berryObjectMacro()

berry::IEditorReference::berryObjectMacro

(

berry::IEditorReference

)

GetEditor()

virtual IEditorPart::Pointer berry::IEditorReference::GetEditor ( bool  restore )

pure virtual

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

GetEditorInput()

virtual IEditorInput::Pointer berry::IEditorReference::GetEditorInput ( )

pure virtual

Returns the editor input for the editor referenced by this object.

Unlike most of the other methods on this type, this method can trigger plug-in activation.

Returns

the editor input for the editor referenced by this object

Exceptions

PartInitException

if there was an error restoring the editor input

Since

3.1

GetFactoryId()

virtual QString berry::IEditorReference::GetFactoryId ( )

pure virtual

Returns the factory id of the factory used to restore this editor. Returns null if the editor is not persistable.

GetName()

virtual QString berry::IEditorReference::GetName ( )

pure virtual

Returns the editor input name. May return null is the name is not available or if the editor failed to be restored.

---

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

• berryIEditorReference.h