mitk::TwoParameterToolEvent< T, U > Class Template Reference

Tool event with 1 parameter. More...

#include <mitkToolEvents.h>

List of all members.

Public Types
typedef TwoParameterToolEvent	Self
typedef ToolEvent	Superclass
Public Member Functions
	TwoParameterToolEvent (const T parameter1, const U parameter2)
	TwoParameterToolEvent (const Self &s)
virtual	~TwoParameterToolEvent ()
virtual const char *	GetEventName () const
virtual bool	CheckEvent (const ::itk::EventObject *e) const
virtual ::itk::EventObject *	MakeObject () const
const T	GetParameter1 () const
const T	GetParameter2 () const
Protected Attributes
const T	m_Parameter1
const U	m_Parameter2

---

Detailed Description

template<typename T, typename U>
class mitk::TwoParameterToolEvent< T, U >

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( BarToolEvent(32, false) );
  }
};

}

Definition at line 167 of file mitkToolEvents.h.

---

Member Typedef Documentation

template<typename T , typename U >

typedef TwoParameterToolEvent mitk::TwoParameterToolEvent< T, U >::Self

Definition at line 171 of file mitkToolEvents.h.

template<typename T , typename U >

typedef ToolEvent mitk::TwoParameterToolEvent< T, U >::Superclass

Definition at line 172 of file mitkToolEvents.h.

---

Constructor & Destructor Documentation

template<typename T , typename U >

mitk::TwoParameterToolEvent< T, U >::TwoParameterToolEvent	(	const T	parameter1,
		const U	parameter2
	)		[inline]

Definition at line 174 of file mitkToolEvents.h.

    : m_Parameter1(parameter1),
      m_Parameter2(parameter2)
    {
    } 

template<typename T , typename U >

mitk::TwoParameterToolEvent< T, U >::TwoParameterToolEvent

(

const Self &

s )

[inline]

Definition at line 180 of file mitkToolEvents.h.

    : ToolEvent(s), 
      m_Parameter1(s.m_Parameter1),
      m_Parameter2(s.m_Parameter2) 
    {
    } 

template<typename T , typename U >

virtual mitk::TwoParameterToolEvent< T, U >::~TwoParameterToolEvent

(

)

[inline, virtual]

Definition at line 187 of file mitkToolEvents.h.

    {
    } 

---

Member Function Documentation

template<typename T , typename U >

virtual bool mitk::TwoParameterToolEvent< T, U >::CheckEvent

(

const ::itk::EventObject *

e )

const [inline, virtual]

Definition at line 196 of file mitkToolEvents.h.

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

template<typename T , typename U >

virtual const char* mitk::TwoParameterToolEvent< T, U >::GetEventName

(

)

const [inline, virtual]

Definition at line 191 of file mitkToolEvents.h.

    { 
      return "TwoParameterToolEvent"; 
    } 

template<typename T , typename U >

const T mitk::TwoParameterToolEvent< T, U >::GetParameter1

(

)

const [inline]

Definition at line 206 of file mitkToolEvents.h.

References mitk::TwoParameterToolEvent< T, U >::m_Parameter1.

    { 
      return m_Parameter1; 
    }

template<typename T , typename U >

const T mitk::TwoParameterToolEvent< T, U >::GetParameter2

(

)

const [inline]

Definition at line 211 of file mitkToolEvents.h.

References mitk::TwoParameterToolEvent< T, U >::m_Parameter2.

    { 
      return m_Parameter2; 
    }

template<typename T , typename U >

virtual ::itk::EventObject* mitk::TwoParameterToolEvent< T, U >::MakeObject

(

)

const [inline]

Definition at line 201 of file mitkToolEvents.h.

References mitk::TwoParameterToolEvent< T, U >::m_Parameter1, and mitk::TwoParameterToolEvent< T, U >::m_Parameter2.

    { 
      return new Self( m_Parameter1, m_Parameter2 ); 
    } 

---

Member Data Documentation

template<typename T , typename U >

const T mitk::TwoParameterToolEvent< T, U >::m_Parameter1 [protected]

Definition at line 218 of file mitkToolEvents.h.

Referenced by mitk::TwoParameterToolEvent< T, U >::GetParameter1(), and mitk::TwoParameterToolEvent< T, U >::MakeObject().

template<typename T , typename U >

const U mitk::TwoParameterToolEvent< T, U >::m_Parameter2 [protected]

Definition at line 219 of file mitkToolEvents.h.

Referenced by mitk::TwoParameterToolEvent< T, U >::GetParameter2(), and mitk::TwoParameterToolEvent< T, U >::MakeObject().

---

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

• mitkToolEvents.h