mitk::ParameterToolEvent< T > Class Template Reference

Tool event with 1 parameter. More...

#include <mitkToolEvents.h>

List of all members.

Public Types
typedef ParameterToolEvent	Self
typedef ToolEvent	Superclass
Public Member Functions
	ParameterToolEvent (const T parameter)
	ParameterToolEvent (const Self &s)
virtual	~ParameterToolEvent ()
virtual const char *	GetEventName () const
virtual bool	CheckEvent (const ::itk::EventObject *e) const
virtual ::itk::EventObject *	MakeObject () const
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 85 of file mitkToolEvents.h.

---

Member Typedef Documentation

template<typename T >

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

Definition at line 89 of file mitkToolEvents.h.

template<typename T >

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

Definition at line 90 of file mitkToolEvents.h.

---

Constructor & Destructor Documentation

template<typename T >

mitk::ParameterToolEvent< T >::ParameterToolEvent

(

const T

parameter )

[inline]

Definition at line 92 of file mitkToolEvents.h.

    : m_Parameter(parameter)
    {
    } 

template<typename T >

mitk::ParameterToolEvent< T >::ParameterToolEvent

(

const Self &

s )

[inline]

Definition at line 97 of file mitkToolEvents.h.

    : ToolEvent(s), 
      m_Parameter(s.m_Parameter) 
    {
    } 

template<typename T >

virtual mitk::ParameterToolEvent< T >::~ParameterToolEvent

(

)

[inline, virtual]

Definition at line 103 of file mitkToolEvents.h.

    {
    } 

---

Member Function Documentation

template<typename T >

virtual bool mitk::ParameterToolEvent< T >::CheckEvent

(

const ::itk::EventObject *

e )

const [inline, virtual]

Definition at line 112 of file mitkToolEvents.h.

    { 
      return dynamic_cast<const Self*>(e); 
    } 

template<typename T >

virtual const char* mitk::ParameterToolEvent< T >::GetEventName

(

)

const [inline, virtual]

Definition at line 107 of file mitkToolEvents.h.

    { 
      return "ParameterToolEvent"; 
    } 

template<typename T >

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

(

)

const [inline]

Definition at line 122 of file mitkToolEvents.h.

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

    { 
      return m_Parameter; 
    }

template<typename T >

virtual ::itk::EventObject* mitk::ParameterToolEvent< T >::MakeObject

(

)

const [inline]

Definition at line 117 of file mitkToolEvents.h.

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

    { 
      return new Self( m_Parameter ); 
    } 

---

Member Data Documentation

template<typename T >

const T mitk::ParameterToolEvent< T >::m_Parameter [protected]

Definition at line 129 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