Medical Imaging Interaction Toolkit  2018.04.99-3ec0dd08
Medical Imaging Interaction Toolkit
berry::IHandlerActivation Struct Referenceabstract

#include <berryIHandlerActivation.h>

Inheritance diagram for berry::IHandlerActivation:
Collaboration diagram for berry::IHandlerActivation:

Public Member Functions

 berryObjectMacro (berry::IHandlerActivation)
 ~IHandlerActivation () override
virtual void ClearActive ()=0
virtual QString GetCommandId () const =0
virtual int GetDepth () const =0
virtual SmartPointer< IHandlerGetHandler () const =0
virtual IHandlerServiceGetHandlerService () const =0

Static Public Attributes

static const int ROOT_DEPTH

Detailed Description

A token representing the activation of a handler. This token can later be used to cancel that activation. Without this token, then handler will only become inactive if the component in which the handler was activated is destroyed.

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

See also

Definition at line 40 of file berryIHandlerActivation.h.

Constructor & Destructor Documentation

◆ ~IHandlerActivation()

berry::IHandlerActivation::~IHandlerActivation ( )

Member Function Documentation

◆ berryObjectMacro()

berry::IHandlerActivation::berryObjectMacro ( berry::IHandlerActivation  )

◆ ClearActive()

virtual void berry::IHandlerActivation::ClearActive ( )
pure virtual

Clears the cached computation of the isActive method, if any. This method is only intended for internal use. It provides a mechanism by which ISourceProvider events can invalidate state on a IHandlerActivation instance.

Use berry::IEvaluationResultCache::clearResult() instead.

◆ GetCommandId()

virtual QString berry::IHandlerActivation::GetCommandId ( ) const
pure virtual

Returns the identifier of the command whose handler is being activated.

The command identifier; never null.

◆ GetDepth()

virtual int berry::IHandlerActivation::GetDepth ( ) const
pure virtual

Returns the depth at which this activation was created within the services hierarchy. The root of the hierarchy is at a depth of 1. This is used as the final tie-breaker in the event that no other method can be used to determine a winner.

The depth at which the handler was inserted into the services hierarchy; should be a positive integer.

◆ GetHandler()

virtual SmartPointer<IHandler> berry::IHandlerActivation::GetHandler ( ) const
pure virtual

Returns the handler that should be activated.

The handler; may be null.

◆ GetHandlerService()

virtual IHandlerService* berry::IHandlerActivation::GetHandlerService ( ) const
pure virtual

Returns the handler service from which this activation was requested. This is used to ensure that an activation can only be retracted from the same service which issued it.

The handler service; never null.

Member Data Documentation


const int berry::IHandlerActivation::ROOT_DEPTH

The depth at which the root exists.

Definition at line 50 of file berryIHandlerActivation.h.

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