Documentation de la bibliothèque MLV-0.5

Énumérations | Fonctions

Référence du fichier MLV_keyboard.h

Ce fichier définit tous les prototypes des fonctions permettant d'utiliser le clavier. Plus de détails...

Aller au code source de ce fichier.

Énumérations

enum  MLV_Keyboard {
  MLV_KEYBOARD_UNKNOWN = SDLK_UNKNOWN, MLV_KEYBOARD_FIRST = SDLK_FIRST, MLV_KEYBOARD_BACKSPACE = SDLK_BACKSPACE, MLV_KEYBOARD_TAB = SDLK_TAB,
  MLV_KEYBOARD_CLEAR = SDLK_CLEAR, MLV_KEYBOARD_RETURN = SDLK_RETURN, MLV_KEYBOARD_PAUSE = SDLK_PAUSE, MLV_KEYBOARD_ESCAPE = SDLK_ESCAPE,
  MLV_KEYBOARD_SPACE = SDLK_SPACE, MLV_KEYBOARD_EXCLAIM = SDLK_EXCLAIM, MLV_KEYBOARD_QUOTEDBL = SDLK_QUOTEDBL, MLV_KEYBOARD_HASH = SDLK_HASH,
  MLV_KEYBOARD_DOLLAR = SDLK_DOLLAR, MLV_KEYBOARD_AMPERSAND = SDLK_AMPERSAND, MLV_KEYBOARD_QUOTE = SDLK_QUOTE, MLV_KEYBOARD_LEFTPAREN = SDLK_LEFTPAREN,
  MLV_KEYBOARD_RIGHTPAREN = SDLK_RIGHTPAREN, MLV_KEYBOARD_ASTERISK = SDLK_ASTERISK, MLV_KEYBOARD_PLUS = SDLK_PLUS, MLV_KEYBOARD_COMMA = SDLK_COMMA,
  MLV_KEYBOARD_MINUS = SDLK_MINUS, MLV_KEYBOARD_PERIOD = SDLK_PERIOD, MLV_KEYBOARD_SLASH = SDLK_SLASH, MLV_KEYBOARD_0 = SDLK_0,
  MLV_KEYBOARD_1 = SDLK_1, MLV_KEYBOARD_2 = SDLK_2, MLV_KEYBOARD_3 = SDLK_3, MLV_KEYBOARD_4 = SDLK_4,
  MLV_KEYBOARD_5 = SDLK_5, MLV_KEYBOARD_6 = SDLK_6, MLV_KEYBOARD_7 = SDLK_7, MLV_KEYBOARD_8 = SDLK_8,
  MLV_KEYBOARD_9 = SDLK_9, MLV_KEYBOARD_COLON = SDLK_COLON, MLV_KEYBOARD_SEMICOLON = SDLK_SEMICOLON, MLV_KEYBOARD_LESS = SDLK_LESS,
  MLV_KEYBOARD_EQUALS = SDLK_EQUALS, MLV_KEYBOARD_GREATER = SDLK_GREATER, MLV_KEYBOARD_QUESTION = SDLK_QUESTION, MLV_KEYBOARD_AT = SDLK_AT,
  MLV_KEYBOARD_LEFTBRACKET = SDLK_LEFTBRACKET, MLV_KEYBOARD_BACKSLASH = SDLK_BACKSLASH, MLV_KEYBOARD_RIGHTBRACKET = SDLK_RIGHTBRACKET, MLV_KEYBOARD_CARET = SDLK_CARET,
  MLV_KEYBOARD_UNDERSCORE = SDLK_UNDERSCORE, MLV_KEYBOARD_BACKQUOTE = SDLK_BACKQUOTE, MLV_KEYBOARD_a = SDLK_a, MLV_KEYBOARD_b = SDLK_b,
  MLV_KEYBOARD_c = SDLK_c, MLV_KEYBOARD_d = SDLK_d, MLV_KEYBOARD_e = SDLK_e, MLV_KEYBOARD_f = SDLK_f,
  MLV_KEYBOARD_g = SDLK_g, MLV_KEYBOARD_h = SDLK_h, MLV_KEYBOARD_i = SDLK_i, MLV_KEYBOARD_j = SDLK_j,
  MLV_KEYBOARD_k = SDLK_k, MLV_KEYBOARD_l = SDLK_l, MLV_KEYBOARD_m = SDLK_m, MLV_KEYBOARD_n = SDLK_n,
  MLV_KEYBOARD_o = SDLK_o, MLV_KEYBOARD_p = SDLK_p, MLV_KEYBOARD_q = SDLK_q, MLV_KEYBOARD_r = SDLK_r,
  MLV_KEYBOARD_s = SDLK_s, MLV_KEYBOARD_t = SDLK_t, MLV_KEYBOARD_u = SDLK_u, MLV_KEYBOARD_v = SDLK_v,
  MLV_KEYBOARD_w = SDLK_w, MLV_KEYBOARD_x = SDLK_x, MLV_KEYBOARD_y = SDLK_y, MLV_KEYBOARD_z = SDLK_z,
  MLV_KEYBOARD_DELETE = SDLK_DELETE, MLV_KEYBOARD_KP0 = SDLK_KP0, MLV_KEYBOARD_KP1 = SDLK_KP1, MLV_KEYBOARD_KP2 = SDLK_KP2,
  MLV_KEYBOARD_KP3 = SDLK_KP3, MLV_KEYBOARD_KP4 = SDLK_KP4, MLV_KEYBOARD_KP5 = SDLK_KP5, MLV_KEYBOARD_KP6 = SDLK_KP6,
  MLV_KEYBOARD_KP7 = SDLK_KP7, MLV_KEYBOARD_KP8 = SDLK_KP8, MLV_KEYBOARD_KP9 = SDLK_KP9, MLV_KEYBOARD_KP_PERIOD = SDLK_KP_PERIOD,
  MLV_KEYBOARD_KP_DIVIDE = SDLK_KP_DIVIDE, MLV_KEYBOARD_KP_MULTIPLY = SDLK_KP_MULTIPLY, MLV_KEYBOARD_KP_MINUS = SDLK_KP_MINUS, MLV_KEYBOARD_KP_PLUS = SDLK_KP_PLUS,
  MLV_KEYBOARD_KP_ENTER = SDLK_KP_ENTER, MLV_KEYBOARD_KP_EQUALS = SDLK_KP_EQUALS, MLV_KEYBOARD_UP = SDLK_UP, MLV_KEYBOARD_DOWN = SDLK_DOWN,
  MLV_KEYBOARD_RIGHT = SDLK_RIGHT, MLV_KEYBOARD_LEFT = SDLK_LEFT, MLV_KEYBOARD_INSERT = SDLK_INSERT, MLV_KEYBOARD_HOME = SDLK_HOME,
  MLV_KEYBOARD_END = SDLK_END, MLV_KEYBOARD_PAGEUP = SDLK_PAGEUP, MLV_KEYBOARD_PAGEDOWN = SDLK_PAGEDOWN, MLV_KEYBOARD_F1 = SDLK_F1,
  MLV_KEYBOARD_F2 = SDLK_F2, MLV_KEYBOARD_F3 = SDLK_F3, MLV_KEYBOARD_F4 = SDLK_F4, MLV_KEYBOARD_F5 = SDLK_F5,
  MLV_KEYBOARD_F6 = SDLK_F6, MLV_KEYBOARD_F7 = SDLK_F7, MLV_KEYBOARD_F8 = SDLK_F8, MLV_KEYBOARD_F9 = SDLK_F9,
  MLV_KEYBOARD_F10 = SDLK_F10, MLV_KEYBOARD_F11 = SDLK_F11, MLV_KEYBOARD_F12 = SDLK_F12, MLV_KEYBOARD_F13 = SDLK_F13,
  MLV_KEYBOARD_F14 = SDLK_F14, MLV_KEYBOARD_F15 = SDLK_F15, MLV_KEYBOARD_NUMLOCK = SDLK_NUMLOCK, MLV_KEYBOARD_CAPSLOCK = SDLK_CAPSLOCK,
  MLV_KEYBOARD_SCROLLOCK = SDLK_SCROLLOCK, MLV_KEYBOARD_RSHIFT = SDLK_RSHIFT, MLV_KEYBOARD_LSHIFT = SDLK_LSHIFT, MLV_KEYBOARD_RCTRL = SDLK_RCTRL,
  MLV_KEYBOARD_LCTRL = SDLK_LCTRL, MLV_KEYBOARD_RALT = SDLK_RALT, MLV_KEYBOARD_LALT = SDLK_LALT, MLV_KEYBOARD_RMETA = SDLK_RMETA,
  MLV_KEYBOARD_LMETA = SDLK_LMETA, MLV_KEYBOARD_LSUPER = SDLK_LSUPER, MLV_KEYBOARD_RSUPER = SDLK_RSUPER, MLV_KEYBOARD_MODE = SDLK_MODE,
  MLV_KEYBOARD_COMPOSE = SDLK_COMPOSE, MLV_KEYBOARD_HELP = SDLK_HELP, MLV_KEYBOARD_PRINT = SDLK_PRINT, MLV_KEYBOARD_SYSREQ = SDLK_SYSREQ,
  MLV_KEYBOARD_BREAK = SDLK_BREAK, MLV_KEYBOARD_MENU = SDLK_MENU, MLV_KEYBOARD_POWER = SDLK_POWER, MLV_KEYBOARD_EURO = SDLK_EURO,
  MLV_KEYBOARD_UNDO = SDLK_UNDO, MLV_KEYBOARD_LAST = SDLK_LAST
}
 

