Manage connections between VTK events and Qt slots. More...

#include <vtkEventQtSlotConnect.h>

Inheritance diagram for vtkEventQtSlotConnect:

Collaboration diagram for vtkEventQtSlotConnect:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkEventQtSlotConnect *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	GetNumberOfConnections () const


virtual void	Connect (vtkObject vtk_obj, unsigned long event, const QObject qt_obj, const char slot, void client_data=NULL, float priority=0.0, Qt::ConnectionType type=Qt::AutoConnection)


virtual void	Disconnect (vtkObject vtk_obj=NULL, unsigned long event=vtkCommand::NoEvent, const QObject qt_obj=NULL, const char slot=0, void client_data=NULL)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkEventQtSlotConnect *	New ()

static int	IsTypeOf (const char *type)

static vtkEventQtSlotConnect *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

void	RemoveConnection (vtkQtConnection *)

	vtkEventQtSlotConnect ()

	~vtkEventQtSlotConnect ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkQtConnections *	Connections

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkQtConnection

Detailed Description

Manage connections between VTK events and Qt slots.

vtkEventQtSlotConnect provides a way to manage connections between VTK events and Qt slots. Qt slots to connect with must have one of the following signatures:

MySlot()
MySlot(vtkObject* caller)
MySlot(vtkObject* caller, unsigned long vtk_event)
MySlot(vtkObject* caller, unsigned long vtk_event, void* client_data)
MySlot(vtkObject* caller, unsigned long vtk_event, void* client_data, void* call_data)
MySlot(vtkObject* caller, unsigned long vtk_event, void* client_data, void* call_data, vtkCommand*)

Examples:
vtkEventQtSlotConnect (Examples)

Tests:
vtkEventQtSlotConnect (Tests)

Definition at line 61 of file vtkEventQtSlotConnect.h.

Member Typedef Documentation

typedef vtkObject vtkEventQtSlotConnect::Superclass

Definition at line 65 of file vtkEventQtSlotConnect.h.

Constructor & Destructor Documentation

vtkEventQtSlotConnect::vtkEventQtSlotConnect ( )

protected

vtkEventQtSlotConnect::~vtkEventQtSlotConnect ( )

protected

Member Function Documentation

static vtkEventQtSlotConnect* vtkEventQtSlotConnect::New ( )

static

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

static

virtual int vtkEventQtSlotConnect::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 vtkObject.

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

static

virtual vtkObjectBase* vtkEventQtSlotConnect::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkEventQtSlotConnect* vtkEventQtSlotConnect::NewInstance ( ) const

void vtkEventQtSlotConnect::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Print the current connections between VTK and Qt

Reimplemented from vtkObject.

virtual void vtkEventQtSlotConnect::Connect	(	vtkObject *	vtk_obj,
		unsigned long	event,
		const QObject *	qt_obj,
		const char *	slot,
		void *	client_data = `NULL`,
		float	priority = `0.0`,
		Qt::ConnectionType	type = `Qt::AutoConnection`
	)

virtual

Connect a vtk object's event with a Qt object's slot. Multiple connections which are identical are treated as separate connections.

virtual void vtkEventQtSlotConnect::Disconnect	(	vtkObject *	vtk_obj = `NULL`,
		unsigned long	event = `vtkCommand::NoEvent`,
		const QObject *	qt_obj = `NULL`,
		const char *	slot = `0`,
		void *	client_data = `NULL`
	)

virtual

Disconnect a vtk object from a qt object. Passing no arguments will disconnect all slots maintained by this object. Passing in only a vtk object will disconnect all slots from it. Passing only a vtk object and event, will disconnect all slots matching the vtk object and event. Passing all information in will match all information.

virtual int vtkEventQtSlotConnect::GetNumberOfConnections ( ) const

virtual

Allow to query vtkEventQtSlotConnect to know if some Connect() have been setup and how many.

void vtkEventQtSlotConnect::RemoveConnection ( vtkQtConnection * )

protected

Friends And Related Function Documentation

friend class vtkQtConnection

friend

Definition at line 97 of file vtkEventQtSlotConnect.h.

Member Data Documentation

vtkQtConnections* vtkEventQtSlotConnect::Connections

protected

Definition at line 96 of file vtkEventQtSlotConnect.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/GUISupport/Qt/vtkEventQtSlotConnect.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation