CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

evdefs.h File Reference

Event system related interfaces. More...

Go to the source code of this file.

Classes

struct  _csKeyModifiers
 Flags for all currently pressed modifiers. More...

Event masks

The event masks can be used by plugins to tell an event queue, via iEventQueue::RegisterListener, which kinds of events they want to receive at their HandleEvent() entry. If a plugin registers to receive CSMASK_Nothing events it is always called once per frame, so that plugin can do some per-frame processing.

#define CS_IS_BROADCAST_EVENT(e)   ((1 << (e).Type) & CSMASK_Broadcast)
 Check if a event is a broadcast event.
#define CS_IS_COMMAND_EVENT(e)   ((1 << (e).Type) & CSMASK_Command)
 Check if a event is a command event.
#define CS_IS_INPUT_EVENT(e)   ((1 << (e).Type) & CSMASK_Input)
 Check if a event is any input event.
#define CS_IS_JOYSTICK_EVENT(e)   ((1 << (e).Type) & CSMASK_Joystick)
 Check if a event is a joystick event.
#define CS_IS_KEYBOARD_EVENT(e)   ((1 << (e).Type) & CSMASK_Keyboard)
 Check if a event is a keyboard event.
#define CS_IS_MOUSE_EVENT(e)   ((1 << (e).Type) & CSMASK_Mouse)
 Check if a event is a mouse event.
#define CSMASK_Broadcast   (1 << csevBroadcast)
 Broadcast message events.
#define CSMASK_Command   (1 << csevCommand)
 Command message events.
#define CSMASK_FrameProcess   CSMASK_Nothing
 The plugin will be called at the start of every frame and at the end of every frame with an csevBroadcast event with the Event.Retrieve("cmdCode") equal to cscmdPreProcess, csProcess, cscmdPostProcess, or cscmdFinalProcess.
#define CSMASK_Input   (CSMASK_Keyboard | CSMASK_Mouse | CSMASK_Joystick)
 This mask identifies any input evemt.
#define CSMASK_Joystick   (CSMASK_JoystickMove | CSMASK_JoystickDown | CSMASK_JoystickUp)
 This mask identifies any joystick event.
#define CSMASK_JoystickDown   (1 << csevJoystickDown)
 Joystick button down events.
#define CSMASK_JoystickMove   (1 << csevJoystickMove)
 Joystick movement events.
#define CSMASK_JoystickUp   (1 << csevJoystickUp)
 Joystick button up events.
#define CSMASK_Keyboard   (1 << csevKeyboard)
 Keyboard events.
#define CSMASK_Mouse
 This mask identifies any mouse event.
#define CSMASK_MouseClick   (1 << csevMouseClick)
 Mouse click events.
#define CSMASK_MouseDoubleClick   (1 << csevMouseDoubleClick)
 Mouse double click events.
#define CSMASK_MouseDown   (1 << csevMouseDown)
 Mouse down events.
#define CSMASK_MouseMove   (1 << csevMouseMove)
 Mouse move events.
#define CSMASK_MouseUp   (1 << csevMouseUp)
 Mouse up events.
#define CSMASK_Nothing   (1 << csevNothing)
 Event mask: Empty event.

Event flags masks

Every event has a `flags' field which describes miscelaneous aspects of the event. The following constants describes every used bit of the `flags' field.

