core/vgui/vgui_key.h File Reference

Enumeration of possible key strokes. More...

#include <vcl_iosfwd.h>

Go to the source code of this file.

Enumerations
enum	vgui_key {   vgui_KEY_NULL = 0, vgui_ESC = 27, vgui_ESCAPE = 27, vgui_TAB = '\t',   vgui_RETURN = '\r', vgui_NEWLINE = '\n', vgui_KEY_XXX = 0x100, vgui_F1,   vgui_F2, vgui_F3, vgui_F4, vgui_F5,   vgui_F6, vgui_F7, vgui_F8, vgui_F9,   vgui_F10, vgui_F11, vgui_F12, vgui_CURSOR_LEFT,   vgui_CURSOR_UP, vgui_CURSOR_RIGHT, vgui_CURSOR_DOWN, vgui_PAGE_UP,   vgui_PGUP = vgui_PAGE_UP, vgui_PAGE_DOWN, vgui_PGDN = vgui_PAGE_DOWN, vgui_HOME,   vgui_END, vgui_DELETE, vgui_INSERT }
	Enumeration of possible key strokes. More...
Functions
vgui_key	vgui_key_CTRL (int character)
	Given a letter character, this function returns the control character.
vcl_ostream &	operator<< (vcl_ostream &s, vgui_key k)

---

Detailed Description

Enumeration of possible key strokes.

Definition in file vgui_key.h.

---

Enumeration Type Documentation

enum vgui_key

Enumeration of possible key strokes.

Enumerator:

vgui_KEY_NULL
vgui_ESC
vgui_ESCAPE
vgui_TAB
vgui_RETURN
vgui_NEWLINE
vgui_KEY_XXX
vgui_F1
vgui_F2
vgui_F3
vgui_F4
vgui_F5
vgui_F6
vgui_F7
vgui_F8
vgui_F9
vgui_F10
vgui_F11
vgui_F12
vgui_CURSOR_LEFT
vgui_CURSOR_UP
vgui_CURSOR_RIGHT
vgui_CURSOR_DOWN
vgui_PAGE_UP
vgui_PGUP
vgui_PAGE_DOWN
vgui_PGDN
vgui_HOME
vgui_END
vgui_DELETE
vgui_INSERT

Definition at line 14 of file vgui_key.h.

---

Function Documentation

vcl_ostream& operator<<	(	vcl_ostream &	s,
		vgui_key	k
	)

Definition at line 22 of file vgui_key.cxx.

vgui_key vgui_key_CTRL

(

int

character

)

Given a letter character, this function returns the control character.

Use vgui_key_CTRL('a') or vgui_key_CTRL('A') to signify control+A. Note, the vgui_key in a vgui_event is always a lower case letter (see vgui_event.h), so don't compare event.key to a vgui_key_CTRL'ed letter. You may compare a vgui_key_CTRL'ed to an event.ascii_key.

Definition at line 13 of file vgui_key.cxx.