| MLV_event.h(3) | Library Functions Manual | MLV_event.h(3) |
MLV_event.h - Ce fichier définit les prototypes des fonctions permettant d'utiliser les évènements dans la bibliothèque MLV.
enum MLV_Event { MLV_NONE = 0, MLV_KEY = 1,
MLV_INPUT_BOX = 2, MLV_MOUSE_BUTTON = 3,
MLV_MOUSE_MOTION = 4 }
Énumère les différents types d'évènement de
la bibliothèque MLV.
MLV_Event MLV_get_event (MLV_Keyboard_button
*key_sym, MLV_Keyboard_modifier *key_mod, int *unicode, char **texte,
MLV_Input_box **input_box, int *mouse_x, int *mouse_y,
MLV_Mouse_button *mouse_button, MLV_Button_state *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 (MLV_Keyboard_button *key_sym,
MLV_Keyboard_modifier *key_mod, int *unicode, char **texte,
MLV_Input_box **input_box, int *mouse_x, int *mouse_y,
MLV_Mouse_button *mouse_button, MLV_Button_state *state)
Cette fonction suspends l'éxecution du programme jusqu'à ce
qu'un évènement apparaît dans la file d'attente.
Lorsqu'un nouvel évènement apparaît, la fonction.
MLV_Event MLV_wait_event_or_seconds
(MLV_Keyboard_button *key_sym, MLV_Keyboard_modifier *key_mod,
int *unicode, char **texte, MLV_Input_box **input_box, int *mouse_x,
int *mouse_y, MLV_Mouse_button *mouse_button, MLV_Button_state
*state, int seconds)
Cette fonction suspends l'éxecution du programme jusqu'à ce
qu'un évènement apparaît dans la file d'attente ou
jusqu'à ce qu'un certain nombre de secondes se soient
écoulées. Si le temps s'est complètement
écoulé, la fonction renvoie MLV_NONE. Si un nouvel
évènement apparaît et que les paramètres
passés en arguments sont en rapport 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é. Si un nouvel évènement
apparaît et qu'il n'est pas en rapport avec les paramètres de
la fonction, alors il se rendort dans l'attente d'un nouvel
évènement ou de la fin du temps. MLV_Event
MLV_wait_event_or_milliseconds (MLV_Keyboard_button *key_sym,
MLV_Keyboard_modifier *key_mod, int *unicode, char **texte,
MLV_Input_box **input_box, int *mouse_x, int *mouse_y,
MLV_Mouse_button *mouse_button, MLV_Button_state *state, int
milliseconds)
Cette fonction suspends l'éxecution du programme jusqu'à ce
qu'un évènement apparaît dans la file d'attente ou
jusqu'à ce qu'un certain nombre de millisecondes se soient
écoulées. Si le temps s'est complètement
écoulé, la fonction renvoie MLV_NONE. Si un nouvel
évènement apparaît et que les paramètres
passés en arguments sont en rapport 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é. Si un nouvel évènement
apparaît et qu'il n'est pas en rapport avec les paramètres de
la fonction, alors il se rendort dans l'attente d'un nouvel
évènement ou de la fin du temps. void
MLV_flush_event_queue ()
Cette fonction vide la file d'évènements. MLV_Event
MLV_wait_keyboard_or_mouse (MLV_Keyboard_button *sym,
MLV_Keyboard_modifier *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 (MLV_Keyboard_button
*sym, MLV_Keyboard_modifier *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ées en paramètres se soient
écoulées. MLV_Event
MLV_wait_mouse_or_milliseconds (int *x, int *y, int milliseconds)
Suspend l'exécution jusqu'à ce que l'utilisateur clique sur le
bouton gauche de la souris. MLV_Event
MLV_wait_mouse_or_seconds (int *x, int *y, int seconds)
Suspend l'exécution jusqu'à ce que l'utilisateur clique sur le
bouton gauche de la souris où jusqu'à ce qu'un nombre de
secondes, passé en paramètres, se soient
écoulées. MLV_Event MLV_wait_keyboard_or_seconds
(MLV_Keyboard_button *sym, MLV_Keyboard_modifier *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_Event
MLV_wait_keyboard_or_milliseconds (MLV_Keyboard_button *sym,
MLV_Keyboard_modifier *mod, int *unicode, int milliseconds)
Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une
touche du clavier ou jusq'à ce q'un nombre de millisecondes
passées en paramètres soient écoulées.
MLV_Event MLV_wait_keyboard_or_mouse_or_milliseconds
(MLV_Keyboard_button *sym, MLV_Keyboard_modifier *mod, int
*unicode, int *mouse_x, int *mouse_y, int milliseconds)
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 millisecondes passées en paramètres se soient
écoulées. const char * MLV_convert_event_to_string
(MLV_Event event_code)
Convertit le code d'un évènement en une chaîne de
caractères. 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_button_state_to_string
(MLV_Button_state state_code)
Convertit le code d'un état en une chaîne de caractères.
MLV_Button_state MLV_convert_string_to_button_state (const
char *state_string)
Convertit le nom d'un état en son code associé. MLV_Event
MLV_wait_input_box_or_milliseconds (int milliseconds, int
top_left_corner_X, int top_left_corner_Y, int width, int height,
MLV_Color borderColor, MLV_Color textColor, MLV_Color
backgroundColor, const char *informativeMessage, char **text,...)
Cette fonction suspend l'exécution du programme, affiche une
boîte de saisie et attends que l'utilisateur rentre une phrase dans
le champs de la boîte ou qu'une temps (en millisecondes) donné
en paramètre s'écoule. MLV_Event
MLV_wait_input_box_with_font_or_milliseconds (int milliseconds, int
top_left_corner_X, int top_left_corner_Y, int width, int height,
MLV_Color borderColor, MLV_Color textColor, MLV_Color
backgroundColor, const char *informativeMessage, char **text, const
MLV_Font *font,...)
Même chose que MLV_wait_input_box_or_milliseconds(), mais il est
possible de changer la fonte du du texte. MLV_Event
MLV_wait_particular_input_box_or_milliseconds (int milliseconds,
MLV_Input_box *input_box, char **text)
Cette fonction suspend l'exécution du programme jusqu'à ce que
l'utilisateur écrive une phrase dans le champs de la boîte de
saisie passée en paramètre de la fonction ou qu'un nombre de
millisecondes fixées soient écoulée. MLV_Event
MLV_wait_particular_input_box_or_seconds (MLV_Input_box
*input_box, char **text, int seconds)
Cette fonction suspend l'exécution du programme jusqu'à ce que
l'utilisateur écrive une phrase dans le champs de la boîte de
saisie passée en paramètre de la fonction ou qu'un nombre de
secondes fixées soient écoulée.
Ce fichier définit les prototypes des fonctions permettant d'utiliser les évènements dans la bibliothèque MLV.
Auteur
Marc Zipstein
Énumère les différents types d'évènement de la bibliothèque MLV.
Valeurs énumérées
Convertit le code d'un état en une chaîne de caractères.
Paramètres
Renvoie
Convertit le code d'un évènement en une chaîne de caractères.
Paramètres
Renvoie
Convertit le nom d'un état en son code associé.
Paramètres
Renvoie
Convertit le nom d'un évènement en son code associé.
Paramètres
Renvoie
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_INPUT_BOX ..... L'utilisateur a écrit une chaîne de
caractères 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 Évènement .... Paramètres modifiés
MLV_NONE .......... AUCUN
MLV_KEY ........... key_sym, key_mod, state
MLV_INPUT_BOX ..... texte, input_box
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é.
Bogue
Bogue
Renvoie
Paramètres
Exemples
advanced/09_animation.c, advanced/11_animation_book.c,
medium/01_keyboard_events.c, medium/02_mouse_events.c,
medium/03_input_box_events.c, medium/04_events.c, et
medium/06_colors.c.
Cette fonction suspends l'éxecution du programme jusqu'à ce qu'un évènement apparaît dans la file d'attente. Lorsqu'un nouvel évènement apparaît, la fonction.
Pour plus d'informations sur les différents types d'évènements et leurs liens avec les paramètres de la fonction, veuillez consulter la documentation de la fonction MLV_get_event().
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 et le paramètre est ignoré.
Bogue
Paramètres
Renvoie
Cette fonction suspends l'éxecution du programme jusqu'à ce qu'un évènement apparaît dans la file d'attente ou jusqu'à ce qu'un certain nombre de millisecondes se soient écoulées. Si le temps s'est complètement écoulé, la fonction renvoie MLV_NONE. Si un nouvel évènement apparaît et que les paramètres passés en arguments sont en rapport 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é. Si un nouvel évènement apparaît et qu'il n'est pas en rapport avec les paramètres de la fonction, alors il se rendort dans l'attente d'un nouvel évènement ou de la fin du temps. Pour plus d'informations sur les différents types d'évènements et leurs liens avec les paramètres de la fonction, veuillez consulter la documentation de la fonction MLV_get_event().
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é.
Bogue
Paramètres
Renvoie
Cette fonction suspends l'éxecution du programme jusqu'à ce qu'un évènement apparaît dans la file d'attente ou jusqu'à ce qu'un certain nombre de secondes se soient écoulées. Si le temps s'est complètement écoulé, la fonction renvoie MLV_NONE. Si un nouvel évènement apparaît et que les paramètres passés en arguments sont en rapport 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é. Si un nouvel évènement apparaît et qu'il n'est pas en rapport avec les paramètres de la fonction, alors il se rendort dans l'attente d'un nouvel évènement ou de la fin du temps. Pour plus d'informations sur les différents types d'évènements et leurs liens avec les paramètres de la fonction, veuillez consulter la documentation de la fonction MLV_get_event().
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é.
Bogue
Paramètres
Renvoie
Cette fonction suspend l'exécution du programme, affiche une boîte de saisie et attends que l'utilisateur rentre une phrase dans le champs de la boîte ou qu'une temps (en millisecondes) donné en paramètre s'écoule. La boîte de saisie contient deux zones de textes. La première zone ne peut pas être éditée par l'utilisateur et sert à afficher un message d'information. La deuxième est vide et peut être éditée par l'utilisateur. Lorsque l'utilisateur appuie sur la touche entrée, le texte qui se trouve dans la zone de texte est renvoyé par la fonction grâce au paramètre text. Le texte, la taille et les couleurs de la boîte de saisie sont paramétrables. Si le temps sécoule complètement, alors text est mis à NULL.
MLV_wait_input_box() alloue lui même la mémoire associée au paramètre 'text'. Par contre, après utilisation, vous devez libérer l'espace mémoire qui a été alloué.
Paramètres
Renvoie
Exemples
beginner/08_mouse_keyboard_input_box_timer.c.
Même chose que MLV_wait_input_box_or_milliseconds(), mais il est possible de changer la fonte du du texte. MLV_wait_input_box_with_font_or_milliseconds() alloue lui même la mémoire associée au paramètre 'text'. Par contre, après utilisation, vous devez libérer l'espace mémoire qui a été alloué. Si le temps est écoulé, alot text est mis à NULL.
Paramètres
Renvoie
Suspend l'exécution jusqu'à ce que l'utilisateur appuie sur une touche du clavier ou jusq'à ce q'un nombre de millisecondes passées en paramètres soient écoulées. Pour plus d'informations sur le fonctionnement de cette fonction, veuillez vous reporter à la documentation de MLV_wait_keyboard().
La fonction accepte des valeurs nulles pour les pointeurs sym, mod et unicode. Dans ce cas la fonction ignore les champs en questions.
Bogue
Paramètres
Renvoie
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.
Bogue
Paramètres
Renvoie
Exemples
advanced/08_zone_click.c, et
beginner/08_mouse_keyboard_input_box_timer.c.
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 millisecondes passées 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, souris ou aucun des deux ).
Voir les fonctions MLV_wait_keyboard_milliseconds() et MLV_wait_mouse_milliseconds() pour plus d'informations.
Bogue
Paramètres
Renvoie
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ées 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, souris ou aucun des deux ).
Voir les fonctions MLV_wait_keyboard_seconds() et MLV_wait_mouse_seconds() pour plus d'informations.
Bogue
Paramètres
Renvoie
Exemples
beginner/08_mouse_keyboard_input_box_timer.c.
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. Pour plus d'informations sur le fonctionnement de cette fonction, veuillez vous reporter à la documentation de MLV_wait_keyboard().
La fonction accepte des valeurs nulles pour les pointeurs sym, mod et unicode. Dans ce cas la fonction ignore les champs en questions.
Bogue
Paramètres
Renvoie
Exemples
beginner/08_mouse_keyboard_input_box_timer.c.
Suspend l'exécution jusqu'à ce que l'utilisateur clique sur le bouton gauche de la souris. Au moment où l'utilisateur clique, la fonction retourne les coordonnées de la position de la souris dans la fenêtre.
Paramètres
Renvoie
Suspend l'exécution jusqu'à ce que l'utilisateur clique sur le bouton gauche de la souris où jusqu'à ce qu'un nombre de secondes, passé en paramètres, se soient écoulées. Au moment où l'utilisateur clique, la fonction retourne les coordonnées de la position de la souris dans la fenêtre.
Paramètres
Renvoie
Exemples
beginner/08_mouse_keyboard_input_box_timer.c.
Cette fonction suspend l'exécution du programme jusqu'à ce que l'utilisateur écrive une phrase dans le champs de la boîte de saisie passée en paramètre de la fonction ou qu'un nombre de millisecondes fixées soient écoulée.
Paramètres
Renvoie
Cette fonction suspend l'exécution du programme jusqu'à ce que l'utilisateur écrive une phrase dans le champs de la boîte de saisie passée en paramètre de la fonction ou qu'un nombre de secondes fixées soient écoulée.
Paramètres
Renvoie
Généré automatiquement par Doxygen pour MLV-3.1.0 à partir du code source.
| Lundi 2 Janvier 2023 | MLV-3.1.0 |