#define CSEF_BROADCAST   0x00000001
 Event flag: Ignore `true' returned from HandleEvent which says that event has been processed and should not be processed anymore.

Event class masks

Every event plug should provide information about which event types that may conflict with other event plugs it is able to generate. The system driver checks it and if several event plugs generates conflicting types events, one of them (the one with lower priority) is disabled.

#define CSEVTYPE_Joystick   0x00000004
 Joystick events.
#define CSEVTYPE_Keyboard   0x00000001
 Keyboard events.
#define CSEVTYPE_Mouse   0x00000002
 Mouse events.

Control key codes

Not every existing key on any existing platform is supported by Crystal Space. Instead, we tried to list here all the keys that are common among all platforms on which Crystal Space runs. There may still be some keys that aren't supported on some platforms, tho.

Be aware that the range of the special keys has been arbitrarily, but careful chosen. In particular, all special keys fall into a part of the Unicode "Supplementary Private Use Area-B", so all keycodes in CS are always valid Unicode codepoints.

#define CSKEY_ALT   CSKEY_ALT_NUM(csKeyModifierNumAny)
 Undistinguished Alt.
#define CSKEY_ALT_FIRST   CSKEY_ALT_NUM(0)
 Lowest code of the Alt modifier keys.
#define CSKEY_ALT_LAST   CSKEY_ALT_NUM(0x1e)
 Highest code of the Alt modifier keys.
#define CSKEY_ALT_LEFT   CSKEY_ALT_NUM(csKeyModifierNumLeft)
 Left Alt.
#define CSKEY_ALT_NUM(n)   CSKEY_MODIFIER(csKeyModifierTypeAlt,n)
 Construct a key code for the Alt modifier key number n.
#define CSKEY_ALT_RIGHT   CSKEY_ALT_NUM(csKeyModifierNumRight)
 Right Alt.
#define CSKEY_BACKSPACE   '\b'
 Back-space key.
#define CSKEY_CAPSLOCK   CSKEY_MODIFIER(csKeyModifierTypeCapsLock,csKeyModifierNumAny)
 CapsLock key.
#define CSKEY_CENTER   CSKEY_PAD5
 Keypad "Center" (5).
#define CSKEY_CONTEXT   CSKEY_SPECIAL(0x0a)
 The "Context menu" key on Windows keyboards.
#define CSKEY_CTRL   CSKEY_CTRL_NUM(csKeyModifierNumAny)
 Undistinguished Ctrl.
#define CSKEY_CTRL_FIRST   CSKEY_CTRL_NUM(0)
 Lowest code of the Ctrl modifier keys.
#define CSKEY_CTRL_LAST   CSKEY_CTRL_NUM(0x1e)
 Highest code of the Ctrl modifier keys.
#define CSKEY_CTRL_LEFT   CSKEY_CTRL_NUM(csKeyModifierNumLeft)
 Left Ctrl.
#define CSKEY_CTRL_NUM(n)   CSKEY_MODIFIER(csKeyModifierTypeCtrl,n)
 Construct a key code for the Ctrl modifier key number n.
#define CSKEY_CTRL_RIGHT   CSKEY_CTRL_NUM(csKeyModifierNumRight)
 Right Ctrl.
#define CSKEY_DEL   CSKEY_SPECIAL(0x09)
 Delete key.
#define CSKEY_DOWN   CSKEY_SPECIAL(0x01)
 Down arrow key.
#define CSKEY_END   CSKEY_SPECIAL(0x07)
 End key.
#define CSKEY_ENTER   '\n'
 Enter key.
#define CSKEY_ESC   27
 ESCape key.
#define CSKEY_F1   CSKEY_SPECIAL(0x10)
 Function key F1.
#define CSKEY_F10   CSKEY_SPECIAL(0x19)
 Function key F10.
#define CSKEY_F11   CSKEY_SPECIAL(0x1a)
 Function key F11.
#define CSKEY_F12   CSKEY_SPECIAL(0x1b)
 Function key F12.
#define CSKEY_F2   CSKEY_SPECIAL(0x11)
 Function key F2.
#define CSKEY_F3   CSKEY_SPECIAL(0x12)
 Function key F3.
#define CSKEY_F4   CSKEY_SPECIAL(0x13)
 Function key F4.
#define CSKEY_F5   CSKEY_SPECIAL(0x14)
 Function key F5.
#define CSKEY_F6   CSKEY_SPECIAL(0x15)
 Function key F6.
#define CSKEY_F7   CSKEY_SPECIAL(0x16)
 Function key F7.
#define CSKEY_F8   CSKEY_SPECIAL(0x17)
 Function key F8.
#define CSKEY_F9   CSKEY_SPECIAL(0x18)
 Function key F9.
#define CSKEY_HOME   CSKEY_SPECIAL(0x06)
 Home key.
#define CSKEY_INS   CSKEY_SPECIAL(0x08)
 Insert key.
#define CSKEY_IS_MODIFIER(rawCode)
 Helper macro to test whether a key code identifies a modifier.
#define CSKEY_IS_PAD_KEY(rawCode)   (((rawCode) & CSKEY_PAD_FLAG) != 0)
 Helper macro to test whether a key code identifies a keypad key.
#define CSKEY_IS_SPECIAL(rawCode)   ((rawCode >= CSKEY_SPECIAL_FIRST) && ((rawCode) <= CSKEY_SPECIAL_LAST))
 Helper macro to determine whether a key code identifies a special key.
#define CSKEY_LEFT   CSKEY_SPECIAL(0x02)
 Left arrow key.
#define CSKEY_MODIFIER(type, num)   CSKEY_SPECIAL(CSKEY_MODIFIER_FIRST + ((type) << CSKEY_MODIFIERTYPE_SHIFT) + (num))
 Helper macro to construct a modifiers key code.
#define CSKEY_MODIFIER_COMPARE(bitmask1, bitmask2)
 Helper macro to determine if two modifier bitmasks can be considered equal.
#define CSKEY_MODIFIER_FIRST   0x2000
 The lowest code of a modifier key.
#define CSKEY_MODIFIER_LAST   0x3fff
 The highest code of a modifier key.
#define CSKEY_MODIFIER_NUM(rawCode)
 Helper macro to determine the modifier number of a key code.
#define CSKEY_MODIFIER_TYPE(rawCode)
 Helper macro to determine the modifier type of a key code.
#define CSKEY_MODIFIERTYPE_SHIFT   5
 Undistinguished Alt.
#define CSKEY_PAD0   CSKEY_PAD_KEY('0')
 Keypad 0.
#define CSKEY_PAD1   CSKEY_PAD_KEY('1')
 Keypad 1.
#define CSKEY_PAD2   CSKEY_PAD_KEY('2')
 Keypad 2.
#define CSKEY_PAD3   CSKEY_PAD_KEY('3')
 Keypad 3.
#define CSKEY_PAD4   CSKEY_PAD_KEY('4')
 Keypad 4.
#define CSKEY_PAD5   CSKEY_PAD_KEY('5')
 Keypad 5.
#define CSKEY_PAD6   CSKEY_PAD_KEY('6')
 Keypad 6.
#define CSKEY_PAD7   CSKEY_PAD_KEY('7')
 Keypad 7.
#define CSKEY_PAD8   CSKEY_PAD_KEY('8')
 Keypad 8.
#define CSKEY_PAD9   CSKEY_PAD_KEY('9')
 Keypad 9.
#define CSKEY_PAD_FLAG   0x4000
 Bit that is set if a key is from the keypad.
#define CSKEY_PAD_KEY(code)   CSKEY_SPECIAL((unsigned int)(code) | CSKEY_PAD_FLAG)
 Helper macro to construct a keypade key code.
#define CSKEY_PAD_TO_NORMAL(rawCode)   ((rawCode) & (~CSKEY_PAD_FLAG))
 Helper macro to convert a 'pad' key code into a 'normal' special key code.
#define CSKEY_PADDECIMAL   CSKEY_PAD_KEY('.')
 Keypad Decimal ('.' on English keyboards).
#define CSKEY_PADDIV   CSKEY_PAD_KEY('/')
 Keypad Divide.
#define CSKEY_PADENTER   CSKEY_PAD_KEY('\n')
 Keypad Enter.
#define CSKEY_PADMINUS   CSKEY_PAD_KEY('-')
 Keypad Minus.
#define CSKEY_PADMULT   CSKEY_PAD_KEY('*')
 Keypad Multiply.
#define CSKEY_PADNUM   CSKEY_MODIFIER(csKeyModifierTypeNumLock,csKeyModifierNumAny) | CSKEY_PAD_FLAG
 NumLock key.
#define CSKEY_PADPLUS   CSKEY_PAD_KEY('+')
 Keypad Plus.
#define CSKEY_PAUSE   CSKEY_SPECIAL(0x0c)
 The Pause key.
#define CSKEY_PGDN   CSKEY_SPECIAL(0x05)
 PageDown key.
#define CSKEY_PGUP   CSKEY_SPECIAL(0x04)
 PageUp key.
#define CSKEY_PRINTSCREEN   CSKEY_SPECIAL(0x0b)
 The Print Screen key.
#define CSKEY_RIGHT   CSKEY_SPECIAL(0x03)
 Right arrow key.
#define CSKEY_SCROLLLOCK   CSKEY_MODIFIER(csKeyModifierTypeScrollLock,csKeyModifierNumAny)
 ScrollLock key.
#define CSKEY_SHIFT   CSKEY_SHIFT_NUM(csKeyModifierNumAny)
 Undistinguished Shift.
#define CSKEY_SHIFT_FIRST   CSKEY_SHIFT_NUM(0)
 Lowest code of the Shift modifier keys.
#define CSKEY_SHIFT_LAST   CSKEY_SHIFT_NUM(0x1e)
 Highest code of the Shift modifier keys.
#define CSKEY_SHIFT_LEFT   CSKEY_SHIFT_NUM(csKeyModifierNumLeft)
 Left Shift.
#define CSKEY_SHIFT_NUM(n)   CSKEY_MODIFIER(csKeyModifierTypeShift,n)
 Construct a key code for the Shift modifier key number n.
#define CSKEY_SHIFT_RIGHT   CSKEY_SHIFT_NUM(csKeyModifierNumRight)
 Right Shift.
#define CSKEY_SPACE   ' '
 Space key.
#define CSKEY_SPECIAL(code)   (CSKEY_SPECIAL_FIRST + (code))
 Helper macro to construct a special key code.
#define CSKEY_SPECIAL_FIRST   0x108000
 The lowest code of a special key.
#define CSKEY_SPECIAL_LAST   0x10fffd
 The highest code of a special key.
#define CSKEY_SPECIAL_NUM(rawCode)   ((rawCode) - CSKEY_SPECIAL_FIRST)
 Helper macro to determine the parameter that was given to CSKEY_SPECIAL.
#define CSKEY_TAB   '\t'
 Tab key.
#define CSKEY_UP   CSKEY_SPECIAL(0x00)
 Up arrow key.
typedef enum _csKeyCharType csKeyCharType
 Character types.
enum  _csKeyCharType { csKeyCharTypeNormal = 0, csKeyCharTypeDead }
 Character types. More...

Modifier key masks

csKeyEventHelper::GetModifiersBits() returns such a bitfields consisting of any combination of the masks below. Having one in one of the bits means that the corresponding modifier was pressed in the modifier state passed in.

#define CSMASK_ALLMODIFIERS
 All modifiers, shift and lock types.
#define CSMASK_ALLSHIFTS   (CSMASK_SHIFT | CSMASK_CTRL | CSMASK_ALT)
 All shift keys.
#define CSMASK_ALT   (1 << csKeyModifierTypeAlt)
 "Alt" key mask
#define CSMASK_CAPSLOCK   (1 << csKeyModifierTypeCapsLock)
 "CapsLock" key mask
#define CSMASK_CTRL   (1 << csKeyModifierTypeCtrl)
 "Ctrl" key mask
#define CSMASK_NUMLOCK   (1 << csKeyModifierTypeNumLock)
 "NumLock" key mask
#define CSMASK_SCROLLLOCK   (1 << csKeyModifierTypeScrollLock)
 "ScrollLock" key mask
#define CSMASK_SHIFT   (1 << csKeyModifierTypeShift)
 "Shift" key mask

Modifier keys

See also:
Keyboard events, Modifier key masks


typedef enum _csKeyModifierNumType csKeyModifierNumType
 Modifier numbers.
typedef _csKeyModifiers csKeyModifiers
 Flags for all currently pressed modifiers.
typedef enum _csKeyModifierType csKeyModifierType
 Modifier types.
enum  _csKeyModifierNumType { csKeyModifierNumLeft = 0, csKeyModifierNumRight, csKeyModifierNumAny = 0x1f }
 Modifier numbers. More...
enum  _csKeyModifierType {
  csKeyModifierTypeShift = 0, csKeyModifierTypeCtrl, csKeyModifierTypeAlt, csKeyModifierTypeCapsLock,
  csKeyModifierTypeNumLock, csKeyModifierTypeScrollLock
}
 Modifier types. More...

Typedefs

typedef enum _csCommandEventCode csCommandEventCode
 General Command Codes.
typedef enum _csEventType csEventType
 System Events.
typedef enum _csKeyEventType csKeyEventType
 Keyboard event type.

Enumerations

enum  _csCommandEventCode {
  cscmdNothing = 0, cscmdQuit, cscmdFocusChanged, cscmdSystemOpen,
  cscmdSystemClose, cscmdContextResize, cscmdContextClose, cscmdCommandLineHelp,
  cscmdPreProcess, cscmdProcess, cscmdPostProcess, cscmdFinalProcess,
  cscmdCanvasHidden, cscmdCanvasExposed
}
 General Command Codes. More...
enum  _csEventType {
  csevNothing = 0, csevKeyboard, csevMouseMove, csevMouseDown,
  csevMouseUp, csevMouseClick, csevMouseDoubleClick, csevJoystickMove,
  csevJoystickDown, csevJoystickUp, csevCommand, csevBroadcast,
  csevMouseEnter, csevMouseExit, csevLostFocus, csevGainFocus,
  csevGroupOff, csevFrameStart
}
 System Events. More...
enum  _csKeyEventType { csKeyEventTypeUp = 0, csKeyEventTypeDown }
 Keyboard event type. More...


Detailed Description

Event system related interfaces.

Definition in file evdefs.h.


Define Documentation

#define CS_IS_BROADCAST_EVENT  )     ((1 << (e).Type) & CSMASK_Broadcast)
 

Check if a event is a broadcast event.

Definition at line 154 of file evdefs.h.

#define CS_IS_COMMAND_EVENT  )     ((1 << (e).Type) & CSMASK_Command)
 

Check if a event is a command event.

Definition at line 156 of file evdefs.h.

#define CS_IS_INPUT_EVENT  )     ((1 << (e).Type) & CSMASK_Input)
 

Check if a event is any input event.

Definition at line 164 of file evdefs.h.

#define CS_IS_JOYSTICK_EVENT  )     ((1 << (e).Type) & CSMASK_Joystick)
 

Check if a event is a joystick event.

Definition at line 162 of file evdefs.h.

#define CS_IS_KEYBOARD_EVENT  )     ((1 << (e).Type) & CSMASK_Keyboard)
 

Check if a event is a keyboard event.

Definition at line 158 of file evdefs.h.

#define CS_IS_MOUSE_EVENT  )     ((1 << (e).Type) & CSMASK_Mouse)
 

Check if a event is a mouse event.

Definition at line 160 of file evdefs.h.

#define CSEF_BROADCAST   0x00000001
 

Event flag: Ignore `true' returned from HandleEvent which says that event has been processed and should not be processed anymore.