Enumère l'ensemble des codes des touches du clavier.


enum  MLV_Keyboard_mod {
  MLV_KEYBOARD_KMOD_NONE = KMOD_NONE, MLV_KEYBOARD_KMOD_LSHIFT = KMOD_LSHIFT, MLV_KEYBOARD_KMOD_RSHIFT = KMOD_RSHIFT, MLV_KEYBOARD_KMOD_LCTRL = KMOD_LCTRL,
  MLV_KEYBOARD_KMOD_RCTRL = KMOD_RCTRL, MLV_KEYBOARD_KMOD_LALT = KMOD_LALT, MLV_KEYBOARD_KMOD_RALT = KMOD_RALT, MLV_KEYBOARD_KMOD_LMETA = KMOD_LMETA,
  MLV_KEYBOARD_KMOD_RMETA = KMOD_RMETA, MLV_KEYBOARD_KMOD_NUM = KMOD_NUM, MLV_KEYBOARD_KMOD_CAPS = KMOD_CAPS, MLV_KEYBOARD_KMOD_MODE = KMOD_MODE,
  MLV_KEYBOARD_KMOD_RESERVED = KMOD_RESERVED
}
 

Enumère l'ensemble des codes associées aux différents modes du clavier.


Fonctions

void MLV_wait_keyboard (int *sym, int *mod, int *unicode)
 Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier.
