Documentation


animal::Event Class Reference

#include <event.h>

Inheritance diagram for animal::Event:

animal::KeyEvent animal::MouseEvent List of all members.

Detailed Description

The AnimalEvent class is the base class of all event classes. Event objects contain event parameters.

Definition at line 11 of file event.h.

Public Types

typedef int KeyInt
typedef int ButtonStateInt
typedef int TypeInt
enum  Type {
  None = 0, MouseButtonPress = 2, MouseButtonRelease = 3, MouseButtonDblClick = 4,
  MouseMove = 5, KeyPress = 6, KeyRelease = 7
}
 Based on QEvent::Type. More...

enum  Key {
  Key_Escape = 0x1000, Key_Tab = 0x1001, Key_Backtab = 0x1002, Key_BackTab = Key_Backtab,
  Key_Backspace = 0x1003, Key_BackSpace = Key_Backspace, Key_Return = 0x1004, Key_Enter = 0x1005,
  Key_Insert = 0x1006, Key_Delete = 0x1007, Key_Pause = 0x1008, Key_Print = 0x1009,
  Key_SysReq = 0x100a, Key_Clear = 0x100b, Key_Home = 0x1010, Key_End = 0x1011,
  Key_Left = 0x1012, Key_Up = 0x1013, Key_Right = 0x1014, Key_Down = 0x1015,
  Key_Prior = 0x1016, Key_PageUp = Key_Prior, Key_Next = 0x1017, Key_PageDown = Key_Next,
  Key_Shift = 0x1020, Key_Control = 0x1021, Key_Meta = 0x1022, Key_Alt = 0x1023,
  Key_CapsLock = 0x1024, Key_NumLock = 0x1025, Key_ScrollLock = 0x1026, Key_F1 = 0x1030,
  Key_F2 = 0x1031, Key_F3 = 0x1032, Key_F4 = 0x1033, Key_F5 = 0x1034,
  Key_F6 = 0x1035, Key_F7 = 0x1036, Key_F8 = 0x1037, Key_F9 = 0x1038,
  Key_F10 = 0x1039, Key_F11 = 0x103a, Key_F12 = 0x103b, Key_F13 = 0x103c,
  Key_F14 = 0x103d, Key_F15 = 0x103e, Key_F16 = 0x103f, Key_F17 = 0x1040,
  Key_F18 = 0x1041, Key_F19 = 0x1042, Key_F20 = 0x1043, Key_F21 = 0x1044,
  Key_F22 = 0x1045, Key_F23 = 0x1046, Key_F24 = 0x1047, Key_F25 = 0x1048,
  Key_F26 = 0x1049, Key_F27 = 0x104a, Key_F28 = 0x104b, Key_F29 = 0x104c,
  Key_F30 = 0x104d, Key_F31 = 0x104e, Key_F32 = 0x104f, Key_F33 = 0x1050,
  Key_F34 = 0x1051, Key_F35 = 0x1052, Key_Super_L = 0x1053, Key_Super_R = 0x1054,
  Key_Menu = 0x1055, Key_Hyper_L = 0x1056, Key_Hyper_R = 0x1057, Key_Help = 0x1058,
  Key_Direction_L = 0x1059, Key_Direction_R = 0x1060, Key_Space = 0x20, Key_Any = Key_Space,
  Key_Exclam = 0x21, Key_QuoteDbl = 0x22, Key_NumberSign = 0x23, Key_Dollar = 0x24,
  Key_Percent = 0x25, Key_Ampersand = 0x26, Key_Apostrophe = 0x27, Key_ParenLeft = 0x28,
  Key_ParenRight = 0x29, Key_Asterisk = 0x2a, Key_Plus = 0x2b, Key_Comma = 0x2c,
  Key_Minus = 0x2d, Key_Period = 0x2e, Key_Slash = 0x2f, Key_0 = 0x30,
  Key_1 = 0x31, Key_2 = 0x32, Key_3 = 0x33, Key_4 = 0x34,
  Key_5 = 0x35, Key_6 = 0x36, Key_7 = 0x37, Key_8 = 0x38,
  Key_9 = 0x39, Key_Colon = 0x3a, Key_Semicolon = 0x3b, Key_Less = 0x3c,
  Key_Equal = 0x3d, Key_Greater = 0x3e, Key_Question = 0x3f, Key_At = 0x40,
  Key_A = 0x41, Key_B = 0x42, Key_C = 0x43, Key_D = 0x44,
  Key_E = 0x45, Key_F = 0x46, Key_G = 0x47, Key_H = 0x48,
  Key_I = 0x49, Key_J = 0x4a, Key_K = 0x4b, Key_L = 0x4c,
  Key_M = 0x4d, Key_N = 0x4e, Key_O = 0x4f, Key_P = 0x50,
  Key_Q = 0x51, Key_R = 0x52, Key_S = 0x53, Key_T = 0x54,
  Key_U = 0x55, Key_V = 0x56, Key_W = 0x57, Key_X = 0x58,
  Key_Y = 0x59, Key_Z = 0x5a, Key_BracketLeft = 0x5b, Key_Backslash = 0x5c,
  Key_BracketRight = 0x5d, Key_AsciiCircum = 0x5e, Key_Underscore = 0x5f, Key_QuoteLeft = 0x60,
  Key_BraceLeft = 0x7b, Key_Bar = 0x7c, Key_BraceRight = 0x7d, Key_AsciiTilde = 0x7e,
  Key_nobreakspace = 0x0a0, Key_exclamdown = 0x0a1, Key_cent = 0x0a2, Key_sterling = 0x0a3,
  Key_currency = 0x0a4, Key_yen = 0x0a5, Key_brokenbar = 0x0a6, Key_section = 0x0a7,
  Key_diaeresis = 0x0a8, Key_copyright = 0x0a9, Key_ordfeminine = 0x0aa, Key_guillemotleft = 0x0ab,
  Key_notsign = 0x0ac, Key_hyphen = 0x0ad, Key_registered = 0x0ae, Key_macron = 0x0af,
  Key_degree = 0x0b0, Key_plusminus = 0x0b1, Key_twosuperior = 0x0b2, Key_threesuperior = 0x0b3,
  Key_acute = 0x0b4, Key_mu = 0x0b5, Key_paragraph = 0x0b6, Key_periodcentered = 0x0b7,
  Key_cedilla = 0x0b8, Key_onesuperior = 0x0b9, Key_masculine = 0x0ba, Key_guillemotright = 0x0bb,
  Key_onequarter = 0x0bc, Key_onehalf = 0x0bd, Key_threequarters = 0x0be, Key_questiondown = 0x0bf,
  Key_Agrave = 0x0c0, Key_Aacute = 0x0c1, Key_Acircumflex = 0x0c2, Key_Atilde = 0x0c3,
  Key_Adiaeresis = 0x0c4, Key_Aring = 0x0c5, Key_AE = 0x0c6, Key_Ccedilla = 0x0c7,
  Key_Egrave = 0x0c8, Key_Eacute = 0x0c9, Key_Ecircumflex = 0x0ca, Key_Ediaeresis = 0x0cb,
  Key_Igrave = 0x0cc, Key_Iacute = 0x0cd, Key_Icircumflex = 0x0ce, Key_Idiaeresis = 0x0cf,
  Key_ETH = 0x0d0, Key_Ntilde = 0x0d1, Key_Ograve = 0x0d2, Key_Oacute = 0x0d3,
  Key_Ocircumflex = 0x0d4, Key_Otilde = 0x0d5, Key_Odiaeresis = 0x0d6, Key_multiply = 0x0d7,
  Key_Ooblique = 0x0d8, Key_Ugrave = 0x0d9, Key_Uacute = 0x0da, Key_Ucircumflex = 0x0db,
  Key_Udiaeresis = 0x0dc, Key_Yacute = 0x0dd, Key_THORN = 0x0de, Key_ssharp = 0x0df,
  Key_agrave = 0x0e0, Key_aacute = 0x0e1, Key_acircumflex = 0x0e2, Key_atilde = 0x0e3,
  Key_adiaeresis = 0x0e4, Key_aring = 0x0e5, Key_ae = 0x0e6, Key_ccedilla = 0x0e7,
  Key_egrave = 0x0e8, Key_eacute = 0x0e9, Key_ecircumflex = 0x0ea, Key_ediaeresis = 0x0eb,
  Key_igrave = 0x0ec, Key_iacute = 0x0ed, Key_icircumflex = 0x0ee, Key_idiaeresis = 0x0ef,
  Key_eth = 0x0f0, Key_ntilde = 0x0f1, Key_ograve = 0x0f2, Key_oacute = 0x0f3,
  Key_ocircumflex = 0x0f4, Key_otilde = 0x0f5, Key_odiaeresis = 0x0f6, Key_division = 0x0f7,
  Key_oslash = 0x0f8, Key_ugrave = 0x0f9, Key_uacute = 0x0fa, Key_ucircumflex = 0x0fb,
  Key_udiaeresis = 0x0fc, Key_yacute = 0x0fd, Key_thorn = 0x0fe, Key_ydiaeresis = 0x0ff,
  Key_Back = 0x1061, Key_Forward = 0x1062, Key_Stop = 0x1063, Key_Refresh = 0x1064,
  Key_VolumeDown = 0x1070, Key_VolumeMute = 0x1071, Key_VolumeUp = 0x1072, Key_BassBoost = 0x1073,
  Key_BassUp = 0x1074, Key_BassDown = 0x1075, Key_TrebleUp = 0x1076, Key_TrebleDown = 0x1077,
  Key_MediaPlay = 0x1080, Key_MediaStop = 0x1081, Key_MediaPrev = 0x1082, Key_MediaNext = 0x1083,
  Key_MediaRecord = 0x1084, Key_HomePage = 0x1090, Key_Favorites = 0x1091, Key_Search = 0x1092,
  Key_Standby = 0x1093, Key_OpenUrl = 0x1094, Key_LaunchMail = 0x10a0, Key_LaunchMedia = 0x10a1,
  Key_Launch0 = 0x10a2, Key_Launch1 = 0x10a3, Key_Launch2 = 0x10a4, Key_Launch3 = 0x10a5,
  Key_Launch4 = 0x10a6, Key_Launch5 = 0x10a7, Key_Launch6 = 0x10a8, Key_Launch7 = 0x10a9,
  Key_Launch8 = 0x10aa, Key_Launch9 = 0x10ab, Key_LaunchA = 0x10ac, Key_LaunchB = 0x10ad,
  Key_LaunchC = 0x10ae, Key_LaunchD = 0x10af, Key_LaunchE = 0x10b0, Key_LaunchF = 0x10b1,
  Key_MediaLast = 0x1fff, Key_unknown = 0xffff
}
 Based on Qt::Key. More...