Normally this is set only for csevBroadcast events.

Definition at line 177 of file evdefs.h.

#define CSEVTYPE_Joystick   0x00000004
 

Joystick events.

Definition at line 511 of file evdefs.h.

#define CSEVTYPE_Keyboard   0x00000001
 

Keyboard events.

Definition at line 507 of file evdefs.h.

Referenced by csGraphics2DGLCommon::GetPotentiallyConflictingEvents().

#define CSEVTYPE_Mouse   0x00000002
 

Mouse events.

Definition at line 509 of file evdefs.h.

Referenced by csGraphics2DGLCommon::GetPotentiallyConflictingEvents().

#define CSKEY_ALT   CSKEY_ALT_NUM(csKeyModifierNumAny)
 

Undistinguished Alt.

Definition at line 426 of file evdefs.h.

#define CSKEY_ALT_FIRST   CSKEY_ALT_NUM(0)
 

Lowest code of the Alt modifier keys.

Definition at line 417 of file evdefs.h.

#define CSKEY_ALT_LAST   CSKEY_ALT_NUM(0x1e)
 

Highest code of the Alt modifier keys.

Definition at line 419 of file evdefs.h.

#define CSKEY_ALT_LEFT   CSKEY_ALT_NUM(csKeyModifierNumLeft)
 

