--- name: "MLV_keyboard.h" section: "3" platform: "linux" package: "libmlv3-dev" version: "3.1.0-8" release: "Debian 12 (Bookworm)" platforms: ["linux"] url: "https://new.carta.tech/MLV_keyboard.h" --- # MLV\_keyboard.h(3) Ce fichier définit les prototypes des fonctions permettant d'utiliser le clavier. ## NAME MLV\_keyboard.h - Ce fichier définit les prototypes des fonctions permettant d'utiliser le clavier. ## SYNOPSIS ### Énumérations enum **MLV\_Keyboard\_button** { **MLV\_KEYBOARD\_NONE** = SDLK\_UNKNOWN, **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\_WORLD\_0** = SDLK\_WORLD\_0, **MLV\_KEYBOARD\_WORLD\_1** = SDLK\_WORLD\_1, **MLV\_KEYBOARD\_WORLD\_2** = SDLK\_WORLD\_2, **MLV\_KEYBOARD\_WORLD\_3** = SDLK\_WORLD\_3, **MLV\_KEYBOARD\_WORLD\_4** = SDLK\_WORLD\_4, **MLV\_KEYBOARD\_WORLD\_5** = SDLK\_WORLD\_5, **MLV\_KEYBOARD\_WORLD\_6** = SDLK\_WORLD\_6, **MLV\_KEYBOARD\_WORLD\_7** = SDLK\_WORLD\_7, **MLV\_KEYBOARD\_WORLD\_8** = SDLK\_WORLD\_8, **MLV\_KEYBOARD\_WORLD\_9** = SDLK\_WORLD\_9, **MLV\_KEYBOARD\_WORLD\_10** = SDLK\_WORLD\_10, **MLV\_KEYBOARD\_WORLD\_11** = SDLK\_WORLD\_11, **MLV\_KEYBOARD\_WORLD\_12** = SDLK\_WORLD\_12, **MLV\_KEYBOARD\_WORLD\_13** = SDLK\_WORLD\_13, **MLV\_KEYBOARD\_WORLD\_14** = SDLK\_WORLD\_14, **MLV\_KEYBOARD\_WORLD\_15** = SDLK\_WORLD\_15, **MLV\_KEYBOARD\_WORLD\_16** = SDLK\_WORLD\_16, **MLV\_KEYBOARD\_WORLD\_17** = SDLK\_WORLD\_17, **MLV\_KEYBOARD\_WORLD\_18** = SDLK\_WORLD\_18, **MLV\_KEYBOARD\_WORLD\_19** = SDLK\_WORLD\_19, **MLV\_KEYBOARD\_WORLD\_20** = SDLK\_WORLD\_20, **MLV\_KEYBOARD\_WORLD\_21** = SDLK\_WORLD\_21, **MLV\_KEYBOARD\_WORLD\_22** = SDLK\_WORLD\_22, **MLV\_KEYBOARD\_WORLD\_23** = SDLK\_WORLD\_23, **MLV\_KEYBOARD\_WORLD\_24** = SDLK\_WORLD\_24, **MLV\_KEYBOARD\_WORLD\_25** = SDLK\_WORLD\_25, **MLV\_KEYBOARD\_WORLD\_26** = SDLK\_WORLD\_26, **MLV\_KEYBOARD\_WORLD\_27** = SDLK\_WORLD\_27, **MLV\_KEYBOARD\_WORLD\_28** = SDLK\_WORLD\_28, **MLV\_KEYBOARD\_WORLD\_29** = SDLK\_WORLD\_29, **MLV\_KEYBOARD\_WORLD\_30** = SDLK\_WORLD\_30, **MLV\_KEYBOARD\_WORLD\_31** = SDLK\_WORLD\_31, **MLV\_KEYBOARD\_WORLD\_32** = SDLK\_WORLD\_32, **MLV\_KEYBOARD\_WORLD\_33** = SDLK\_WORLD\_33, **MLV\_KEYBOARD\_WORLD\_34** = SDLK\_WORLD\_34, **MLV\_KEYBOARD\_WORLD\_35** = SDLK\_WORLD\_35, **MLV\_KEYBOARD\_WORLD\_36** = SDLK\_WORLD\_36, **MLV\_KEYBOARD\_WORLD\_37** = SDLK\_WORLD\_37, **MLV\_KEYBOARD\_WORLD\_38** = SDLK\_WORLD\_38, **MLV\_KEYBOARD\_WORLD\_39** = SDLK\_WORLD\_39, **MLV\_KEYBOARD\_WORLD\_40** = SDLK\_WORLD\_40, **MLV\_KEYBOARD\_WORLD\_41** = SDLK\_WORLD\_41, **MLV\_KEYBOARD\_WORLD\_42** = SDLK\_WORLD\_42, **MLV\_KEYBOARD\_WORLD\_43** = SDLK\_WORLD\_43, **MLV\_KEYBOARD\_WORLD\_44** = SDLK\_WORLD\_44, **MLV\_KEYBOARD\_WORLD\_45** = SDLK\_WORLD\_45, **MLV\_KEYBOARD\_WORLD\_46** = SDLK\_WORLD\_46, **MLV\_KEYBOARD\_WORLD\_47** = SDLK\_WORLD\_47, **MLV\_KEYBOARD\_WORLD\_48** = SDLK\_WORLD\_48, **MLV\_KEYBOARD\_WORLD\_49** = SDLK\_WORLD\_49, **MLV\_KEYBOARD\_WORLD\_50** = SDLK\_WORLD\_50, **MLV\_KEYBOARD\_WORLD\_51** = SDLK\_WORLD\_51, **MLV\_KEYBOARD\_WORLD\_52** = SDLK\_WORLD\_52, **MLV\_KEYBOARD\_WORLD\_53** = SDLK\_WORLD\_53, **MLV\_KEYBOARD\_WORLD\_54** = SDLK\_WORLD\_54, **MLV\_KEYBOARD\_WORLD\_55** = SDLK\_WORLD\_55, **MLV\_KEYBOARD\_WORLD\_56** = SDLK\_WORLD\_56, **MLV\_KEYBOARD\_WORLD\_57** = SDLK\_WORLD\_57, **MLV\_KEYBOARD\_WORLD\_58** = SDLK\_WORLD\_58, **MLV\_KEYBOARD\_WORLD\_59** = SDLK\_WORLD\_59, **MLV\_KEYBOARD\_WORLD\_60** = SDLK\_WORLD\_60, **MLV\_KEYBOARD\_WORLD\_61** = SDLK\_WORLD\_61, **MLV\_KEYBOARD\_WORLD\_62** = SDLK\_WORLD\_62, **MLV\_KEYBOARD\_WORLD\_63** = SDLK\_WORLD\_63, **MLV\_KEYBOARD\_WORLD\_64** = SDLK\_WORLD\_64, **MLV\_KEYBOARD\_WORLD\_65** = SDLK\_WORLD\_65, **MLV\_KEYBOARD\_WORLD\_66** = SDLK\_WORLD\_66, **MLV\_KEYBOARD\_WORLD\_67** = SDLK\_WORLD\_67, **MLV\_KEYBOARD\_WORLD\_68** = SDLK\_WORLD\_68, **MLV\_KEYBOARD\_WORLD\_69** = SDLK\_WORLD\_69, **MLV\_KEYBOARD\_WORLD\_70** = SDLK\_WORLD\_70, **MLV\_KEYBOARD\_WORLD\_71** = SDLK\_WORLD\_71, **MLV\_KEYBOARD\_WORLD\_72** = SDLK\_WORLD\_72, **MLV\_KEYBOARD\_WORLD\_73** = SDLK\_WORLD\_73, **MLV\_KEYBOARD\_WORLD\_74** = SDLK\_WORLD\_74, **MLV\_KEYBOARD\_WORLD\_75** = SDLK\_WORLD\_75, **MLV\_KEYBOARD\_WORLD\_76** = SDLK\_WORLD\_76, **MLV\_KEYBOARD\_WORLD\_77** = SDLK\_WORLD\_77, **MLV\_KEYBOARD\_WORLD\_78** = SDLK\_WORLD\_78, **MLV\_KEYBOARD\_WORLD\_79** = SDLK\_WORLD\_79, **MLV\_KEYBOARD\_WORLD\_80** = SDLK\_WORLD\_80, **MLV\_KEYBOARD\_WORLD\_81** = SDLK\_WORLD\_81, **MLV\_KEYBOARD\_WORLD\_82** = SDLK\_WORLD\_82, **MLV\_KEYBOARD\_WORLD\_83** = SDLK\_WORLD\_83, **MLV\_KEYBOARD\_WORLD\_84** = SDLK\_WORLD\_84, **MLV\_KEYBOARD\_WORLD\_85** = SDLK\_WORLD\_85, **MLV\_KEYBOARD\_WORLD\_86** = SDLK\_WORLD\_86, **MLV\_KEYBOARD\_WORLD\_87** = SDLK\_WORLD\_87, **MLV\_KEYBOARD\_WORLD\_88** = SDLK\_WORLD\_88, **MLV\_KEYBOARD\_WORLD\_89** = SDLK\_WORLD\_89, **MLV\_KEYBOARD\_WORLD\_90** = SDLK\_WORLD\_90, **MLV\_KEYBOARD\_WORLD\_91** = SDLK\_WORLD\_91, **MLV\_KEYBOARD\_WORLD\_92** = SDLK\_WORLD\_92, **MLV\_KEYBOARD\_WORLD\_93** = SDLK\_WORLD\_93, **MLV\_KEYBOARD\_WORLD\_94** = SDLK\_WORLD\_94, **MLV\_KEYBOARD\_WORLD\_95** = SDLK\_WORLD\_95, **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 }\ Énumère l'ensemble des codes des touches du clavier. enum **MLV\_Keyboard\_modifier** { **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 }\ Énumère l'ensemble des codes associées aux différents modes du clavier. ### Fonctions void **MLV\_wait\_keyboard** (**MLV\_Keyboard\_button** \*sym, **MLV\_Keyboard\_modifier** \*mod, int \*unicode)\ Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier. **MLV\_Keyboard\_button** **MLV\_convert\_string\_to\_keyboard\_button** (const char \*key\_string)\ Renvoie le code de la touche clavier correspondant au type clavier passé en paramètre. const char \* **MLV\_convert\_keyboard\_button\_to\_string** (**MLV\_Keyboard\_button** key\_code)\ Renvoie la chaîne de caractères correspondant au code de la touche passé en paramètre. char \* **MLV\_convert\_keyboard\_mod\_to\_string** (**MLV\_Keyboard\_modifier** keymod\_code)\ Renvoie la chaîne de caractères correspondant au mode du clavier passé en paramètre. **MLV\_Button\_state** **MLV\_get\_keyboard\_state** (**MLV\_Keyboard\_button** keyboard\_code)\ Renvoie l'état (préssé ou relaché) d'une touche donnée d'un clavier. int **MLV\_shift\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison shift du clavier. int **MLV\_left\_shift\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison shift gauche du clavier. int **MLV\_right\_shift\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison shift droit du clavier. int **MLV\_left\_ctrl\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison ctrl gauche du clavier. int **MLV\_right\_ctrl\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison ctrl droit du clavier. int **MLV\_ctrl\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison ctrl du clavier. int **MLV\_left\_alt\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison alt gauche du clavier. int **MLV\_right\_alt\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison alt droit du clavier. int **MLV\_alt\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison alt du clavier. int **MLV\_left\_meta\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison meta gauche du clavier. int **MLV\_right\_meta\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison meta droit du clavier. int **MLV\_meta\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison meta du clavier. int **MLV\_num\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison num du clavier. int **MLV\_caps\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison cpas du clavier. int **MLV\_mode\_key\_was\_pressed** (**MLV\_Keyboard\_modifier** modifier\_code)\ Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison mode du clavier. ## Description détaillée Ce fichier définit les prototypes des fonctions permettant d'utiliser le clavier. **Auteur** Adrien Boussicault Marc Zipstein ## Documentation des fonctions ### int MLV\_alt\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison alt du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison alt a été appuyée. ### int MLV\_caps\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison cpas du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison caps a été appuyée. ### const char \* MLV\_convert\_keyboard\_button\_to\_string (MLV\_Keyboard\_button key\_code) Renvoie la chaîne de caractères correspondant au code de la touche passé en paramètre. **Paramètres** *key\_code* Le code de la touche. **Renvoie** La chaine de caractères codant le code de la touche. **Exemples** **medium/11\_keys\_codes.c**. ### char \* MLV\_convert\_keyboard\_mod\_to\_string (MLV\_Keyboard\_modifier keymod\_code) Renvoie la chaîne de caractères correspondant au mode du clavier passé en paramètre. **Paramètres** *keymod\_code* Le code du mode. **Renvoie** La chaine de caractères codant le mode du clavier. **Exemples** **medium/11\_keys\_codes.c**. ### MLV\_Keyboard\_button MLV\_convert\_string\_to\_keyboard\_button (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ères codant le type de la touche. **Renvoie** Le code de la touche clavier. ### int MLV\_ctrl\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison ctrl du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison ctrl a été appuyée. ### MLV\_Button\_state MLV\_get\_keyboard\_state (MLV\_Keyboard\_button keyboard\_code) Renvoie l'état (préssé ou relaché) d'une touche donnée d'un clavier. **Paramètres** *keyboard\_code* Le code de la touche dont il faut renvoyer l'état. **Renvoie** L'état de la touche. **Exemples** **medium/10\_mouse\_or\_keyboard\_access.c**. ### int MLV\_left\_alt\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison alt gauche du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison alt gauche a été appuyée. ### int MLV\_left\_ctrl\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison ctrl gauche du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison ctrl gauche a été appuyée. ### int MLV\_left\_meta\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison meta gauche du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison meta gauche a été appuyée. ### int MLV\_left\_shift\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison shift gauche du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison shift gauche a été appuyée. ### int MLV\_meta\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison meta du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison meta a été appuyée. ### int MLV\_mode\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison mode du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison mode a été appuyée. ### int MLV\_num\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison num du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison num a été appuyée. ### int MLV\_right\_alt\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison alt droit du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison alt droit a été appuyée. ### int MLV\_right\_ctrl\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison ctrl droit du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison ctrl droit a été appuyée. ### int MLV\_right\_meta\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison meta droit du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison meta droit a été appuyée. ### int MLV\_right\_shift\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison shift droit du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison shift droit a été appuyée. ### int MLV\_shift\_key\_was\_pressed (MLV\_Keyboard\_modifier modifier\_code) Renvoie vrai si le code, passé en paramètre, correspond à l'état appuyé de la touche de combinaison shift du clavier. **Paramètres** *modifier\_code* Le code de la touche de combinaison. **Renvoie** Vrai, si la touche de cobinaison shift a été appuyée. **Exemples** **medium/01\_keyboard\_events.c**. ### void MLV\_wait\_keyboard (MLV\_Keyboard\_button \* sym, MLV\_Keyboard\_modifier \* 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 remplit le contenu des trois paramètres 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 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. **Bogue** Voir les bugs de la fonction **MLV\_get\_event()**. **Paramètres** *sym* Le code de la touche. \ *mod* Le mode dans lequel se trouve le clavier. \ *unicode* Le caractère codé en unicode de la lettre obtenue en combinant le code et le mode précédent. **Exemples** **advanced/04\_sound.c**, **beginner/06\_keyboard.c**, **beginner/10\_library\_informations.c**, **medium/08\_full\_screen.c**, **medium/09\_keyboard\_accents.c**, et **medium/11\_keys\_codes.c**. ## Auteur Généré automatiquement par Doxygen pour MLV-3.1.0 à partir du code source.