Keys

Enumerations
enum	GSM_KeyCode {   GSM_KEY_NONE = 0x00, GSM_KEY_1 = 0x01, GSM_KEY_2, GSM_KEY_3,   GSM_KEY_4, GSM_KEY_5, GSM_KEY_6, GSM_KEY_7,   GSM_KEY_8, GSM_KEY_9, GSM_KEY_0, GSM_KEY_HASH,   GSM_KEY_ASTERISK, GSM_KEY_POWER, GSM_KEY_GREEN, GSM_KEY_RED,   GSM_KEY_INCREASEVOLUME, GSM_KEY_DECREASEVOLUME, GSM_KEY_UP = 0x17, GSM_KEY_DOWN,   GSM_KEY_MENU, GSM_KEY_NAMES, GSM_KEY_LEFT, GSM_KEY_RIGHT,   GSM_KEY_SOFT1, GSM_KEY_SOFT2, GSM_KEY_HEADSET, GSM_KEY_JOYSTICK,   GSM_KEY_CAMERA, GSM_KEY_MEDIA, GSM_KEY_DESKTOP, GSM_KEY_OPERATOR,   GSM_KEY_RETURN, GSM_KEY_CLEAR }
Functions
GSM_Error	MakeKeySequence (char *text, GSM_KeyCode *KeyCode, size_t *Length)
GSM_Error	GSM_PressKey (GSM_StateMachine *s, GSM_KeyCode Key, bool Press)

---

Detailed Description

Keyboard manipulations.

---

Enumeration Type Documentation

enum GSM_KeyCode

Key event identifiers.

Enumerator:

GSM_KEY_NONE
GSM_KEY_1
GSM_KEY_2
GSM_KEY_3
GSM_KEY_4
GSM_KEY_5
GSM_KEY_6
GSM_KEY_7
GSM_KEY_8
GSM_KEY_9
GSM_KEY_0
GSM_KEY_HASH	#
GSM_KEY_ASTERISK	*
GSM_KEY_POWER	Power key.
GSM_KEY_GREEN	in some phone ie. N5110 sometimes works identical to POWER
GSM_KEY_RED	(c) key in some phone: ie. N5110
GSM_KEY_INCREASEVOLUME	Not available in some phones as separate button: ie. N5110
GSM_KEY_DECREASEVOLUME	Not available in some phones as separate button: ie. N5110
GSM_KEY_UP
GSM_KEY_DOWN
GSM_KEY_MENU
GSM_KEY_NAMES	Not available in some phone: ie. N5110
GSM_KEY_LEFT	Left arrow
GSM_KEY_RIGHT	Right arrow
GSM_KEY_SOFT1	Software key which has assigned mening on display.
GSM_KEY_SOFT2	Software key which has assigned mening on display.
GSM_KEY_HEADSET	Button on headset
GSM_KEY_JOYSTICK	Joystick pressed
GSM_KEY_CAMERA	Camera button pressed
GSM_KEY_MEDIA	Media player button
GSM_KEY_DESKTOP	Multi function key, desktop
GSM_KEY_OPERATOR	Operator button
GSM_KEY_RETURN	Return button
GSM_KEY_CLEAR	Clear button

Definition at line 24 of file gammu-keys.h.

             {
        GSM_KEY_NONE = 0x00,
        GSM_KEY_1 = 0x01,
        GSM_KEY_2,
        GSM_KEY_3,
        GSM_KEY_4,
        GSM_KEY_5,
        GSM_KEY_6,
        GSM_KEY_7,
        GSM_KEY_8,
        GSM_KEY_9,
        GSM_KEY_0,
        GSM_KEY_HASH,
        GSM_KEY_ASTERISK,
        GSM_KEY_POWER,
        GSM_KEY_GREEN,
        GSM_KEY_RED,
        GSM_KEY_INCREASEVOLUME,
        GSM_KEY_DECREASEVOLUME,
        GSM_KEY_UP = 0x17,
        GSM_KEY_DOWN,
        GSM_KEY_MENU,
        GSM_KEY_NAMES,
        GSM_KEY_LEFT,
        GSM_KEY_RIGHT,
        GSM_KEY_SOFT1,
        GSM_KEY_SOFT2,
        GSM_KEY_HEADSET,
        GSM_KEY_JOYSTICK,
        GSM_KEY_CAMERA,
        GSM_KEY_MEDIA,
        GSM_KEY_DESKTOP,
        GSM_KEY_OPERATOR,
        GSM_KEY_RETURN,
        GSM_KEY_CLEAR,
} GSM_KeyCode;

---

Function Documentation

GSM_Error GSM_PressKey	(	GSM_StateMachine *	s,
		GSM_KeyCode	Key,
		bool	Press
	)

Emulates key press or key release.

GSM_Error MakeKeySequence	(	char *	text,
		GSM_KeyCode *	KeyCode,
		size_t *	Length
	)

Creates key sequence from string.

Parameters:

	text	Text to convert.
	KeyCode	Storage for key codes.
	Length	Storage for resulting length.

Returns:

Error code.