int MLV_wait_keyboard_or_seconds (int *sym, int *mod, int *unicode, int seconds)
 Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier ou jusq'à ce q'un nombre de secondes passées en paramètres soient écoulées.
MLV_Keyboard MLV_convert_string_to_keyboard (const char *key_string)
 Renvoie le code de la touche clavier correspondant au type clavier passé en paramètre.
MLV_Keyboard_mod MLV_convert_string_to_keyboard_mod (const char *key_string)
 Renvoie le code de la touche clavier correspondant au type clavier passé en paramètre.
const char * MLV_convert_keyboard_to_string (MLV_Keyboard key_code)
 Renvoie la chaîne de caractère correspondant au code de la touche passé en paramètre.
const char * MLV_convert_keyboard_mod_to_string (MLV_Keyboard_mod keymod_code)
 Renvoie la chaîne de caractère correspondant au mode du clavier passé en paramètre.
MLV_State MLV_get_keyboard_state (MLV_Keyboard keyboard_code)
 Renvoie l'état (préssé ou relaché) de l'une touche d'un clavier.

Description détaillée

Ce fichier définit tous les prototypes des fonctions permettant d'utiliser le clavier.

Auteur:
Adrien Boussicault
Marc Zipstein

Documentation des fonctions

const char* MLV_convert_keyboard_mod_to_string ( MLV_Keyboard_mod  keymod_code  ) 

