qVTKConnection Class Reference

#include <qVTKConnection.h>

Inheritance diagram for qVTKConnection:
QObject QObject

List of all members.

Public Types

typedef QObject Superclass
typedef QObject Superclass

Public Slots

void deleteConnection ()

Signals

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

Public Member Functions

void Execute (vtkObject *vtk_obj, unsigned long vtk_event, void *client_data, void *call_data)
QString GetId () const
QString getShortDescription ()
int GetSlotType () const
QString id () const
bool isAboutToBeDeleted () const
bool isBlocked () const
bool isEnabled () const
bool isEqual (vtkObject *vtk_obj, unsigned long vtk_event, const QObject *qt_obj, QString qt_slot) const
bool IsEqual (vtkObject *vtk_obj, unsigned long vtk_event, const QObject *qt_obj, QString qt_slot)
virtual void printAdditionalInfo ()
virtual void printAdditionalInfo ()
 qVTKConnection (QObject *parent)
 qVTKConnection (qVTKObjectEventsObserver *parent)
void setBlocked (bool block)
void SetBlocked (bool block)
void setEnabled (bool enable)
void SetEstablished (bool enable)
void SetParameters (vtkObject *vtk_obj, unsigned long vtk_event, const QObject *qt_obj, QString qt_slot, float priority)
void SetParameters (vtkObject *vtk_obj, unsigned long vtk_event, const QObject *qt_obj, QString qt_slot, float priority)
QString shortDescription ()
virtual ~qVTKConnection ()

Static Public Member Functions

static void DoCallback (vtkObject *vtk_obj, unsigned long event, void *client_data, void *call_data)
static QString getShortDescription (vtkObject *vtk_obj, unsigned long vtk_event, const QObject *qt_obj, QString qt_slot="")
static QString shortDescription (vtkObject *vtk_obj, unsigned long vtk_event, const QObject *qt_obj, QString qt_slot="")
static bool ValidateParameters (vtkObject *vtk_obj, unsigned long vtk_event, const QObject *qt_obj, QString qt_slot)
static bool ValidateParameters (vtkObject *vtk_obj, unsigned long vtk_event, const QObject *qt_obj, QString qt_slot)

Protected Slots

void deleteConnection ()

Protected Member Functions

void BreakConnection ()
void EstablishConnection ()
virtual ~qVTKConnection ()

Private Member Functions

 QCTK_DECLARE_PRIVATE (qVTKConnection)
 QCTK_DECLARE_PRIVATE (qVTKConnection)

Member Typedef Documentation


Constructor & Destructor Documentation

qVTKConnection::qVTKConnection ( qVTKObjectEventsObserver parent  )  [explicit]
qVTKConnection::~qVTKConnection (  )  [inline, virtual]
qVTKConnection::qVTKConnection ( QObject parent  )  [explicit]

References QCTK_INIT_PRIVATE.

virtual qVTKConnection::~qVTKConnection (  )  [protected, virtual]

Member Function Documentation

void qVTKConnection::BreakConnection (  )  [protected]
void qVTKConnection::deleteConnection (  )  [slot]

Safe deletion

void qVTKConnection::deleteConnection (  )  [protected, slot]
void qVTKConnection::DoCallback ( vtkObject vtk_obj,
unsigned long  event,
void *  client_data,
void *  call_data 
) [static]

VTK Callback

References Execute().

Referenced by qVTKConnectionPrivate::qVTKConnectionPrivate().

void qVTKConnection::emitExecute ( vtkObject caller,
void *  call_data,
unsigned long  vtk_event,
void *  client_data 
) [signal]

Note: even if the signal has a signature with 4 args, you can connect it to a slot with less arguments as long as the types of the argument are matching: connect(obj1,SIGNAL(signalFunc(A,B,C,D)),obj2,SLOT(slotFunc(A)));

void qVTKConnection::emitExecute ( vtkObject caller,
vtkObject call_data 
) [signal]

The qt signal emited by the VTK Callback The signal corresponding to the slot will be emited

void qVTKConnection::emitExecute ( vtkObject caller,
void *  call_data,
unsigned long  vtk_event,
void *  client_data 
) [signal]

