AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

animal::KeyEvent Class Reference

#include <keyEvent.h>

Inheritance diagram for animal::KeyEvent:

List of all members.

---

Detailed Description

The AnimalKeyEvent class describes a key event.

Definition at line 13 of file keyEvent.h.

Public Member Functions
	KeyEvent (TypeInt type, KeyInt key, ButtonStateInt state)
	Constructor.
virtual	~KeyEvent ()
	Destructor.
KeyInt	key () const
	Return the code of the key ( animal::Key) that was pressed or released.
bool	isAccepted () const
	Return TRUE if the receiver of the event wants to keep the key; otherwise returns FALSE.
void	accept ()
	Set the member AnimalKeyEvent::_accepted to true.
void	ignore ()
	Set the member AnimalKeyEvent::_accepted to false.
Protected Attributes
bool	_accepted
KeyInt	_key

---

Constructor & Destructor Documentation

animal::KeyEvent::KeyEvent (  TypeInt  type, KeyInt  key, ButtonStateInt  state )  [inline]

Constructor. Definition at line 17 of file keyEvent.h. References _accepted, and _key.

virtual animal::KeyEvent::~KeyEvent (   )  [inline, virtual]

Destructor. Definition at line 23 of file keyEvent.h.

---

Member Function Documentation

void animal::KeyEvent::accept (   )  [inline]

Set the member AnimalKeyEvent::_accepted to true. Definition at line 29 of file keyEvent.h. References _accepted.

void animal::KeyEvent::ignore (   )  [inline]

Set the member AnimalKeyEvent::_accepted to false. Definition at line 31 of file keyEvent.h. References _accepted.

bool animal::KeyEvent::isAccepted (   )  const [inline]

Return TRUE if the receiver of the event wants to keep the key; otherwise returns FALSE. Definition at line 27 of file keyEvent.h. References _accepted.

KeyInt animal::KeyEvent::key (   )  const [inline]

Return the code of the key ( animal::Key) that was pressed or released. Definition at line 25 of file keyEvent.h. References _key.

---

Member Data Documentation

bool animal::KeyEvent::_accepted [protected]

Definition at line 34 of file keyEvent.h. Referenced by accept(), ignore(), isAccepted(), and KeyEvent().

KeyInt animal::KeyEvent::_key [protected]

Definition at line 35 of file keyEvent.h. Referenced by key(), and KeyEvent().

---

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

• keyEvent.h

---