vtkKWEventMap Class Reference

map between mouse/keyboard event and actions More...

#include <vtkKWEventMap.h>

Inheritance diagram for vtkKWEventMap:

[legend]

Collaboration diagram for vtkKWEventMap:

[legend]

List of all members.

Public Types
enum	{ LeftButton = 0, MiddleButton = 1, RightButton = 2 }
enum	{ NoModifier = 0, ShiftModifier = 1, ControlModifier = 2, ControlShiftModifier = 3 }
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
const char *	FindMouseAction (int button, int modifier)
const char *	FindKeyAction (char key, int modifier)
const char *	FindKeySymAction (const char *keySym, int modifier)
void	ShallowCopy (vtkKWEventMap *tprop)
void	AddMouseEvent (vtkKWEventMap::MouseEvent *me)
void	AddMouseEvent (int button, int modifier, const char *action)
void	AddMouseEvent (int button, int modifier, const char *action, const char *context, const char *description)
void	SetMouseEvent (vtkKWEventMap::MouseEvent *me)
void	SetMouseEvent (int button, int modifier, const char *action)
void	SetMouseEvent (int button, int modifier, const char *action, const char *context, const char *description)
vtkKWEventMap::MouseEvent *	GetMouseEvent (int index)
void	RemoveMouseEvent (vtkKWEventMap::MouseEvent *me)
void	RemoveMouseEvent (int button, int modifier, const char *action=NULL)
void	RemoveAllMouseEvents ()
virtual int	GetNumberOfMouseEvents ()
void	AddKeyEvent (vtkKWEventMap::KeyEvent *me)
void	AddKeyEvent (char key, int modifier, const char *action)
void	AddKeyEvent (char key, int modifier, const char *action, const char *context, const char *description)
void	SetKeyEvent (char key, int modifier, const char *action)
void	SetKeyEvent (char key, int modifier, const char *action, const char *context, const char *description)
vtkKWEventMap::KeyEvent *	GetKeyEvent (int index)
void	RemoveKeyEvent (char key, int modifier, const char *action=NULL)
void	RemoveAllKeyEvents ()
virtual int	GetNumberOfKeyEvents ()
void	AddKeySymEvent (vtkKWEventMap::KeySymEvent *me)
void	AddKeySymEvent (const char *keySym, int modifier, const char *action)
void	AddKeySymEvent (const char *keySym, int modifier, const char *action, const char *context, const char *description)
void	SetKeySymEvent (const char *keySym, int modifier, const char *action)
void	SetKeySymEvent (const char *keySym, int modifier, const char *action, const char *context, const char *description)
vtkKWEventMap::KeySymEvent *	GetKeySymEvent (int index)
void	RemoveKeySymEvent (const char *keySym, int modifier, const char *action=NULL)
void	RemoveAllKeySymEvents ()
virtual int	GetNumberOfKeySymEvents ()
Static Public Member Functions
static vtkKWEventMap *	New ()
static int	IsTypeOf (const char *type)
static vtkKWEventMap *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWEventMap ()
	~vtkKWEventMap ()
Protected Attributes
MouseEvent *	MouseEvents
KeyEvent *	KeyEvents
KeySymEvent *	KeySymEvents
int	NumberOfMouseEvents
int	NumberOfKeyEvents
int	NumberOfKeySymEvents

---

Detailed Description

map between mouse/keyboard event and actions

vtkKWEventMap maintains 3 lists of events -- for mouse, keyboard, and keysym events. The mouse event list maps between mouse button + modifier keys and actions. The keyboard event list maps between keys + modifier keys and actions. The keysym event list maps between keysyms and actions.

Definition at line 29 of file vtkKWEventMap.h.

---

Member Typedef Documentation

typedef vtkObject vtkKWEventMap::Superclass

Reimplemented from vtkObject.

Definition at line 34 of file vtkKWEventMap.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

LeftButton
MiddleButton
RightButton

Definition at line 42 of file vtkKWEventMap.h.

anonymous enum

Enumerator:

NoModifier
ShiftModifier
ControlModifier
ControlShiftModifier

Definition at line 49 of file vtkKWEventMap.h.

---

Constructor & Destructor Documentation

vtkKWEventMap::vtkKWEventMap

(

)

[protected]

vtkKWEventMap::~vtkKWEventMap

(

)

[protected]

---

Member Function Documentation

static vtkKWEventMap* vtkKWEventMap::New

(

)

[static]

Reimplemented from vtkObject.

virtual const char* vtkKWEventMap::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkKWEventMap::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkObject.

virtual int vtkKWEventMap::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkObject.

static vtkKWEventMap* vtkKWEventMap::SafeDownCast

(

vtkObject *

o

)

[static]

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

Reimplemented from vtkObject.

void vtkKWEventMap::AddMouseEvent

(

vtkKWEventMap::MouseEvent *

me

)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