enum  ButtonState {
  NoButton = 0x0000, LeftButton = 0x0001, RightButton = 0x0002, MidButton = 0x0004,
  MouseButtonMask = 0x0007, ShiftButton = 0x0100, ControlButton = 0x0200, AltButton = 0x0400,
  MetaButton = 0x0800, KeyButtonMask = 0x0f00, Keypad = 0x4000
}
 Based on Qt::ButtonState. More...


Public Member Functions

 Event (TypeInt type, ButtonStateInt state)
 Constructor.

virtual ~Event ()
 Destructor.

TypeInt type () const
 Return the event type.

ButtonStateInt state () const
 Return the keyboard modifier flags or the mouse button ( animal::ButtonState) that existed immediately before the event occurred.


Protected Attributes

TypeInt _type
ButtonStateInt _state


Member Typedef Documentation

typedef int animal::Event::ButtonStateInt
 

Definition at line 338 of file event.h.

Referenced by Event(), and state().

typedef int animal::Event::KeyInt
 

Definition at line 337 of file event.h.

typedef int animal::Event::TypeInt
 

Definition at line 339 of file event.h.

Referenced by Event(), and type().


Member Enumeration Documentation

enum animal::Event::ButtonState
 

Based on Qt::ButtonState.

Enumeration values:
NoButton 
LeftButton 
RightButton 
MidButton 
MouseButtonMask 
ShiftButton 
ControlButton 
AltButton 
MetaButton 
KeyButtonMask 
Keypad 

