vtkKWDragAndDropTargetSet Class Reference

a set of drag and drop targets More...

#include <vtkKWDragAndDropTargetSet.h>

Inheritance diagram for vtkKWDragAndDropTargetSet:

[legend]

Collaboration diagram for vtkKWDragAndDropTargetSet:

[legend]

List of all members.

Classes
class	TargetSlot
Public Types
typedef vtkKWObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetEnable (int)
virtual void	EnableOn ()
virtual void	EnableOff ()
virtual int	GetEnable ()
virtual void	SetSource (vtkKWWidget *)
virtual vtkKWWidget *	GetSource ()
virtual void	SetSourceAnchor (vtkKWWidget *)
virtual vtkKWWidget *	GetSourceAnchor ()
virtual int	AddTarget (vtkKWWidget *target)
virtual int	RemoveTarget (vtkKWWidget *target)
virtual int	HasTarget (vtkKWWidget *target)
virtual int	GetNumberOfTargets ()
virtual int	SetTargetStartCommand (vtkKWWidget *target, vtkObject *object, const char *method)
virtual int	SetTargetPerformCommand (vtkKWWidget *target, vtkObject *object, const char *method)
virtual int	SetTargetEndCommand (vtkKWWidget *target, vtkObject *object, const char *method)
virtual void	SetStartCommand (vtkObject *object, const char *method)
virtual void	SetPerformCommand (vtkObject *object, const char *method)
virtual void	SetEndCommand (vtkObject *object, const char *method)
virtual void	StartCallback (int x, int y)
virtual void	PerformCallback (int x, int y)
virtual void	EndCallback (int x, int y)
Static Public Member Functions
static vtkKWDragAndDropTargetSet *	New ()
static int	IsTypeOf (const char *type)
static vtkKWDragAndDropTargetSet *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWDragAndDropTargetSet ()
	~vtkKWDragAndDropTargetSet ()
TargetSlot *	GetTarget (vtkKWWidget *target)
virtual void	InvokeCommandWithCoordinates (const char *command, int x, int y)
virtual void	InvokeStartCommand (int x, int y)
virtual void	InvokePerformCommand (int x, int y)
virtual void	InvokeEndCommand (int x, int y)
virtual void	AddBindings ()
virtual void	RemoveBindings ()
virtual void	DeleteAllTargets ()
Protected Attributes
vtkKWDragAndDropTargetSetInternals *	Internals
int	Enable
vtkKWWidget *	SourceAnchor
vtkKWWidget *	Source
char *	StartCommand
char *	PerformCommand
char *	EndCommand
Friends
class	vtkKWDragAndDropTargetSetInternals

---

Detailed Description

a set of drag and drop targets

This class is a container for a set of drag and drop targets. It provides methods to set drag and drop callbacks between a *single* source and one or more targets. This is *not* a general drag and drop framework, where DnD types would be created and objects would register themselves as source and/or sinks for any of those types. This is a simpler framework to perform specific DnD actions between a know source and known targets. An instance of this class is available in vtkKWWidget and can be used to register DnD actions between that vtkKWWidget source and some targets.

See also:

vtkKWWidget

Definition at line 38 of file vtkKWDragAndDropTargetSet.h.

---

Member Typedef Documentation

typedef vtkKWObject vtkKWDragAndDropTargetSet::Superclass

Reimplemented from vtkKWObject.

Definition at line 43 of file vtkKWDragAndDropTargetSet.h.

---

Constructor & Destructor Documentation

vtkKWDragAndDropTargetSet::vtkKWDragAndDropTargetSet

(

)

[protected]

vtkKWDragAndDropTargetSet::~vtkKWDragAndDropTargetSet

(

)

[protected]

---

Member Function Documentation

static vtkKWDragAndDropTargetSet* vtkKWDragAndDropTargetSet::New

(

)

[static]

Reimplemented from vtkKWObject.

virtual const char* vtkKWDragAndDropTargetSet::GetClassName

(

)

[virtual]

Reimplemented from vtkKWObject.

static int vtkKWDragAndDropTargetSet::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWObject.

virtual int vtkKWDragAndDropTargetSet::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWObject.

static vtkKWDragAndDropTargetSet* vtkKWDragAndDropTargetSet::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWObject.

void vtkKWDragAndDropTargetSet::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Reimplemented from vtkKWObject.

virtual void vtkKWDragAndDropTargetSet::SetEnable

(

int

)

