Ce fichier définit les prototypes des fonctions permettant d'utiliser les èvenements dans la librairie MLV. Plus de détails...
Aller au code source de ce fichier.
Énumérations | |
enum | MLV_Event { MLV_NONE = 0, MLV_KEY = 1, MLV_PROMPT = 2, MLV_MOUSE_BUTTON = 3, MLV_MOUSE_MOTION = 4 } |
Enumère les différents types d'évènement de la librairie MLV. Plus de détails... | |
enum | MLV_State { MLV_PRESSED, MLV_RELEASED } |
Enumère les différents états possibles d'un bouton clavier ou souris. Plus de détails... | |
Fonctions | |
MLV_Event | MLV_get_event (int *key_sym, int *key_mod, int *unicode, char **texte, MLV_Prompt **prompt, int *mouse_x, int *mouse_y, int *mouse_button, int *state) |
Cette fonction récupère un évènement dans la file d'attente, remplit en fonction de l'évènement récupéré une partie des paramètres de la fonction et renvoie un entier codant le type de l'évènement qui a été récupéré. | |
MLV_Event | MLV_wait_event (int *key_sym, int *key_mod, int *unicode, char **texte, MLV_Prompt **prompt, int *mouse_x, int *mouse_y, int *mouse_button, int *state) |
Cette fonction suspends l'éxecution du programme jusqu'à ce qu'un évènement apparaît dans la file d'attente. Dans ce cas, la fonction s'endort de nouveau si les paramètre passé en argument ne concerne pas l'évènement récupéré. Par contre, si les paramètres passés en argument est en relation avec l'évènement récupéré, alors la fonction remplit les paramètres et renvoie un entier codant le type de l'évènement qui a été récupéré. | |
MLV_Event | MLV_wait_event_or_seconds (int *key_sym, int *key_mod, int *unicode, char **texte, MLV_Prompt **prompt, int *mouse_x, int *mouse_y, int *mouse_button, int *state, int seconds) |
Cette fonction suspends l'éxecution du programme jusqu'à ce qu'un évènement apparaît dans la file d'attente ou jusq'à ce qu'un certain nombre de secondes se soient écoulées. Dans ce cas, la fonction s'endort de nouveau si les paramètre passé en argument ne concerne pas l'évènement récupéré. Par contre, si les paramètres passés en argument est en relation avec l'évènement récupéré, alors la fonction remplit les paramètres et renvoie un entier codant le type de l'évènement qui a été récupéré. | |
void | MLV_flush_event_queue () |
Cette fonction vide la file d'évènements. | |
MLV_Event | MLV_wait_keyboard_or_mouse (int *sym, int *mod, int *unicode, int *mouse_x, int *mouse_y) |
Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier ou sur le bouton gauche de la souris. | |
MLV_Event | MLV_wait_keyboard_or_mouse_or_seconds (int *sym, int *mod, int *unicode, int *mouse_x, int *mouse_y, int seconds) |
Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier, sur le bouton gauche de la souris ou qu'un certain nombre de secondes passéesn en paramètres se soient écoulées. | |
const char * | MLV_convert_event_to_string (MLV_Event event_code) |
Convertit le code d'un évenement en une chaîne de caractère. | |
MLV_Event | MLV_convert_string_to_event (const char *event_string) |
Convertit le nom d'un évènement en son code associé. | |
const char * | MLV_convert_state_to_string (MLV_State state_code) |
Convertit le code d'un état en une chaîne de caractère. | |
MLV_State | MLV_convert_string_to_state (const char *state_string) |
Convertit le nom d'un état en son code associé. |
Ce fichier définit les prototypes des fonctions permettant d'utiliser les èvenements dans la librairie MLV.
enum MLV_Event |
Enumère les différents types d'évènement de la librairie MLV.
enum MLV_State |
const char* MLV_convert_event_to_string | ( | MLV_Event | event_code | ) |
Convertit le code d'un évenement en une chaîne de caractère.
event_code | le code de l'évenement |
const char* MLV_convert_state_to_string | ( | MLV_State | state_code | ) |
Convertit le code d'un état en une chaîne de caractère.
state_code | le code de l'état |
MLV_Event MLV_convert_string_to_event | ( | const char * | event_string | ) |
Convertit le nom d'un évènement en son code associé.
event_string | le nom de l'évènement. |
MLV_State MLV_convert_string_to_state | ( | const char * | state_string | ) |
Convertit le nom d'un état en son code associé.
state_string | le nom de l'état. |
MLV_Event MLV_get_event | ( | int * | key_sym, | |
int * | key_mod, | |||
int * | unicode, | |||
char ** | texte, | |||
MLV_Prompt ** | prompt, | |||
int * | mouse_x, | |||
int * | mouse_y, | |||
int * | mouse_button, | |||
int * | state | |||
) |
Cette fonction récupère un évènement dans la file d'attente, remplit en fonction de l'évènement récupéré une partie des paramètres de la fonction et renvoie un entier codant le type de l'évènement qui a été récupéré.
Le type des évènements est défini par :
MLV_Event
et peut valoir les valeurs suivantes:
Valeur ........... Signification
----------------------------------
MLV_NONE .......... Aucun évènement récupéré
MLV_KEY ........... Une touche du clavier a été appuyée ou relachée.
MLV_PROMPT ........ L'utilisateur a écrit une chaîne de caractère et validé cette chaîne par la touche entrée.
MLV_MOUSE_BUTTON .. Un des boutons de la souris a été appuyé.
MLV_MOUS_MOTION ... La souris a été déplacée.
Voici un tableau qui donne les champs modifiés en fonction de l'évènement qui a été récupéré.
Type Evenement .... Paramètres modifiés
---------------------------------------
MLV_NONE .......... AUCUN
MLV_KEY ........... key_sym, key_mod, state
MLV_PROMPT ........ texte, prompt
MLV_MOUSE_BUTTON .. mouse_x, mouse_y, mouse_button, state
MLV_MOUSE_MOTION .. mouse_x, mouse_y
L'utilisateur n'est pas obligé d'utiliser un champs s'il n'en a pas l'utilité. Dans ce cas, il peut mettre la valeur NULL. Le champs est alors ignoré.
key_sym | Code de la touche qui a été appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard. | |
key_mod | Mode dans lequel se trouve le clavier lorsqu'une touche est appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard_mod. | |
unicode | Caractère codé en unicode de la lettre obtenue en combinant le code et le mode précédent | |
texte | Texte récupéré par le prompt. L'allocation est affecté par la la fonction elle même. La désallocation est à la charge de l'utilisateur. | |
prompt | Prompt qui a récupéré le texte | |
mouse_x | Coordonnée en X de la position de la souris | |
mouse_y | Coordonnée en Y de la position de la souris | |
mouse_button | Bouton de la souris qui a été appuyé ou relaché. Ce champs est défini par l'énumération MLV_Button. | |
state | Etat de la touche concernée par l'évènement. La valeur de ce champs est défini par l'énumération: MLV_State. |
MLV_Event MLV_wait_event | ( | int * | key_sym, | |
int * | key_mod, | |||
int * | unicode, | |||
char ** | texte, | |||
MLV_Prompt ** | prompt, | |||
int * | mouse_x, | |||
int * | mouse_y, | |||
int * | mouse_button, | |||
int * | state | |||
) |
Cette fonction suspends l'éxecution du programme jusqu'à ce qu'un évènement apparaît dans la file d'attente. Dans ce cas, la fonction s'endort de nouveau si les paramètre passé en argument ne concerne pas l'évènement récupéré. Par contre, si les paramètres passés en argument est en relation avec l'évènement récupéré, alors la fonction remplit les paramètres et renvoie un entier codant le type de l'évènement qui a été récupéré.
Le type des évènements est défini par :
MLV_Event
et peut valoir les valeurs suivantes:
Valeur ........... Signification
----------------------------------
MLV_NONE .......... Aucun évènement récupéré
MLV_KEY ........... Une touche du clavier a été appuyée ou relachée.
MLV_PROMPT ........ L'utilisateur a écrit une chaîne de caractère et validé cette chaîne par la touche entrée.
MLV_MOUSE_BUTTON .. Un des boutons de la souris a été appuyé.
MLV_MOUS_MOTION ... La souris a été déplacée.
Voici un tableau qui donne les champs modifiés en fonction de l'évènement qui a été récupéré.
Type Evenement .... Paramètres modifiés
---------------------------------------
MLV_NONE .......... AUCUN
MLV_KEY ........... key_sym, key_mod, state
MLV_PROMPT ........ texte, prompt
MLV_MOUSE_BUTTON .. mouse_x, mouse_y, mouse_button, state
MLV_MOUSE_MOTION .. mouse_x, mouse_y
L'utilisateur n'est pas obligé d'utiliser un champs s'il n'en a pas l'utilité. Dans ce cas, il peut mettre la valeur NULL. Le champs est alors ignoré.
key_sym | Code de la touche qui a été appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard. | |
key_mod | Mode dans lequel se trouve le clavier lorsqu'une touche est appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard_mod. | |
unicode | Caractère codé en unicode de la lettre obtenue en combinant le code et le mode précédent | |
texte | Texte récupéré par le prompt. L'allocation est affecté par la la fonction elle même. La désallocation est à la charge de l'utilisateur. | |
prompt | Prompt qui a récupéré le texte | |
mouse_x | Coordonnée en X de la position de la souris | |
mouse_y | Coordonnée en Y de la position de la souris | |
mouse_button | Bouton de la souris qui a été appuyé ou relaché. Ce champs est défini par l'énumération MLV_Button. | |
state | Etat de la touche concernée par l'évènement. La valeur de ce champs est défini par l'énumération: MLV_State. |
MLV_Event MLV_wait_event_or_seconds | ( | int * | key_sym, | |
int * | key_mod, | |||
int * | unicode, | |||
char ** | texte, | |||
MLV_Prompt ** | prompt, | |||
int * | mouse_x, | |||
int * | mouse_y, | |||
int * | mouse_button, | |||
int * | state, | |||
int | seconds | |||
) |
Cette fonction suspends l'éxecution du programme jusqu'à ce qu'un évènement apparaît dans la file d'attente ou jusq'à ce qu'un certain nombre de secondes se soient écoulées. Dans ce cas, la fonction s'endort de nouveau si les paramètre passé en argument ne concerne pas l'évènement récupéré. Par contre, si les paramètres passés en argument est en relation avec l'évènement récupéré, alors la fonction remplit les paramètres et renvoie un entier codant le type de l'évènement qui a été récupéré.
Le type des évènements est défini par :
MLV_Event
et peut valoir les valeurs suivantes:
Valeur ........... Signification
----------------------------------
MLV_NONE .......... Aucun évènement récupéré
MLV_KEY ........... Une touche du clavier a été appuyée ou relachée.
MLV_PROMPT ........ L'utilisateur a écrit une chaîne de caractère et validé cette chaîne par la touche entrée.
MLV_MOUSE_BUTTON .. Un des boutons de la souris a été appuyé.
MLV_MOUS_MOTION ... La souris a été déplacée.
Voici un tableau qui donne les champs modifiés en fonction de l'évènement qui a été récupéré.
Type Evenement .... Paramètres modifiés
---------------------------------------
MLV_NONE .......... AUCUN
MLV_KEY ........... key_sym, key_mod, state
MLV_PROMPT ........ texte, prompt
MLV_MOUSE_BUTTON .. mouse_x, mouse_y, mouse_button, state
MLV_MOUSE_MOTION .. mouse_x, mouse_y
L'utilisateur n'est pas obligé d'utiliser un champs s'il n'en a pas l'utilité. Dans ce cas, il peut mettre la valeur NULL. Le champs est alors ignoré.
key_sym | Code de la touche qui a été appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard. | |
key_mod | Mode dans lequel se trouve le clavier lorsqu'une touche est appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard_mod. | |
unicode | Caractère codé en unicode de la lettre obtenue en combinant le code et le mode précédent | |
texte | Texte récupéré par le prompt. L'allocation est affecté par la la fonction elle même. La désallocation est à la charge de l'utilisateur. | |
prompt | Prompt qui a récupéré le texte | |
mouse_x | Coordonnée en X de la position de la souris | |
mouse_y | Coordonnée en Y de la position de la souris | |
mouse_button | Bouton de la souris qui a été appuyé ou relaché. Ce champs est défini par l'énumération MLV_Button. | |
state | Etat de la touche concernée par l'évènement. La valeur de ce champs est défini par l'énumération: MLV_State. | |
seconds | Nombre de secondes à attendre avant de terminer l'execution de la fonction en renvoyant MLV_NONE. |
MLV_Event MLV_wait_keyboard_or_mouse | ( | int * | sym, | |
int * | mod, | |||
int * | unicode, | |||
int * | mouse_x, | |||
int * | mouse_y | |||
) |
Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier ou sur le bouton gauche de la souris.
Cette fonction renvoie un entier codant le type de l'évènement qui a été récupéré ( clavier ou souris )
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.
Lorsque l'utilisateur appuie sur le bouton gauche de la souris, la fonction remplit les parametres correspondant aux coordonnées en X et Y de la position de la souris sur l'écran.
sym | Code de la touche qui a été appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard. | |
mod | Mode dans lequel se trouve le clavier lorsqu'une touche est appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard_mod. | |
unicode | Caractère codé en unicode de la lettre obtenue en combinant le code et le mode précédent | |
mouse_x | Coordonnée en X de la position de la souris | |
mouse_y | Coordonnée en Y de la position de la souris |
MLV_Event MLV_wait_keyboard_or_mouse_or_seconds | ( | int * | sym, | |
int * | mod, | |||
int * | unicode, | |||
int * | mouse_x, | |||
int * | mouse_y, | |||
int | seconds | |||
) |
Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier, sur le bouton gauche de la souris ou qu'un certain nombre de secondes passéesn en paramètres se soient écoulées.
Cette fonction renvoie un entier codant le type de l'évènement qui a été récupéré ( clavier ou souris )
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.
Lorsque l'utilisateur appuie sur le bouton gauche de la souris, la fonction remplit les parametres correspondant aux coordonnées en X et Y de la position de la souris sur l'écran.
sym | Code de la touche qui a été appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard. | |
mod | Mode dans lequel se trouve le clavier lorsqu'une touche est appuyée ou relachée. La valeur de ce champs est définie par l'énumération : MLV_Keyboard_mod. | |
unicode | Caractère codé en unicode de la lettre obtenue en combinant le code et le mode précédent | |
mouse_x | Coordonnée en X de la position de la souris | |
mouse_y | Coordonnée en Y de la position de la souris | |
seconds | Le nombre de seconde à attendre avant d'arrêter la fonction |