vtkEventForwarderCommand Class Reference

a simple event forwarder command More...

#include <vtkEventForwarderCommand.h>

Inheritance diagram for vtkEventForwarderCommand:

Collaboration diagram for vtkEventForwarderCommand:

Public Types
typedef vtkCommand	Superclass
Public Types inherited from vtkCommand
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkEventForwarderCommand *	NewInstance () const
void	Execute (vtkObject *caller, unsigned long eid, void *callData)
virtual void	SetTarget (vtkObject *obj)
virtual void *	GetTarget ()
Public Member Functions inherited from vtkCommand
vtkCommand *	NewInstance () const
void	UnRegister ()
virtual void	UnRegister (vtkObjectBase *)
void	SetAbortFlag (int f)
int	GetAbortFlag ()
void	AbortFlagOn ()
void	AbortFlagOff ()
void	SetPassiveObserver (int f)
int	GetPassiveObserver ()
void	PassiveObserverOn ()
void	PassiveObserverOff ()
	vtkCommand ()
virtual	~vtkCommand ()
	vtkCommand (const vtkCommand &c)
void	operator= (const vtkCommand &)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkEventForwarderCommand *	SafeDownCast (vtkObjectBase *o)
static vtkEventForwarderCommand *	New ()
Static Public Member Functions inherited from vtkCommand
static int	IsTypeOf (const char *type)
static vtkCommand *	SafeDownCast (vtkObjectBase *o)
static const char *	GetStringFromEventId (unsigned long event)
static unsigned long	GetEventIdFromString (const char *event)
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkEventForwarderCommand ()
	~vtkEventForwarderCommand ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkObject *	Target
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkCommand
vtkEventDeclarationMacro(EventIds) protected int	PassiveObserver

Detailed Description

a simple event forwarder command

Use vtkEventForwarderCommand to forward an event to a new object. This command will intercept the event, and use InvokeEvent on a 'target' as if that object was the one that invoked the event instead of the object this commmand was attached to using AddObserver.

See also

vtkCommand

Definition at line 33 of file vtkEventForwarderCommand.h.

Member Typedef Documentation

typedef vtkCommand vtkEventForwarderCommand::Superclass

Definition at line 36 of file vtkEventForwarderCommand.h.

Constructor & Destructor Documentation

vtkEventForwarderCommand::vtkEventForwarderCommand ( )

protected

vtkEventForwarderCommand::~vtkEventForwarderCommand ( )

inlineprotected

Definition at line 61 of file vtkEventForwarderCommand.h.

Member Function Documentation

static int vtkEventForwarderCommand::IsTypeOf ( const char *  type )

static

virtual int vtkEventForwarderCommand::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCommand.

static vtkEventForwarderCommand* vtkEventForwarderCommand::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkEventForwarderCommand::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCommand.

vtkEventForwarderCommand* vtkEventForwarderCommand::NewInstance

(

)

const

static vtkEventForwarderCommand* vtkEventForwarderCommand::New ( )

inlinestatic

Definition at line 38 of file vtkEventForwarderCommand.h.

void vtkEventForwarderCommand::Execute ( vtkObject *  caller, unsigned long  eid, void *  callData  )

virtual

Satisfy the superclass API for callbacks. Recall that the caller is the instance invoking the event; eid is the event id (see vtkCommand.h); and calldata is information sent when the callback was invoked (e.g., progress value in the vtkCommand::ProgressEvent).

Implements vtkCommand.

virtual void vtkEventForwarderCommand::SetTarget ( vtkObject *  obj )

inlinevirtual

Methods to set and get client and callback information, and the callback function.

Definition at line 50 of file vtkEventForwarderCommand.h.

virtual void* vtkEventForwarderCommand::GetTarget ( )

inlinevirtual

Methods to set and get client and callback information, and the callback function.

Definition at line 52 of file vtkEventForwarderCommand.h.

Member Data Documentation

vtkObject* vtkEventForwarderCommand::Target

protected

Definition at line 58 of file vtkEventForwarderCommand.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkEventForwarderCommand.h