Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
berry::IEditorDescriptor Struct Referenceabstract

#include <berryIEditorDescriptor.h>

Inheritance diagram for berry::IEditorDescriptor:
Collaboration diagram for berry::IEditorDescriptor:

Public Member Functions

 berryObjectMacro (berry::IEditorDescriptor)
 
 ~IEditorDescriptor () override
 
QString GetId () const override=0
 
QString GetLabel () const override=0
 
virtual bool IsInternal () const =0
 
virtual bool IsOpenInPlace () const =0
 
virtual bool IsOpenExternal () const =0
 
virtual IEditorMatchingStrategy::Pointer GetEditorMatchingStrategy ()=0
 
- Public Member Functions inherited from berry::IWorkbenchPartDescriptor
 berryObjectMacro (berry::IWorkbenchPartDescriptor)
 
virtual QIcon GetImageDescriptor () const =0
 
 ~IWorkbenchPartDescriptor () override
 
- 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

Description of an editor in the workbench editor registry. The editor descriptor contains the information needed to create editor instances.

An editor descriptor typically represents one of three types of editors:

  • a file editor extension for a specific file extension.
  • a file editor added by the user (via the workbench preference page)
  • a general editor extension which works on objects other than files.

This interface is not intended to be implemented or extended by clients.

See also
IEditorRegistry

Definition at line 42 of file berryIEditorDescriptor.h.

Constructor & Destructor Documentation

◆ ~IEditorDescriptor()

berry::IEditorDescriptor::~IEditorDescriptor ( )
override

Member Function Documentation

◆ berryObjectMacro()

berry::IEditorDescriptor::berryObjectMacro ( berry::IEditorDescriptor  )

◆ GetEditorMatchingStrategy()

virtual IEditorMatchingStrategy::Pointer berry::IEditorDescriptor::GetEditorMatchingStrategy ( )
pure virtual

Returns the editor matching strategy object for editors represented by this editor descriptor, or null if there is no explicit matching strategy specified.

Returns
the editor matching strategy, or null if none
Since
3.1

◆ GetId()

QString berry::IEditorDescriptor::GetId ( ) const
overridepure virtual

Returns the editor id.

For internal editors, this is the extension id as defined in the workbench registry; for external editors, it is path and file name of the external program.

Returns
the id of the editor

Implements berry::IWorkbenchPartDescriptor.

◆ GetLabel()

QString berry::IEditorDescriptor::GetLabel ( ) const
overridepure virtual

Returns the descriptor of the image for this editor.

Returns
the descriptor of the image to display next to this editor Returns the label to show for this editor.
the editor label

Implements berry::IWorkbenchPartDescriptor.

◆ IsInternal()

virtual bool berry::IEditorDescriptor::IsInternal ( ) const
pure virtual

Returns whether this editor descriptor will open a regular editor part inside the editor area.

Returns
true if editor is inside editor area, and false otherwise
Since
3.0

◆ IsOpenExternal()

virtual bool berry::IEditorDescriptor::IsOpenExternal ( ) const
pure virtual

Returns whether this editor descriptor will open an external editor in a new window outside the workbench.

Returns
true if editor is external, and false otherwise
Since
3.0

◆ IsOpenInPlace()

virtual bool berry::IEditorDescriptor::IsOpenInPlace ( ) const
pure virtual

Returns whether this editor descriptor will open an external editor in-place inside the editor area.

Returns
true if editor is in-place, and false otherwise
Since
3.0

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