Note: even if the signal has a signature with 4 args, you can connect it to a slot with less arguments as long as the types of the argument are matching: connect(obj1,SIGNAL(signalFunc(A,B,C,D)),obj2,SLOT(slotFunc(A)));

void qVTKConnection::emitExecute ( vtkObject caller,
vtkObject call_data 
) [signal]

The qt signal emited by the VTK Callback The signal corresponding to the slot will be emited

Referenced by BreakConnection(), EstablishConnection(), and Execute().

void qVTKConnection::EstablishConnection (  )  [protected]
void qVTKConnection::Execute ( vtkObject vtk_obj,
unsigned long  vtk_event,
void *  client_data,
void *  call_data 
)
QString qVTKConnection::GetId (  )  const

Return a string uniquely identifying the connection within the current process

Referenced by qVTKObjectEventsObserver::addConnection(), and qVTKObjectEventsObserver::removeConnection().

QString qVTKConnection::getShortDescription ( vtkObject vtk_obj,
unsigned long  vtk_event,
const QObject qt_obj,
QString  qt_slot = "" 
) [static]
QString qVTKConnection::getShortDescription (  ) 
int qVTKConnection::GetSlotType (  )  const
QString qVTKConnection::id (  )  const

Return a string uniquely identifying the connection within the current process

Referenced by qVTKObjectEventsObserverPrivate::findConnection().

bool qVTKConnection::isAboutToBeDeleted (  )  const

The flag is set to true in Execute if the vtkObject emitted a DeleteEvent event. This tells that the object will delete itself at the end of Execute(). Knowing that information can be useful to prevent a multiple deletion of the same object

Referenced by qVTKObjectEventsObserver::removeConnection().

bool qVTKConnection::isBlocked (  )  const
bool qVTKConnection::isEnabled (  )  const
bool qVTKConnection::isEqual ( vtkObject vtk_obj,
unsigned long  vtk_event,
const QObject qt_obj,
QString  qt_slot 
) const
bool qVTKConnection::IsEqual ( vtkObject vtk_obj,
unsigned long  vtk_event,
const QObject qt_obj,
QString  qt_slot 
)
virtual void qVTKConnection::printAdditionalInfo (  )  [virtual]
void qVTKConnection::printAdditionalInfo (  )  [virtual]
qVTKConnection::QCTK_DECLARE_PRIVATE ( qVTKConnection   )  [private]
qVTKConnection::QCTK_DECLARE_PRIVATE ( qVTKConnection   )  [private]
void qVTKConnection::setBlocked ( bool  block  ) 

Temporarilly block any signals/slots. If the event is fired, the slot won't be called. You can restore the connection by calling SetBlocked with block = false.

References autoSlicerTracto2regions::d, and QCTK_D.

Referenced by qVTKObjectEventsObserver::blockAllConnections().

void qVTKConnection::SetBlocked ( bool  block  ) 
void qVTKConnection::setEnabled ( bool  enable  ) 

Actually do the connection. Parameters must have been set prior to it Disconnecting (enable = false) removes the connection.

References autoSlicerTracto2regions::d, and QCTK_D.

void qVTKConnection::SetEstablished ( bool  enable  ) 
void qVTKConnection::SetParameters ( vtkObject vtk_obj,
unsigned long  vtk_event,
const QObject qt_obj,
QString  qt_slot,
float  priority 
)
void qVTKConnection::SetParameters ( vtkObject vtk_obj,
unsigned long  vtk_event,
const QObject qt_obj,
QString  qt_slot,
float  priority 
)
QString qVTKConnection::shortDescription ( vtkObject vtk_obj,
unsigned long  vtk_event,
const QObject qt_obj,
QString  qt_slot = "" 
) [static]
QString qVTKConnection::shortDescription (  ) 
static bool qVTKConnection::ValidateParameters ( vtkObject vtk_obj,
unsigned long  vtk_event,
const QObject qt_obj,
QString  qt_slot 
) [static]

Check the validity of the parameters. Parameters must be valid to add a connection

bool qVTKConnection::ValidateParameters ( vtkObject vtk_obj,
unsigned long  vtk_event,
const QObject qt_obj,
QString  qt_slot 
) [static]

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

Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1