mitk::ParameterToolEvent< T > Class Template Reference

Tool event with 1 parameter. More...

#include <mitkToolEvents.h>

Inheritance diagram for mitk::ParameterToolEvent< T >:

Collaboration diagram for mitk::ParameterToolEvent< T >:

Public Types
typedef ParameterToolEvent	Self
typedef ToolEvent	Superclass

Public Member Functions
	ParameterToolEvent (const T parameter)
	ParameterToolEvent (const Self &s)
	~ParameterToolEvent () override
const char *	GetEventName () const override
bool	CheckEvent (const ::itk::EventObject *e) const override
::itk::EventObject *	MakeObject () const override
const T	GetParameter () const

Protected Attributes
const T	m_Parameter

Detailed Description

template<typename T>
class mitk::ParameterToolEvent< T >

Tool event with 1 parameter.

Can store one parameter for use within an observer. To derive your own special events, use the mitkToolEventMacro1Param macro.

namespace mitk
{
 
class MyTool : public Tool
{
  public:
 
    mitkToolEventMacro1Param(FooToolEvent, int);
 
  [...]
 
  protected:
 
  // Invoke your event like this
  void YourExampleMethod()
  {
    InvokeEvent( FooToolEvent(32) );
  }
};
 
}

Definition at line 84 of file mitkToolEvents.h.

Member Typedef Documentation

Self

template<typename T >

typedef ParameterToolEvent mitk::ParameterToolEvent< T >::Self

Definition at line 87 of file mitkToolEvents.h.

Superclass

template<typename T >

typedef ToolEvent mitk::ParameterToolEvent< T >::Superclass

Definition at line 88 of file mitkToolEvents.h.

Constructor & Destructor Documentation

ParameterToolEvent() [1/2]

template<typename T >

mitk::ParameterToolEvent< T >::ParameterToolEvent ( const T  parameter )

inline

Definition at line 90 of file mitkToolEvents.h.

ParameterToolEvent() [2/2]

template<typename T >

mitk::ParameterToolEvent< T >::ParameterToolEvent ( const Self &  s )

inline

Definition at line 91 of file mitkToolEvents.h.

~ParameterToolEvent()

template<typename T >

mitk::ParameterToolEvent< T >::~ParameterToolEvent ( )

inlineoverride

Definition at line 92 of file mitkToolEvents.h.

Member Function Documentation

CheckEvent()

template<typename T >

bool mitk::ParameterToolEvent< T >::CheckEvent ( const ::itk::EventObject *  e ) const

inlineoverride

Definition at line 94 of file mitkToolEvents.h.

GetEventName()

template<typename T >

const char* mitk::ParameterToolEvent< T >::GetEventName ( ) const

inlineoverride

Definition at line 93 of file mitkToolEvents.h.

GetParameter()

template<typename T >

const T mitk::ParameterToolEvent< T >::GetParameter ( ) const

inline

Definition at line 96 of file mitkToolEvents.h.

References mitk::ParameterToolEvent< T >::m_Parameter.

MakeObject()

template<typename T >

::itk::EventObject* mitk::ParameterToolEvent< T >::MakeObject ( ) const

inlineoverride

Definition at line 95 of file mitkToolEvents.h.

References mitk::ParameterToolEvent< T >::m_Parameter.

Member Data Documentation

m_Parameter

template<typename T >

const T mitk::ParameterToolEvent< T >::m_Parameter

protected

Definition at line 98 of file mitkToolEvents.h.

Referenced by mitk::ParameterToolEvent< T >::GetParameter(), and mitk::ParameterToolEvent< T >::MakeObject().

---

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

• mitkToolEvents.h