Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
berry::IEditorMatchingStrategy Struct Referenceabstract

#include <berryIEditorMatchingStrategy.h>

Inheritance diagram for berry::IEditorMatchingStrategy:
Collaboration diagram for berry::IEditorMatchingStrategy:

Public Member Functions

 berryObjectMacro (berry::IEditorMatchingStrategy)
 
 ~IEditorMatchingStrategy () override
 
virtual bool Matches (IEditorReference::Pointer editorRef, IEditorInput::Pointer input)=0
 
- 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

An editor matching strategy allows editor extensions to provide their own algorithm for matching the input of an open editor of that type to a given editor input. This is used to find a matching editor during IWorkbenchPage#OpenEditor and IWorkbenchPage#FindEditor.

Definition at line 32 of file berryIEditorMatchingStrategy.h.

Constructor & Destructor Documentation

◆ ~IEditorMatchingStrategy()

berry::IEditorMatchingStrategy::~IEditorMatchingStrategy ( )
override

Member Function Documentation

◆ berryObjectMacro()

berry::IEditorMatchingStrategy::berryObjectMacro ( berry::IEditorMatchingStrategy  )

◆ Matches()

virtual bool berry::IEditorMatchingStrategy::Matches ( IEditorReference::Pointer  editorRef,
IEditorInput::Pointer  input 
)
pure virtual

Returns whether the editor represented by the given editor reference matches the given editor input.

Implementations should inspect the given editor input first, and try to reject it early before calling IEditorReference.getEditorInput(), since that method may be expensive.

Parameters
editorRefthe editor reference to match against
inputthe editor input to match
Returns
true if the editor matches the given editor input, false if it does not match

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