Left Alt.

Definition at line 422 of file evdefs.h.

#define CSKEY_ALT_NUM  )     CSKEY_MODIFIER(csKeyModifierTypeAlt,n)
 

Construct a key code for the Alt modifier key number n.

Definition at line 415 of file evdefs.h.

#define CSKEY_ALT_RIGHT   CSKEY_ALT_NUM(csKeyModifierNumRight)
 

Right Alt.

Definition at line 424 of file evdefs.h.

#define CSKEY_BACKSPACE   '\b'
 

Back-space key.

Definition at line 287 of file evdefs.h.

#define CSKEY_CAPSLOCK   CSKEY_MODIFIER(csKeyModifierTypeCapsLock,csKeyModifierNumAny)
 

CapsLock key.

Definition at line 482 of file evdefs.h.

#define CSKEY_CENTER   CSKEY_PAD5
 

Keypad "Center" (5).

Definition at line 451 of file evdefs.h.

#define CSKEY_CONTEXT   CSKEY_SPECIAL(0x0a)
 

The "Context menu" key on Windows keyboards.

Definition at line 324 of file evdefs.h.

#define CSKEY_CTRL   CSKEY_CTRL_NUM(csKeyModifierNumAny)
 

Undistinguished Ctrl.

Definition at line 412 of file evdefs.h.

