Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
berry::CommandEvent Class Reference

#include <berryCommandEvent.h>

Inheritance diagram for berry::CommandEvent:
Collaboration diagram for berry::CommandEvent:

Public Member Functions

 berryObjectMacro (CommandEvent)
 
 CommandEvent (const SmartPointer< Command > command, bool categoryChanged, bool definedChanged, bool descriptionChanged, bool handledChanged, bool nameChanged, bool parametersChanged, bool returnTypeChanged=false, bool helpContextIdChanged=false, bool enabledChanged=false)
 
SmartPointer< CommandGetCommand () const
 
bool IsCategoryChanged () const
 
bool IsHandledChanged () const
 
bool IsHelpContextIdChanged () const
 
bool IsParametersChanged () const
 
bool IsReturnTypeChanged () const
 
bool IsEnabledChanged () const
 
- Public Member Functions inherited from berry::AbstractNamedHandleEvent
 berryObjectMacro (AbstractNamedHandleEvent)
 
bool IsDescriptionChanged () const
 
bool IsNameChanged () const
 
- Public Member Functions inherited from berry::AbstractHandleObjectEvent
 berryObjectMacro (AbstractHandleObjectEvent)
 
bool IsDefinedChanged () const
 
- Public Member Functions inherited from berry::AbstractBitSetEvent
 berryObjectMacro (AbstractBitSetEvent)
 
- 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::AbstractNamedHandleEvent
 AbstractNamedHandleEvent (bool definedChanged, bool descriptionChanged, bool nameChanged)
 
- Protected Member Functions inherited from berry::AbstractHandleObjectEvent
 AbstractHandleObjectEvent (bool definedChanged)
 
- Protected Member Functions inherited from berry::AbstractBitSetEvent
 AbstractBitSetEvent ()
 
- 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
 
- Static Protected Member Functions inherited from berry::AbstractNamedHandleEvent
static int CHANGED_DESCRIPTION ()
 
static int CHANGED_NAME ()
 
static int LAST_USED_BIT ()
 
- Static Protected Member Functions inherited from berry::AbstractHandleObjectEvent
static int CHANGED_DEFINED ()
 
static int LAST_BIT_USED_ABSTRACT_HANDLE ()
 
- Protected Attributes inherited from berry::AbstractBitSetEvent
int changedValues
 
- Protected Attributes inherited from berry::Object
QAtomicInt m_ReferenceCount
 
QMutex m_ReferenceCountLock
 

Detailed Description

An instance of this class describes changes to an instance of Command.

This class is not intended to be extended by clients.

See also
ICommandListener::CommandChanged(CommandEvent::Pointer)

Definition at line 34 of file berryCommandEvent.h.

Constructor & Destructor Documentation

◆ CommandEvent()

berry::CommandEvent::CommandEvent ( const SmartPointer< Command command,
bool  categoryChanged,
bool  definedChanged,
bool  descriptionChanged,
bool  handledChanged,
bool  nameChanged,
bool  parametersChanged,
bool  returnTypeChanged = false,
bool  helpContextIdChanged = false,
bool  enabledChanged = false 
)

Creates a new instance of this class.

Parameters
commandthe instance of the interface that changed.
categoryChangedtrue, iff the category property changed.
definedChangedtrue, iff the defined property changed.
descriptionChangedtrue, iff the description property changed.
handledChangedtrue, iff the handled property changed.
nameChangedtrue, iff the name property changed.
parametersChangedtrue if the parameters have changed; false otherwise.
returnTypeChangedtrue iff the return type property changed; false otherwise.
helpContextIdChangedtrue iff the help context identifier changed; false otherwise.
enabledChangedtrue iff the comand enablement changed; false otherwise.
Since
3.3

Member Function Documentation

◆ berryObjectMacro()

berry::CommandEvent::berryObjectMacro ( CommandEvent  )

◆ GetCommand()

SmartPointer<Command> berry::CommandEvent::GetCommand ( ) const

Returns the instance of the interface that changed.

Returns
the instance of the interface that changed. Guaranteed not to be null.

◆ IsCategoryChanged()

bool berry::CommandEvent::IsCategoryChanged ( ) const

Returns whether or not the category property changed.

Returns
true, iff the category property changed.

◆ IsEnabledChanged()

bool berry::CommandEvent::IsEnabledChanged ( ) const

Return whether the enable property changed.

Returns
true iff the comand enablement changed
Since
3.3

◆ IsHandledChanged()

bool berry::CommandEvent::IsHandledChanged ( ) const

Returns whether or not the handled property changed.

Returns
true, iff the handled property changed.

◆ IsHelpContextIdChanged()

bool berry::CommandEvent::IsHelpContextIdChanged ( ) const

Returns whether or not the help context identifier changed.

Returns
true, iff the help context identifier changed.
Since
3.2

◆ IsParametersChanged()

bool berry::CommandEvent::IsParametersChanged ( ) const

Returns whether or not the parameters have changed.

Returns
true, iff the parameters property changed.

◆ IsReturnTypeChanged()

bool berry::CommandEvent::IsReturnTypeChanged ( ) const

Returns whether or not the return type property changed.

Returns
true, iff the return type property changed.
Since
3.2

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