Definition at line 324 of file event.h.

enum animal::Event::Key
 

Based on Qt::Key.

Enumeration values:
Key_Escape 
Key_Tab 
Key_Backtab 
Key_BackTab 
Key_Backspace 
Key_BackSpace 
Key_Return 
Key_Enter 
Key_Insert 
Key_Delete 
Key_Pause 
Key_Print 
Key_SysReq 
Key_Clear 
Key_Home 
Key_End 
Key_Left 
Key_Up 
Key_Right 
Key_Down 
Key_Prior 
Key_PageUp 
Key_Next 
Key_PageDown 
Key_Shift 
Key_Control 
Key_Meta 
Key_Alt 
Key_CapsLock 
Key_NumLock 
Key_ScrollLock 
Key_F1 
Key_F2 
Key_F3 
Key_F4 
Key_F5 
Key_F6 
Key_F7 
Key_F8 
Key_F9 
Key_F10 
Key_F11 
Key_F12 
Key_F13 
Key_F14 
Key_F15 
Key_F16 
Key_F17 
Key_F18 
Key_F19 
Key_F20 
Key_F21 
Key_F22 
Key_F23 
Key_F24 
Key_F25 
Key_F26 
Key_F27 
Key_F28 
Key_F29 
Key_F30 
Key_F31 
Key_F32 
Key_F33 
Key_F34 
Key_F35 
Key_Super_L 
Key_Super_R 
Key_Menu 
Key_Hyper_L 
Key_Hyper_R 
Key_Help 
Key_Direction_L 
Key_Direction_R 
Key_Space 
Key_Any 
Key_Exclam 
Key_QuoteDbl 
Key_NumberSign 
Key_Dollar 
Key_Percent 
Key_Ampersand 
Key_Apostrophe 
Key_ParenLeft 
Key_ParenRight 
Key_Asterisk 
Key_Plus 
Key_Comma 
Key_Minus 
Key_Period 
Key_Slash 
Key_0 
Key_1 
Key_2 
Key_3 
Key_4 
Key_5 
Key_6 
Key_7 
Key_8 
Key_9 
Key_Colon 
Key_Semicolon 
Key_Less 
Key_Equal 
Key_Greater 
Key_Question 
Key_At 
Key_A 
Key_B 
Key_C 
Key_D 
Key_E 
Key_F 
Key_G 
Key_H 
Key_I 
Key_J 
Key_K 
Key_L 
Key_M 
Key_N 
Key_O 
Key_P 
Key_Q 
Key_R 
Key_S 
Key_T 
Key_U 
Key_V 
Key_W 
Key_X 
Key_Y 
Key_Z 
Key_BracketLeft 
Key_Backslash 
Key_BracketRight 
Key_AsciiCircum 
Key_Underscore 
Key_QuoteLeft 
Key_BraceLeft 
Key_Bar 
Key_BraceRight 
Key_AsciiTilde 
Key_nobreakspace 
Key_exclamdown 
Key_cent 
Key_sterling 
Key_currency 
Key_yen 
Key_brokenbar 
Key_section 
Key_diaeresis 
Key_copyright 
Key_ordfeminine 
Key_guillemotleft 
Key_notsign 
Key_hyphen 
Key_registered 
Key_macron 
Key_degree 
Key_plusminus 
Key_twosuperior 
Key_threesuperior 
Key_acute 
Key_mu 
Key_paragraph 
Key_periodcentered 
Key_cedilla 
Key_onesuperior 
Key_masculine 
Key_guillemotright 
Key_onequarter 
Key_onehalf 
Key_threequarters 
Key_questiondown 
Key_Agrave 
Key_Aacute 
Key_Acircumflex 
Key_Atilde 
Key_Adiaeresis 
Key_Aring 
Key_AE 
Key_Ccedilla 
Key_Egrave 
Key_Eacute 
Key_Ecircumflex 
Key_Ediaeresis 
Key_Igrave 
Key_Iacute 
Key_Icircumflex 
Key_Idiaeresis 
Key_ETH 
Key_Ntilde 
Key_Ograve 
Key_Oacute 
Key_Ocircumflex 
Key_Otilde 
Key_Odiaeresis 
Key_multiply 
Key_Ooblique 
Key_Ugrave 
Key_Uacute 
Key_Ucircumflex 
Key_Udiaeresis 
Key_Yacute 
Key_THORN 
Key_ssharp 
Key_agrave 
Key_aacute 
Key_acircumflex 
Key_atilde 
Key_adiaeresis 
Key_aring 
Key_ae 
Key_ccedilla 
Key_egrave 
Key_eacute 
Key_ecircumflex 
Key_ediaeresis 
Key_igrave 
Key_iacute 
Key_icircumflex 
Key_idiaeresis 
Key_eth 
Key_ntilde 
Key_ograve 
Key_oacute 
Key_ocircumflex 
Key_otilde 
Key_odiaeresis 
Key_division 
Key_oslash 
Key_ugrave 
Key_uacute 
Key_ucircumflex 
Key_udiaeresis 
Key_yacute 
Key_thorn 
Key_ydiaeresis 
Key_Back 
Key_Forward 
Key_Stop 
Key_Refresh 
Key_VolumeDown 
Key_VolumeMute 
Key_VolumeUp 
Key_BassBoost 
Key_BassUp 
Key_BassDown 
Key_TrebleUp 
Key_TrebleDown 
Key_MediaPlay 
Key_MediaStop 
Key_MediaPrev 
Key_MediaNext 
Key_MediaRecord 
Key_HomePage 
Key_Favorites 
Key_Search 
Key_Standby 
Key_OpenUrl 
Key_LaunchMail 
Key_LaunchMedia 
Key_Launch0 
Key_Launch1 
Key_Launch2 
Key_Launch3 
Key_Launch4 
Key_Launch5 
Key_Launch6 
Key_Launch7 
Key_Launch8 
Key_Launch9 
Key_LaunchA 
Key_LaunchB 
Key_LaunchC 
Key_LaunchD 
Key_LaunchE 
Key_LaunchF 
Key_MediaLast 
Key_unknown 