[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual void vtkKWDragAndDropTargetSet::EnableOn

(

)

[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual void vtkKWDragAndDropTargetSet::EnableOff

(

)

[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual int vtkKWDragAndDropTargetSet::GetEnable

(

)

[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual void vtkKWDragAndDropTargetSet::SetSource

(

vtkKWWidget *

)

[virtual]

Set/Get the Drag and Drop source widget. This is the widget that the the Drag and Drop originates from. Make sure you have called SetApplication(..) on the instance before.

virtual vtkKWWidget* vtkKWDragAndDropTargetSet::GetSource

(

)

[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual void vtkKWDragAndDropTargetSet::SetSourceAnchor

(

vtkKWWidget *

)

[virtual]

Set/Get the optional Drag and Drop source anchor widget. This is the actual widget that the user drags and drops (i.e. the actual widget the user starts the interaction with). It NULL, it defaults to the Source widget automatically. The anchor widget is a convenient way to specify that a sub-part of the Source widget is to be dragged & dropped, not the whole Source widget. Make sure you have called SetApplication(..) on the instance before.

virtual vtkKWWidget* vtkKWDragAndDropTargetSet::GetSourceAnchor

(

)

[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual int vtkKWDragAndDropTargetSet::AddTarget

(

vtkKWWidget *

target

)

[virtual]

Add/Query/Remove a Drag & Drop target.

virtual int vtkKWDragAndDropTargetSet::RemoveTarget

(

vtkKWWidget *

target

)

[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual int vtkKWDragAndDropTargetSet::HasTarget

(

vtkKWWidget *

target

)

[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual int vtkKWDragAndDropTargetSet::GetNumberOfTargets

(

)

[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual int vtkKWDragAndDropTargetSet::SetTargetStartCommand	(	vtkKWWidget *	target,
		vtkObject *	object,
		const char *	method
	)			[virtual]

Set a Drag & Drop target callbacks/commands. If the target has not been added yet, it will be added automatically. The StartCommand of all targets is called when Drag & Drop starts. The PerformCommand of all targets is called while Drag & Drop is performed. The EndCommand of all targets that contain the drop coordinates is called when Drag & Drop ends. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following parameters are also passed to the commands: - absolute/screen (x,y) mouse coordinates: int, int - the Source widget: vtkKWWidget* - the SourceAnchor widget: vtkKWWidget* (same as Source widget most of the times) Additionally, EndCommand is passed a 5th parameter: - the target: vtkKWWidget*

virtual int vtkKWDragAndDropTargetSet::SetTargetPerformCommand	(	vtkKWWidget *	target,
		vtkObject *	object,
		const char *	method
	)			[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual int vtkKWDragAndDropTargetSet::SetTargetEndCommand	(	vtkKWWidget *	target,
		vtkObject *	object,
		const char *	method
	)			[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual void vtkKWDragAndDropTargetSet::SetStartCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Independent of any targets, the following commands can be set: The StartCommand is called when Drag & Drop starts. The PerformCommand is called while Drag & Drop is performed. The EndCommand is called when Drag & Drop ends. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following parameters are also passed to the commands: - absolute/screen (x,y) mouse coordinates: int, int None of them is called if Enable is false. StartCommand and PerformCommand are called before* any target's corresponding command. EndCommand is called after* any target's EndCommand.

virtual void vtkKWDragAndDropTargetSet::SetPerformCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual void vtkKWDragAndDropTargetSet::SetEndCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual void vtkKWDragAndDropTargetSet::StartCallback	(	int	x,
		int	y
	)			[virtual]

Callbacks. Internal, do not use.

virtual void vtkKWDragAndDropTargetSet::PerformCallback	(	int	x,
		int	y
	)			[virtual]

Enable/disable Drag and Drop between all the source and targets.

virtual void vtkKWDragAndDropTargetSet::EndCallback	(	int	x,
		int	y
	)			[virtual]

Enable/disable Drag and Drop between all the source and targets.

TargetSlot* vtkKWDragAndDropTargetSet::GetTarget

(

vtkKWWidget *

target

)

[protected]

virtual void vtkKWDragAndDropTargetSet::InvokeCommandWithCoordinates	(	const char *	command,
		int	x,
		int	y
	)			[protected, virtual]

virtual void vtkKWDragAndDropTargetSet::InvokeStartCommand	(	int	x,
		int	y
	)			[protected, virtual]

virtual void vtkKWDragAndDropTargetSet::InvokePerformCommand	(	int	x,
		int	y
	)			[protected, virtual]

virtual void vtkKWDragAndDropTargetSet::InvokeEndCommand	(	int	x,
		int	y
	)			[protected, virtual]

virtual void vtkKWDragAndDropTargetSet::AddBindings

(

)

[protected, virtual]

virtual void vtkKWDragAndDropTargetSet::RemoveBindings

(

)

[protected, virtual]

virtual void vtkKWDragAndDropTargetSet::DeleteAllTargets

(

)

[protected, virtual]

---

Friends And Related Function Documentation

friend class vtkKWDragAndDropTargetSetInternals [friend]

Definition at line 158 of file vtkKWDragAndDropTargetSet.h.

---

Member Data Documentation

vtkKWDragAndDropTargetSetInternals* vtkKWDragAndDropTargetSet::Internals [protected]

Definition at line 157 of file vtkKWDragAndDropTargetSet.h.

int vtkKWDragAndDropTargetSet::Enable [protected]

Definition at line 164 of file vtkKWDragAndDropTargetSet.h.

vtkKWWidget* vtkKWDragAndDropTargetSet::SourceAnchor [protected]

Definition at line 166 of file vtkKWDragAndDropTargetSet.h.

vtkKWWidget* vtkKWDragAndDropTargetSet::Source [protected]

Definition at line 167 of file vtkKWDragAndDropTargetSet.h.

char* vtkKWDragAndDropTargetSet::StartCommand [protected]

Definition at line 169 of file vtkKWDragAndDropTargetSet.h.

char* vtkKWDragAndDropTargetSet::PerformCommand [protected]

Definition at line 170 of file vtkKWDragAndDropTargetSet.h.

char* vtkKWDragAndDropTargetSet::EndCommand [protected]

Definition at line 171 of file vtkKWDragAndDropTargetSet.h.

---

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

• vtkKWDragAndDropTargetSet.h