#define CSKEY_CTRL_FIRST   CSKEY_CTRL_NUM(0)
 

Lowest code of the Ctrl modifier keys.

Definition at line 403 of file evdefs.h.

#define CSKEY_CTRL_LAST   CSKEY_CTRL_NUM(0x1e)
 

Highest code of the Ctrl modifier keys.

Definition at line 405 of file evdefs.h.

#define CSKEY_CTRL_LEFT   CSKEY_CTRL_NUM(csKeyModifierNumLeft)
 

Left Ctrl.

Definition at line 408 of file evdefs.h.

#define CSKEY_CTRL_NUM  )     CSKEY_MODIFIER(csKeyModifierTypeCtrl,n)
 

Construct a key code for the Ctrl modifier key number n.

Definition at line 401 of file evdefs.h.

#define CSKEY_CTRL_RIGHT   CSKEY_CTRL_NUM(csKeyModifierNumRight)
 

Right Ctrl.

Definition at line 410 of file evdefs.h.

#define CSKEY_DEL   CSKEY_SPECIAL(0x09)
 

Delete key.

Definition at line 322 of file evdefs.h.

#define CSKEY_DOWN   CSKEY_SPECIAL(0x01)
 

Down arrow key.

Definition at line 306 of file evdefs.h.

#define CSKEY_END   CSKEY_SPECIAL(0x07)
 

End key.

Definition at line 318 of file evdefs.h.

#define CSKEY_ENTER   '\n'
 

Enter key.

Definition at line 283 of file evdefs.h.

#define CSKEY_ESC   27
 

ESCape key.

Definition at line 281 of file evdefs.h.

#define CSKEY_F1   CSKEY_SPECIAL(0x10)
 

Function key F1.

Definition at line 330 of file evdefs.h.

#define CSKEY_F10   CSKEY_SPECIAL(0x19)
 

Function key F10.

Definition at line 348 of file evdefs.h.

#define CSKEY_F11   CSKEY_SPECIAL(0x1a)
 

Function key F11.

Definition at line 350 of file evdefs.h.

#define CSKEY_F12   CSKEY_SPECIAL(0x1b)
 

Function key F12.

Definition at line 352 of file evdefs.h.

#define CSKEY_F2   CSKEY_SPECIAL(0x11)
 

Function key F2.

Definition at line 332 of file evdefs.h.

#define CSKEY_F3   CSKEY_SPECIAL(0x12)
 

Function key F3.

Definition at line 334 of file evdefs.h.

#define CSKEY_F4   CSKEY_SPECIAL(0x13)
 

Function key F4.

Definition at line 336 of file evdefs.h.

#define CSKEY_F5   CSKEY_SPECIAL(0x14)
 

Function key F5.

Definition at line 338 of file evdefs.h.

#define CSKEY_F6   CSKEY_SPECIAL(0x15)
 

Function key F6.

Definition at line 340 of file evdefs.h.

#define CSKEY_F7   CSKEY_SPECIAL(0x16)
 

Function key F7.

Definition at line 342 of file evdefs.h.

#define CSKEY_F8   CSKEY_SPECIAL(0x17)
 

Function key F8.

Definition at line 344 of file evdefs.h.

#define CSKEY_F9   CSKEY_SPECIAL(0x18)
 

Function key F9.

Definition at line 346 of file evdefs.h.

#define CSKEY_HOME   CSKEY_SPECIAL(0x06)
 

Home key.

Definition at line 316 of file evdefs.h.

#define CSKEY_INS   CSKEY_SPECIAL(0x08)
 

Insert key.

Definition at line 320 of file evdefs.h.

#define CSKEY_IS_MODIFIER rawCode   ) 
 

Value:

Helper macro to test whether a key code identifies a modifier.

Definition at line 367 of file evdefs.h.

#define CSKEY_IS_PAD_KEY rawCode   )     (((rawCode) & CSKEY_PAD_FLAG) != 0)
 

Helper macro to test whether a key code identifies a keypad key.

Definition at line 434 of file evdefs.h.

#define CSKEY_IS_SPECIAL rawCode   )     ((rawCode >= CSKEY_SPECIAL_FIRST) && ((rawCode) <= CSKEY_SPECIAL_LAST))
 

Helper macro to determine whether a key code identifies a special key.

Definition at line 298 of file evdefs.h.

#define CSKEY_LEFT   CSKEY_SPECIAL(0x02)
 

Left arrow key.

Definition at line 308 of file evdefs.h.

#define CSKEY_MODIFIER type,
num   )     CSKEY_SPECIAL(CSKEY_MODIFIER_FIRST + ((type) << CSKEY_MODIFIERTYPE_SHIFT) + (num))
 

Helper macro to construct a modifiers key code.

Definition at line 364 of file evdefs.h.

#define CSKEY_MODIFIER_COMPARE bitmask1,
bitmask2   ) 
 

Value:

((bitmask1) == (bitmask2)                                                    \
|| ((bitmask1) == (unsigned)(1 << csKeyModifierNumAny) && (bitmask2) != 0)   \
|| ((bitmask2) == (unsigned)(1 << csKeyModifierNumAny) && (bitmask1) != 0))
Helper macro to determine if two modifier bitmasks can be considered equal.

Definition at line 381 of file evdefs.h.

#define CSKEY_MODIFIER_FIRST   0x2000
 

The lowest code of a modifier key.

Definition at line 355 of file evdefs.h.

