Header for the key binding functions. More...

Enumerations
enum	KeyType { KEY_NONE, KEY_UP, KEY_DOWN, KEY_RIGHT, KEY_LEFT, KEY_ESC, KEY_ENTER, KEY_NEXT, KEY_NEXTSTACK, KEY_PREV, KEY_PREVSTACK, KEY_CLOSE, KEY_MIN, KEY_MAX, KEY_SHADE, KEY_STICK, KEY_MOVE, KEY_RESIZE, KEY_ROOT, KEY_WIN, KEY_DESKTOP, KEY_RDESKTOP, KEY_LDESKTOP, KEY_UDESKTOP, KEY_DDESKTOP, KEY_SHOWDESK, KEY_SHOWTRAY, KEY_EXEC, KEY_RESTART, KEY_EXIT, KEY_FULLSCREEN }
	Enumeration of key binding types. More...
Functions
void	InitializeKeys ()
void	StartupKeys ()
void	ShutdownKeys ()
void	DestroyKeys ()
KeyType	GetKey (const XKeyEvent *event)
	Get the action to take from a key event.
void	GrabKeys (struct ClientNode *np)
	Grab keys on a client window.
void	InsertBinding (KeyType key, const char modifiers, const char stroke, const char code, const char command)
	Insert a key binding.
void	RunKeyCommand (const XKeyEvent *event)
	Run a command caused by a key binding.
void	ShowKeyMenu (const XKeyEvent *event)
	Show a root menu caused by a key binding.
void	ValidateKeys ()
	Validate key bindings.

Detailed Description

Header for the key binding functions.

Definition in file key.h.

Enumeration Type Documentation

Enumeration of key binding types.

Enumerator:

Definition at line 16 of file key.h.

void DestroyKeys ( )

KeyType GetKey ( const XKeyEvent * event )

Get the action to take from a key event.

Parameters:

event The event.

void GrabKeys ( struct ClientNode * np )

Grab keys on a client window.

Parameters:

np	The client.

void InitializeKeys ( )

Insert a key binding.

Parameters:

key	The key binding type.
modifiers	The modifier mask.
stroke	The key stroke (not needed if code given).
code	The key code (not needed if stroke given).
command	Extra parameter needed for some key binding types.

void RunKeyCommand ( const XKeyEvent * event )

Run a command caused by a key binding.

Parameters:

event The event causing the command to be run.

void ShowKeyMenu ( const XKeyEvent * event )

Show a root menu caused by a key binding.

Parameters:

event The event that caused the menu to be shown.

void ShutdownKeys ( )

void StartupKeys ( )

void ValidateKeys ( )

Validate key bindings.

This will log an error if an invalid key binding is found. This is called after parsing the configuration file.