Medical Imaging Interaction Toolkit  2018.4.99-b7f3afaa
Medical Imaging Interaction Toolkit
berry::FileEditorInput Class Reference

#include <berryFileEditorInput.h>

Inheritance diagram for berry::FileEditorInput:
Collaboration diagram for berry::FileEditorInput:

Public Member Functions

 berryObjectMacro (FileEditorInput)
 
 FileEditorInput (const QString &path)
 
QString GetPath () const override
 
bool Exists () const override
 
QString GetName () const override
 
QString GetToolTipText () const override
 
QIcon GetIcon () const override
 
const IPersistableElementGetPersistable () const override
 
ObjectGetAdapter (const QString &adapterType) const override
 
bool operator== (const Object *o) const override
 
- Public Member Functions inherited from berry::IPathEditorInput
 berryObjectMacro (berry::IPathEditorInput)
 
 ~IPathEditorInput () override
 
- Public Member Functions inherited from berry::IEditorInput
 berryObjectMacro (berry::IEditorInput)
 
 ~IEditorInput () 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
 
- Public Member Functions inherited from berry::IAdaptable
template<class A >
A * GetAdapter ()
 
virtual ~IAdaptable ()
 

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

Definition at line 25 of file berryFileEditorInput.h.

Constructor & Destructor Documentation

◆ FileEditorInput()

berry::FileEditorInput::FileEditorInput ( const QString &  path)

Definition at line 19 of file berryFileEditorInput.cpp.

Member Function Documentation

◆ berryObjectMacro()

berry::FileEditorInput::berryObjectMacro ( FileEditorInput  )

◆ Exists()

bool berry::FileEditorInput::Exists ( ) const
overridevirtual

Returns whether the editor input exists.

This method is primarily used to determine if an editor input should appear in the "File Most Recently Used" menu. An editor input will appear in the list until the return value of exists becomes false or it drops off the bottom of the list.

Returns
true if the editor input exists; false otherwise

Implements berry::IEditorInput.

Definition at line 30 of file berryFileEditorInput.cpp.

◆ GetAdapter()

Object * berry::FileEditorInput::GetAdapter ( const QString &  adapterType) const
overridevirtual

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Parameters
adapterTypethe adapter class to look up
Returns
a object castable to the given class, or null if this object does not have an adapter for the given class

Implements berry::IAdaptable.

Definition at line 55 of file berryFileEditorInput.cpp.

◆ GetIcon()

QIcon berry::FileEditorInput::GetIcon ( ) const
overridevirtual

Returns the icon for this input.

Returns
the icon for this input; may be null icon if there is no image.

Implements berry::IEditorInput.

Definition at line 45 of file berryFileEditorInput.cpp.

◆ GetName()

QString berry::FileEditorInput::GetName ( ) const
overridevirtual

Returns the name of this editor input for display purposes.

For instance, when the input is from a file, the return value would ordinarily be just the file name.

Returns
the name string; never null;

Implements berry::IEditorInput.

Definition at line 35 of file berryFileEditorInput.cpp.

◆ GetPath()

QString berry::FileEditorInput::GetPath ( ) const
overridevirtual

Returns the local file system path of the file underlying this editor input.

Returns
a local file system path

Implements berry::IPathEditorInput.

Definition at line 25 of file berryFileEditorInput.cpp.

Referenced by operator==().

◆ GetPersistable()

const IPersistableElement * berry::FileEditorInput::GetPersistable ( ) const
overridevirtual

Returns an object that can be used to save the state of this editor input.

Returns
the persistable element, or null if this editor input cannot be persisted

Implements berry::IEditorInput.

Definition at line 50 of file berryFileEditorInput.cpp.

◆ GetToolTipText()

QString berry::FileEditorInput::GetToolTipText ( ) const
overridevirtual

Returns the tool tip text for this editor input. This text is used to differentiate between two input with the same name. For instance, MyClass.java in folder X and MyClass.java in folder Y. The format of the text varies between input types.

Returns
the tool tip text; never null.

Implements berry::IEditorInput.

Definition at line 40 of file berryFileEditorInput.cpp.

◆ operator==()

bool berry::FileEditorInput::operator== ( const Object o) const
overridevirtual

Returns true if two editor inputs are the same

Implements berry::IEditorInput.

Definition at line 60 of file berryFileEditorInput.cpp.

References GetPath().


The documentation for this class was generated from the following files: