BrailleTutorNS::BaseIOEvent Struct Reference

A datatype describing basic stylus and button events. More...

#include <Types.h>

Collaboration diagram for BrailleTutorNS::BaseIOEvent:

[legend]

List of all members.

Public Types
enum	Type {   STYLUS_DOWN, STYLUS_UP, BUTTON_DOWN, BUTTON_UP,   DONE, FLUSH_GLYPH }
	Base IO event type symbols. More...
Static Public Member Functions
static BaseIOEvent	makeStylusDownEvent (const TimeInterval &my_timestamp, const unsigned short int &my_cell, const unsigned char &my_dot)
	Named constructor for creating STYLUS_DOWN events.
static BaseIOEvent	makeStylusUpEvent (const TimeInterval &my_timestamp, const unsigned short int &my_cell, const unsigned char &my_dot)
	Named constructor for creating STYLUS_UP events.
static BaseIOEvent	makeButtonDownEvent (const TimeInterval &my_timestamp, const unsigned short int &my_button)
	Named constructor for creating BUTTON_DOWN events.
static BaseIOEvent	makeButtonUpEvent (const TimeInterval &my_timestamp, const unsigned short int &my_button)
	Named constructor for creating BUTTON_UP events.
static BaseIOEvent	makeDoneEvent ()
	Named constructor for DONE events. Only to be called internally!
static BaseIOEvent	makeFlushGlyphEvent ()
	Named constructor for FLUSH_GLYPH events. Only to be called internally!
Public Attributes
Type	type
	Event type.
unsigned char	dot
	Cell dot in which the stylus event occurred.
TimeInterval	timestamp
	Timestamp of the event.
unsigned short int	cell
	Cell in which the stylus event occurred.
unsigned short int	button
	Button emitting the button event.

---

Detailed Description

A datatype describing basic stylus and button events.

This class describes the most basic Braille Tutor events: individual button presses or stylus insertions/extractions. Supported events under the present BT hardware include stylus "down" (insertion), stylus "up" (extraction), button down (press), and button up (release).

---

Member Enumeration Documentation

enum BrailleTutorNS::BaseIOEvent::Type

Base IO event type symbols.

Enumerator:

STYLUS_DOWN	Stylus insertion into a dot.
STYLUS_UP	Stylus withdrawal from a dot.
BUTTON_DOWN	Button press.
BUTTON_UP	Button release.
DONE	BrailleTutor instance about to destruct; clean up!
FLUSH_GLYPH	IOEventParser force flush (KLUDGE-INTERNAL USE ONLY).

---

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

• /Users/tom/usr/src/BrailleTutor-0.7/include/Types.h

---