Definition at line 31 of file event.h.

enum animal::Event::Type
 

Based on QEvent::Type.

Enumeration values:
None 
MouseButtonPress 
MouseButtonRelease 
MouseButtonDblClick 
MouseMove 
KeyPress 
KeyRelease 

Definition at line 15 of file event.h.


Constructor & Destructor Documentation

animal::Event::Event TypeInt  type,
ButtonStateInt  state
[inline]
 

Constructor.

Definition at line 342 of file event.h.

References _state, _type, ButtonStateInt, and TypeInt.

virtual animal::Event::~Event  )  [inline, virtual]
 

Destructor.

Definition at line 347 of file event.h.


Member Function Documentation

ButtonStateInt animal::Event::state  )  const [inline]
 

Return the keyboard modifier flags or the mouse button ( animal::ButtonState) that existed immediately before the event occurred.

Definition at line 351 of file event.h.

References _state, and ButtonStateInt.

TypeInt animal::Event::type  )  const [inline]
 

Return the event type.

Definition at line 349 of file event.h.

References _type, and TypeInt.


Member Data Documentation

ButtonStateInt animal::Event::_state [protected]
 

Definition at line 355 of file event.h.

Referenced by Event(), and state().

TypeInt animal::Event::_type [protected]
 

Definition at line 354 of file event.h.

Referenced by Event(), and type().


The documentation for this class was generated from the following file:
Generated on Thu Dec 23 13:52:31 2004 by doxygen 1.3.6