void vtkKWEventMap::AddMouseEvent	(	int	button,
		int	modifier,
		const char *	action
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

void vtkKWEventMap::AddMouseEvent	(	int	button,
		int	modifier,
		const char *	action,
		const char *	context,
		const char *	description
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

void vtkKWEventMap::SetMouseEvent

(

vtkKWEventMap::MouseEvent *

me

)

Change the action to associate with a specific mouse button and modifier key. A mouse event with this button and modifier must have already have been added. BTX

void vtkKWEventMap::SetMouseEvent	(	int	button,
		int	modifier,
		const char *	action
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

void vtkKWEventMap::SetMouseEvent	(	int	button,
		int	modifier,
		const char *	action,
		const char *	context,
		const char *	description
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

vtkKWEventMap::MouseEvent* vtkKWEventMap::GetMouseEvent

(

int

index

)

Get the mouse event at the specified index. BTX

void vtkKWEventMap::RemoveMouseEvent

(

vtkKWEventMap::MouseEvent *

me

)

Remove the action associated with this mouse button and modifier key from the list of mouse events (or all actions if action is NULL). BTX

void vtkKWEventMap::RemoveMouseEvent	(	int	button,
		int	modifier,
		const char *	action = NULL
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

void vtkKWEventMap::RemoveAllMouseEvents

(

)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

const char* vtkKWEventMap::FindMouseAction	(	int	button,
		int	modifier
	)

Return the string for the action of the mouse event indicated by this button and modifier.

virtual int vtkKWEventMap::GetNumberOfMouseEvents

(

)

[virtual]

Return the total number of mouse events.

void vtkKWEventMap::AddKeyEvent

(

vtkKWEventMap::KeyEvent *

me

)

Add a unique action with a specific key and modifier key to the list of key events. BTX

void vtkKWEventMap::AddKeyEvent	(	char	key,
		int	modifier,
		const char *	action
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

void vtkKWEventMap::AddKeyEvent	(	char	key,
		int	modifier,
		const char *	action,
		const char *	context,
		const char *	description
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

void vtkKWEventMap::SetKeyEvent	(	char	key,
		int	modifier,
		const char *	action
	)

Change the action to associate with a specific key and modifier key. A key event with this key and modifier must have already been added.

void vtkKWEventMap::SetKeyEvent	(	char	key,
		int	modifier,
		const char *	action,
		const char *	context,
		const char *	description
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

vtkKWEventMap::KeyEvent* vtkKWEventMap::GetKeyEvent

(

int

index

)

Get the key event at the specified index. BTX

void vtkKWEventMap::RemoveKeyEvent	(	char	key,
		int	modifier,
		const char *	action = NULL
	)

Remove the action associated with this key and modifier key from the list of key events (or all actions if action is NULL)..

void vtkKWEventMap::RemoveAllKeyEvents

(

)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

const char* vtkKWEventMap::FindKeyAction	(	char	key,
		int	modifier
	)

Return the string for the action of the key event indicated by this key and modifier.

virtual int vtkKWEventMap::GetNumberOfKeyEvents

(

)

[virtual]

Return the total number of key events.

void vtkKWEventMap::AddKeySymEvent

(

vtkKWEventMap::KeySymEvent *

me

)

Add a unique action with a specific keysym to the list of keysym events. BTX

void vtkKWEventMap::AddKeySymEvent	(	const char *	keySym,
		int	modifier,
		const char *	action
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

void vtkKWEventMap::AddKeySymEvent	(	const char *	keySym,
		int	modifier,
		const char *	action,
		const char *	context,
		const char *	description
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

void vtkKWEventMap::SetKeySymEvent	(	const char *	keySym,
		int	modifier,
		const char *	action
	)

Change the action to associate with a specific keysym. A keysym event with this keysym must have already been added.

void vtkKWEventMap::SetKeySymEvent	(	const char *	keySym,
		int	modifier,
		const char *	action,
		const char *	context,
		const char *	description
	)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

vtkKWEventMap::KeySymEvent* vtkKWEventMap::GetKeySymEvent

(

int

index

)

Get the keysym event at the specified index. BTX

void vtkKWEventMap::RemoveKeySymEvent	(	const char *	keySym,
		int	modifier,
		const char *	action = NULL
	)

Remove the action assiciated with this keysym from the list of keysym events (or all actions if action is NULL)..

void vtkKWEventMap::RemoveAllKeySymEvents

(

)

Add a unique action with a specific mouse button and modifier key to the list of mouse events. BTX

const char* vtkKWEventMap::FindKeySymAction	(	const char *	keySym,
		int	modifier
	)

Return the string for the action of the keysym event indicated by this keysym.

virtual int vtkKWEventMap::GetNumberOfKeySymEvents

(

)

[virtual]

Return the total number of keysym events.

void vtkKWEventMap::ShallowCopy

(

vtkKWEventMap *

tprop

)

Shallow copy.

---

Member Data Documentation

MouseEvent* vtkKWEventMap::MouseEvents [protected]

Definition at line 237 of file vtkKWEventMap.h.

KeyEvent* vtkKWEventMap::KeyEvents [protected]

Definition at line 238 of file vtkKWEventMap.h.

KeySymEvent* vtkKWEventMap::KeySymEvents [protected]

Definition at line 239 of file vtkKWEventMap.h.

int vtkKWEventMap::NumberOfMouseEvents [protected]

Definition at line 241 of file vtkKWEventMap.h.

int vtkKWEventMap::NumberOfKeyEvents [protected]

Definition at line 242 of file vtkKWEventMap.h.

int vtkKWEventMap::NumberOfKeySymEvents [protected]

Definition at line 243 of file vtkKWEventMap.h.

---

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

• vtkKWEventMap.h