berry::IFileEditorMapping Struct Reference

#include <berryIFileEditorMapping.h>

Inheritance diagram for berry::IFileEditorMapping:

Collaboration diagram for berry::IFileEditorMapping:

Public Member Functions
	berryObjectMacro (berry::IFileEditorMapping)
	~IFileEditorMapping () override
virtual IEditorDescriptor::Pointer	GetDefaultEditor ()=0
virtual QList< IEditorDescriptor::Pointer >	GetEditors () const =0
virtual QList< IEditorDescriptor::Pointer >	GetDeletedEditors () const =0
virtual QString	GetExtension () const =0
virtual QString	GetLabel () const =0
virtual QString	GetName () 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

An association between a file name/extension and a list of known editors for files of that type.

The name and extension can never empty or null. The name may contain the single wild card character (*) to indicate the editor applies to all files with the same extension (e.g. *.doc). The name can never embed the wild card character within itself (i.e. rep*)

This interface is not intended to be implemented by clients.

See also

IEditorRegistry::GetFileEditorMappings

Definition at line 40 of file berryIFileEditorMapping.h.

Constructor & Destructor Documentation

~IFileEditorMapping()

berry::IFileEditorMapping::~IFileEditorMapping ( )

override

Member Function Documentation

berryObjectMacro()

berry::IFileEditorMapping::berryObjectMacro

(

berry::IFileEditorMapping

)

GetDefaultEditor()

virtual IEditorDescriptor::Pointer berry::IFileEditorMapping::GetDefaultEditor ( )

pure virtual

Returns the default editor registered for this type mapping.

Returns

the descriptor of the default editor, or null if there is no default editor registered. Will also return null if the default editor exists but fails the Expressions check.

GetDeletedEditors()

virtual QList<IEditorDescriptor::Pointer> berry::IFileEditorMapping::GetDeletedEditors ( ) const

pure virtual

Returns the list of editors formerly registered for this type mapping which have since been deleted.

Returns

a possibly empty list of editors

GetEditors()

virtual QList<IEditorDescriptor::Pointer> berry::IFileEditorMapping::GetEditors ( ) const

pure virtual

Returns the list of editors registered for this type mapping.

Returns

a possibly empty list of editors.

GetExtension()

virtual QString berry::IFileEditorMapping::GetExtension ( ) const

pure virtual

Returns the file's extension for this type mapping.

Returns

the extension for this mapping

GetLabel()

virtual QString berry::IFileEditorMapping::GetLabel ( ) const

pure virtual

Returns the descriptor of the image to use for a file of this type.

The image is obtained from the default editor. A default file image is returned if no default editor is available.

Returns

the descriptor of the image to use for a resource of this type Returns the label to use for this mapping. Labels have the form "<it>name</it>.<it>extension</it>".

the label to use for this mapping

GetName()

virtual QString berry::IFileEditorMapping::GetName ( ) const

pure virtual

Returns the file's name for this type mapping.

Returns

the name for this mapping

---

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

• berryIFileEditorMapping.h