#define CSKEY_MODIFIER_LAST   0x3fff
 

The highest code of a modifier key.

Definition at line 357 of file evdefs.h.

#define CSKEY_MODIFIER_NUM rawCode   ) 
 

Value:

Helper macro to determine the modifier number of a key code.

Definition at line 376 of file evdefs.h.

#define CSKEY_MODIFIER_TYPE rawCode   ) 
 

Value:

Helper macro to determine the modifier type of a key code.

Definition at line 372 of file evdefs.h.

#define CSKEY_MODIFIERTYPE_SHIFT   5
 

Undistinguished Alt.

Definition at line 362 of file evdefs.h.

#define CSKEY_PAD0   CSKEY_PAD_KEY('0')
 

Keypad 0.

Definition at line 461 of file evdefs.h.

#define CSKEY_PAD1   CSKEY_PAD_KEY('1')
 

Keypad 1.

Definition at line 441 of file evdefs.h.

#define CSKEY_PAD2   CSKEY_PAD_KEY('2')
 

Keypad 2.

Definition at line 443 of file evdefs.h.

#define CSKEY_PAD3   CSKEY_PAD_KEY('3')
 

Keypad 3.

Definition at line 445 of file evdefs.h.

#define CSKEY_PAD4   CSKEY_PAD_KEY('4')
 

Keypad 4.

Definition at line 447 of file evdefs.h.

#define CSKEY_PAD5   CSKEY_PAD_KEY('5')
 

Keypad 5.

Definition at line 449 of file evdefs.h.

#define CSKEY_PAD6   CSKEY_PAD_KEY('6')
 

Keypad 6.

Definition at line 453 of file evdefs.h.

#define CSKEY_PAD7   CSKEY_PAD_KEY('7')
 

Keypad 7.

Definition at line 455 of file evdefs.h.

#define CSKEY_PAD8   CSKEY_PAD_KEY('8')
 

Keypad 8.

Definition at line 457 of file evdefs.h.

#define CSKEY_PAD9   CSKEY_PAD_KEY('9')
 

Keypad 9.

Definition at line 459 of file evdefs.h.

#define CSKEY_PAD_FLAG   0x4000
 

Bit that is set if a key is from the keypad.

Definition at line 429 of file evdefs.h.

#define CSKEY_PAD_KEY code   )     CSKEY_SPECIAL((unsigned int)(code) | CSKEY_PAD_FLAG)
 

Helper macro to construct a keypade key code.

Definition at line 431 of file evdefs.h.

#define CSKEY_PAD_TO_NORMAL rawCode   )     ((rawCode) & (~CSKEY_PAD_FLAG))
 

Helper macro to convert a 'pad' key code into a 'normal' special key code.

Definition at line 438 of file evdefs.h.

#define CSKEY_PADDECIMAL   CSKEY_PAD_KEY('.')
 

Keypad Decimal ('.' on English keyboards).

Definition at line 463 of file evdefs.h.

#define CSKEY_PADDIV   CSKEY_PAD_KEY('/')
 

Keypad Divide.

Definition at line 465 of file evdefs.h.

#define CSKEY_PADENTER   CSKEY_PAD_KEY('\n')
 

Keypad Enter.

Definition at line 473 of file evdefs.h.

#define CSKEY_PADMINUS   CSKEY_PAD_KEY('-')
 

Keypad Minus.

Definition at line 469 of file evdefs.h.

#define CSKEY_PADMULT   CSKEY_PAD_KEY('*')
 

Keypad Multiply.

Definition at line 467 of file evdefs.h.

#define CSKEY_PADNUM   CSKEY_MODIFIER(csKeyModifierTypeNumLock,csKeyModifierNumAny) | CSKEY_PAD_FLAG
 

NumLock key.

Both a modifier and a keypad key.

Definition at line 479 of file evdefs.h.

#define CSKEY_PADPLUS   CSKEY_PAD_KEY('+')
 

Keypad Plus.

Definition at line 471 of file evdefs.h.

#define CSKEY_PAUSE   CSKEY_SPECIAL(0x0c)
 

The Pause key.

Definition at line 328 of file evdefs.h.

#define CSKEY_PGDN   CSKEY_SPECIAL(0x05)
 

PageDown key.

Definition at line 314 of file evdefs.h.

#define CSKEY_PGUP   CSKEY_SPECIAL(0x04)
 

PageUp key.

Definition at line 312 of file evdefs.h.

#define CSKEY_PRINTSCREEN   CSKEY_SPECIAL(0x0b)
 

The Print Screen key.

Definition at line 326 of file evdefs.h.

#define CSKEY_RIGHT   CSKEY_SPECIAL(0x03)
 

Right arrow key.

Definition at line 310 of file evdefs.h.

#define CSKEY_SCROLLLOCK   CSKEY_MODIFIER(csKeyModifierTypeScrollLock,csKeyModifierNumAny)
 

ScrollLock key.

Definition at line 485 of file evdefs.h.

#define CSKEY_SHIFT   CSKEY_SHIFT_NUM(csKeyModifierNumAny)
 

Undistinguished Shift.

Definition at line 398 of file evdefs.h.

#define CSKEY_SHIFT_FIRST   CSKEY_SHIFT_NUM(0)
 

Lowest code of the Shift modifier keys.

Definition at line 389 of file evdefs.h.

#define CSKEY_SHIFT_LAST   CSKEY_SHIFT_NUM(0x1e)
 

Highest code of the Shift modifier keys.