Renvoie la chaîne de caractère correspondant au mode du clavier passé en paramètre.

Paramètres:
keymod_code Le code du mode.
Renvoie:
La chaine de caractère codant le mode du clavier.
const char* MLV_convert_keyboard_to_string ( MLV_Keyboard  key_code  ) 

Renvoie la chaîne de caractère correspondant au code de la touche passé en paramètre.

Paramètres:
key_code Le code de la touche.
Renvoie:
La chaine de caractère codant le code de la touche.
MLV_Keyboard MLV_convert_string_to_keyboard ( const char *  key_string  ) 

Renvoie le code de la touche clavier correspondant au type clavier passé en paramètre.

Paramètres:
key_string La chaine de caractère codant le type de la touche.
Renvoie:
Le code de la touche clavier.
MLV_Keyboard_mod MLV_convert_string_to_keyboard_mod ( const char *  key_string  ) 

Renvoie le code de la touche clavier correspondant au type clavier passé en paramètre.

Paramètres:
key_string La chaine de caractère codant le type de la touche.
Renvoie:
Le code de la touche clavier.
MLV_State MLV_get_keyboard_state ( MLV_Keyboard  keyboard_code  ) 

Renvoie l'état (préssé ou relaché) de l'une touche d'un clavier.

Paramètres:
keyboard_code Le code de la touche dont il faut renvoyer l'état.
Renvoie:
L'état de la touche.
void MLV_wait_keyboard ( int *  sym,
int *  mod,
int *  unicode 
)

Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier.

Lorsque l'utilisateur appuie sur une touche, la fonction retourne trois valeurs ( sym, mod et unicode ) correspondant respectivement au code de la touche, au mode dans lequel se trouve le clavier (majuscule etc ...) et au caractère unicode correspondnant obtenu en combinant le mode du clavier et le code de la touche appuyée.

La fonction accepte des valeurs nulles pour les pointeurs sym, mod et unicode. Dans ce cas la fonction ignore les champs en questions.

Paramètres:
sym Code de la touche
mod Mode dans lequel se trouve le clavier
unicode Caractère codé en unicode de la lettre obtenue en combinant le code et le mode précédent
Exemples:
advanced/4_sound.c, beginner/10_library_informations.c, beginner/6_keyboard.c, medium/8_full_screen.c, et medium/9_keyboard_accents.c.
int MLV_wait_keyboard_or_seconds ( int *  sym,
int *  mod,
int *  unicode,
int  seconds 
)

Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier ou jusq'à ce q'un nombre de secondes passées en paramètres soient écoulées.

Lorsque l'utilisateur appuie sur une touche, la fonction retourne trois valeurs ( sym, mod et unicode ) correspondant respectivement au code de la touche, au mode dans lequel se trouve le clavier (majuscule etc ...) et au caractère unicode correspondnant obtenu en combinant le mode du clavier et le code de la touche appuyée.

La fonction accepte des valeurs nulles pour les pointeurs sym, mod et unicode. Dans ce cas la fonction ignore les champs en questions.

Paramètres:
sym Code de la touche
mod Mode dans lequel se trouve le clavier
unicode Caractère codé en unicode de la lettre obtenue en combinant le code et le mode précédent
seconds Le nombre de secondes à attendre
Renvoie:
Renvoie 1 si l'utilisateur à utiliser le calvier, 0 si le temps s'est écoulé.
Exemples:
beginner/8_mouse_keyboard_timer.c.