ClanLib  2.3.7
Public Types | List of all members
CL_InputEvent Class Reference

Input event class. More...

#include <input_event.h>

Public Types

enum  TabletAxisID {
  x_axis = 0, y_axis = 1, z_axis = 2, tilt_x = 3,
  tilt_y = 4, rotation_pitch = 6, rotation_roll = 7, rotation_yaw = 8,
  proximity_enter = 9, proximity_exit = 10
}
 Tablet axis id's. More...
 
enum  Type {
  no_key = 0, pressed = 1, released = 2, doubleclick = 3,
  pointer_moved = 4, axis_moved = 5, proximity_change = 6
}
 Event types. More...
 

Public Member Functions

Construction
 CL_InputEvent ()
 Constructs a 'NoKey' key. More...
 
 ~CL_InputEvent ()
 

Public Attributes

Operations
int id
 Key or axis identifier. More...
 
CL_String str
 Character sequence generated by event. More...
 
Type type
 Event type. More...
 
CL_InputDevice device
 Device that event originates from. More...
 
CL_Point mouse_pos
 Mouse position at event time. More...
 
double axis_pos
 Axis position. More...
 
int repeat_count
 The repeat count for this event. More...
 
bool alt
 State of modifier keys. More...
 
bool shift
 
bool ctrl
 

Detailed Description

Input event class.

Member Enumeration Documentation

Tablet axis id's.

Enumerator
x_axis 
y_axis 
z_axis 
tilt_x 
tilt_y 
rotation_pitch 
rotation_roll 
rotation_yaw 
proximity_enter 
proximity_exit 

Event types.

Enumerator
no_key 
pressed 
released 
doubleclick 
pointer_moved 
axis_moved 
proximity_change 

Constructor & Destructor Documentation

CL_InputEvent::CL_InputEvent ( )

Constructs a 'NoKey' key.

CL_InputEvent::~CL_InputEvent ( )

Member Data Documentation

bool CL_InputEvent::alt

State of modifier keys.

double CL_InputEvent::axis_pos

Axis position.

bool CL_InputEvent::ctrl
CL_InputDevice CL_InputEvent::device

Device that event originates from.

int CL_InputEvent::id

Key or axis identifier.

CL_Point CL_InputEvent::mouse_pos

Mouse position at event time.

int CL_InputEvent::repeat_count

The repeat count for this event.

The variable contains the number of times the keystroke is autorepeated as a result of the user holding down the key.

bool CL_InputEvent::shift
CL_String CL_InputEvent::str

Character sequence generated by event.

A key press can generate one, none or multiple characters, the reason for this are deadkeys, ie. press ^ + a and get ^, so the first press would generate no key and the second one, in case that the second key being pressed doesn't support the ^ it would generate two characters (ie. ^ + 5 => "", "^5")

Type CL_InputEvent::type

Event type.


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