Definition at line 391 of file evdefs.h.

#define CSKEY_SHIFT_LEFT   CSKEY_SHIFT_NUM(csKeyModifierNumLeft)
 

Left Shift.

Definition at line 394 of file evdefs.h.

#define CSKEY_SHIFT_NUM  )     CSKEY_MODIFIER(csKeyModifierTypeShift,n)
 

Construct a key code for the Shift modifier key number n.

Definition at line 387 of file evdefs.h.

#define CSKEY_SHIFT_RIGHT   CSKEY_SHIFT_NUM(csKeyModifierNumRight)
 

Right Shift.

Definition at line 396 of file evdefs.h.

#define CSKEY_SPACE   ' '
 

Space key.

Definition at line 289 of file evdefs.h.

#define CSKEY_SPECIAL code   )     (CSKEY_SPECIAL_FIRST + (code))
 

Helper macro to construct a special key code.

Definition at line 296 of file evdefs.h.

#define CSKEY_SPECIAL_FIRST   0x108000
 

The lowest code of a special key.

Definition at line 292 of file evdefs.h.

#define CSKEY_SPECIAL_LAST   0x10fffd
 

The highest code of a special key.

Definition at line 294 of file evdefs.h.

#define CSKEY_SPECIAL_NUM rawCode   )     ((rawCode) - CSKEY_SPECIAL_FIRST)
 

Helper macro to determine the parameter that was given to CSKEY_SPECIAL.

Definition at line 301 of file evdefs.h.

#define CSKEY_TAB   '\t'
 

Tab key.

Definition at line 285 of file evdefs.h.

#define CSKEY_UP   CSKEY_SPECIAL(0x00)
 

Up arrow key.

Definition at line 304 of file evdefs.h.

#define CSMASK_ALLMODIFIERS
 

Value:

All modifiers, shift and lock types.

Definition at line 265 of file evdefs.h.

#define CSMASK_ALLSHIFTS   (CSMASK_SHIFT | CSMASK_CTRL | CSMASK_ALT)
 

All shift keys.

Definition at line 256 of file evdefs.h.

#define CSMASK_ALT   (1 << csKeyModifierTypeAlt)
 

"Alt" key mask

Definition at line 254 of file evdefs.h.

#define CSMASK_Broadcast   (1 << csevBroadcast)
 

Broadcast message events.

Definition at line 139 of file evdefs.h.

#define CSMASK_CAPSLOCK   (1 << csKeyModifierTypeCapsLock)
 

"CapsLock" key mask

Definition at line 259 of file evdefs.h.

#define CSMASK_Command   (1 << csevCommand)
 

Command message events.

Definition at line 137 of file evdefs.h.

#define CSMASK_CTRL   (1 << csKeyModifierTypeCtrl)
 

"Ctrl" key mask

Definition at line 252 of file evdefs.h.

#define CSMASK_FrameProcess   CSMASK_Nothing
 

The plugin will be called at the start of every frame and at the end of every frame with an csevBroadcast event with the Event.Retrieve("cmdCode") equal to cscmdPreProcess, csProcess, cscmdPostProcess, or cscmdFinalProcess.

Definition at line 117 of file evdefs.h.

#define CSMASK_Input   (CSMASK_Keyboard | CSMASK_Mouse | CSMASK_Joystick)
 

This mask identifies any input evemt.

Definition at line 149 of file evdefs.h.

#define CSMASK_Joystick   (CSMASK_JoystickMove | CSMASK_JoystickDown | CSMASK_JoystickUp)
 

This mask identifies any joystick event.

Definition at line 146 of file evdefs.h.

#define CSMASK_JoystickDown   (1 << csevJoystickDown)
 

Joystick button down events.

Definition at line 133 of file evdefs.h.

#define CSMASK_JoystickMove   (1 << csevJoystickMove)
 

Joystick movement events.

Definition at line 131 of file evdefs.h.

#define CSMASK_JoystickUp   (1 << csevJoystickUp)
 

Joystick button up events.

Definition at line 135 of file evdefs.h.

#define CSMASK_Keyboard   (1 << csevKeyboard)
 

Keyboard events.

Definition at line 119 of file evdefs.h.

#define CSMASK_Mouse
 

Value:

This mask identifies any mouse event.

Definition at line 142 of file evdefs.h.

#define CSMASK_MouseClick   (1 << csevMouseClick)
 

Mouse click events.

Definition at line 127 of file evdefs.h.

#define CSMASK_MouseDoubleClick   (1 << csevMouseDoubleClick)
 

Mouse double click events.

Definition at line 129 of file evdefs.h.

#define CSMASK_MouseDown   (1 << csevMouseDown)
 

Mouse down events.

Definition at line 123 of file evdefs.h.

#define CSMASK_MouseMove   (1 << csevMouseMove)
 

Mouse move events.

Definition at line 121 of file evdefs.h.

#define CSMASK_MouseUp   (1 << csevMouseUp)
 

Mouse up events.

Definition at line 125 of file evdefs.h.

#define CSMASK_Nothing   (1 << csevNothing)
 

Event mask: Empty event.

If a plugin registers to receive this kind of events via iEventQueue::RegisterListener(plugin, CSMASK_Nothing) this has a special meaning: the plugin will be called at the start of every frame and at the end of every frame with an csevBroadcast event with the Event.Retrieve("cmdCode") equal to either cscmdPreProcess or cscmdPostProcess.

Definition at line 111 of file evdefs.h.

#define CSMASK_NUMLOCK   (1 << csKeyModifierTypeNumLock)
 

"NumLock" key mask

Definition at line 261 of file evdefs.h.

#define CSMASK_SCROLLLOCK   (1 << csKeyModifierTypeScrollLock)
 

"ScrollLock" key mask

Definition at line 263 of file evdefs.h.

#define CSMASK_SHIFT   (1 << csKeyModifierTypeShift)
 

"Shift" key mask

Definition at line 250 of file evdefs.h.


Typedef Documentation

typedef enum _csCommandEventCode csCommandEventCode
 

General Command Codes.

The list below does not contain all defined command codes; these are only the most general ones.

Third-party applications should use command codes greater than these standard code, for example:

 enum
 {
   cscmdMyCommand1 = 0x10000000,
   cscmdMyCommand2,
   cscmdMyCommand3
   ...
 }

typedef enum _csKeyCharType csKeyCharType
 

Character types.

typedef enum _csKeyModifierNumType csKeyModifierNumType
 

Modifier numbers.

typedef struct _csKeyModifiers csKeyModifiers
 

Flags for all currently pressed modifiers.

typedef enum _csKeyModifierType csKeyModifierType
 

Modifier types.


Enumeration Type Documentation

enum _csCommandEventCode
 

General Command Codes.

The list below does not contain all defined command codes; these are only the most general ones.

Third-party applications should use command codes greater than these standard code, for example:

 enum
 {
   cscmdMyCommand1 = 0x10000000,
   cscmdMyCommand2,
   cscmdMyCommand3
   ...
 }
Enumerator:
cscmdNothing  No command.

Dunno really why it is needed but traditionally 0 stands for nothing.

cscmdQuit  The event below causes system driver to quit the event loop, even if the event loop has been entered multiple times.

The quit condition is never reset thus even if you call Loop again, the system driver will quit immediately. Such broadcasts are posted for irreversible finalization of the application such as when user closes the application window.

cscmdFocusChanged  Application has changed its "focused" status.

This event is generated whenever user application receives/loses focus (that is, when the application itself activates or deactivates). Upon this event the application may react correspondingly - stop music, hide software mouse cursor and so on. iEnable = true in the event application receives focus and false if it loses focus.

 Info: NULL -> window lose focus, non-NULL -> window got focus
 
cscmdSystemOpen  This event is broadcasted to all event listeners just after all modules have been initialized.
cscmdSystemClose  This event is broadcasted to all event listeners just before modules are about to be shutdown and unloaded (that is, the system is shutting down).
cscmdContextResize  This event is generated when user resizes the application window.

The argument points to the graphics context that has been resized.

 Info: (iGraphics2D *) The context that has been resized
 
cscmdContextClose  This event is sent when a graphics context is being destroyed.

Usually this event is accompanyed by a shutdown but there is one exception: when a dynamic texture is closed (a dynamic texture is a graphics context as well).

 Info: (iGraphics2D *) The context that has been closed
 
cscmdCommandLineHelp  This event is broadcasted when system driver displays the help text for all supported command-line switches.

Upon reception of such event every plugin should display a short help for any of the command-line switches it supports. The general format is:

<2 spaces><switch - 18 positions><space>
<switch description>{default value}
The help should be displayed to standard output.
cscmdPreProcess  Broadcasted before cscmdProcess -- on every frame -- as Event.Retrieve("cmdCode") of a broadcast event.

Use the event mask CSMASK_FrameProcess to receive this pseudo-event.

cscmdProcess  Broadcasted every frame as Event.Retrieve("cmdCode") of a broadcast event.

Use the event mask CSMASK_FrameProcess to receive this pseudo-event.

cscmdPostProcess  Broadcasted after cscmdProcess -- on every frame -- as Event.Retrieve("cmdCode") of a broadcast event.

Use the event mask CSMASK_FrameProcess to receive this pseudo-event.

cscmdFinalProcess  Broadcasted after cscmdPostProcess -- on every frame -- as Event.Retrieve("cmdCode") of a broadcast event.

Use the event mask CSMASK_FrameProcess to receive this pseudo-event.

cscmdCanvasHidden  Broadcast indicating that the display canvas is not currently visible to the user (such as being iconified).
cscmdCanvasExposed  Broadcast indicating that the display canvas has just become visible (such as being uniconified).

Definition at line 531 of file evdefs.h.

enum _csKeyCharType
 

Character types.

Enumerator:
csKeyCharTypeNormal  Normal character.
csKeyCharTypeDead  "Dead" character

Definition at line 489 of file evdefs.h.

enum _csKeyModifierNumType
 

Modifier numbers.

Enumerator:
csKeyModifierNumLeft  The default number for a 'left' version of a key.
csKeyModifierNumRight  The default number for a 'right' version of a key.
csKeyModifierNumAny  'Magic' modifier number used if there shouldn't be distinguished between multiple modifier keys of the same type.

Definition at line 206 of file evdefs.h.

enum _csKeyModifierType
 

Modifier types.

Enumerator:
csKeyModifierTypeShift  'Shift' is held
csKeyModifierTypeCtrl  'Ctrl' is held
csKeyModifierTypeAlt  'Alt' is held
csKeyModifierTypeCapsLock  'CapsLock' is toggled
csKeyModifierTypeNumLock  'NumLock' is toggled
csKeyModifierTypeScrollLock  'ScrollLock' is toggled

Definition at line 184 of file evdefs.h.


Generated for Crystal Space by doxygen 1.4.4