NAME

       MLV_input_box.h - Ce fichier définit les prototypes des fonctions permettant de demander à
       l'utilisateur du texte par l'intermédiaire de boîtes de saisie.

SYNOPSIS

   Définitions de type
       typedef struct _MLV_Input_box MLV_Input_box
           Définition du type des boîtes de saisies.

   Fonctions
       void MLV_wait_input_box (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.
       void MLV_wait_input_box_with_font (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(), mais il est possible de changer la fonte du du
           texte.
       void MLV_wait_particular_input_box (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.
       MLV_Input_box * MLV_create_input_box (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,...)
           Cette fonction créé une boîte de saisie.
       MLV_Input_box * MLV_create_input_box_with_font (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, const MLV_Font *font,...)
           Cette fonction créé une boîte de saisie avec une font spécifique.
       void MLV_free_input_box (MLV_Input_box *input_box)
           Cette fonction ferme une boîte de saisie précédement créée.
       void MLV_change_informative_message_of_input_box (MLV_Input_box *input_box, const char
           *message,...)
           Cette fonction change le message d'entête d'une boîte de saisie.
       void MLV_draw_input_box (MLV_Input_box *input_box)
           Cette fonction dessine une boîte de saisie particulière.
       void MLV_draw_all_input_boxes ()
           Cette fonction dessine tous les boîtes de saisies.
       void MLV_suppress_history (MLV_Input_box *input_box)
           Cette fonction supprime l'historique d'une boîte de saisie.
       void MLV_change_input_box_geometry (MLV_Input_box *input_box, int top_left_corner_X, int
           top_left_corner_Y, int width, int height)
           Cette fonction change la taille et la position d'une boîte de saisie donnée en
           paramètre.
       void MLV_change_input_box_size (MLV_Input_box *input_box, int width, int height)
           Cette fonction change la taille d'une boîte de saisie.
       void MLV_change_input_box_position (MLV_Input_box *input_box, int top_left_corner_X, int
           top_left_corner_Y)
           Cette fonction change la position d'une boîte de saisie donnée en paramètre.
       void MLV_change_input_box_colors (MLV_Input_box *input_box, MLV_Color borderColor,
           MLV_Color textColor, MLV_Color backgroundColor)
           Cette fonction change les différentes couleurs d'une boîte de saisie donnée.
       void MLV_activate_input_box (MLV_Input_box *input_box)
           Cette fonction active une boîte de saisie.
       void MLV_desactivate_input_box ()
           Cette fonction désactive la boîte de saisie qui est active.

Description détaillée

       Ce fichier définit les prototypes des fonctions permettant de demander à l'utilisateur du
       texte par l'intermédiaire de boîtes de saisie.

       Auteur
           Adrien Boussicault

           Marc Zipstein

Documentation des fonctions

   void MLV_activate_input_box (MLV_Input_box * input_box)
       Cette fonction active une boîte de saisie. Cette opération agit comme si l'utilisateur
       avait cliqué sur la boîte de saisie en question (action qui rend active une boîte de
       saisie).

       Lorsque une boîte de saisie est active, les évènements du clavier sont récupérés par la
       boîte de saisie et sont utilisés pour enregistrer le texte tapé par l'utilisateur. Les
       cliques de souris sur la boîte de saisie sont aussi récupérés par la boîte de saisie.

       Paramètres
           input_box La boîte de saisie à activer.

   void MLV_change_informative_message_of_input_box (MLV_Input_box * input_box, const char *
       message,  ...)
       Cette fonction change le message d'entête d'une boîte de saisie.

       Paramètres
           input_box La boîte de saisie à modifier.
           message Le message d'entête.

   void MLV_change_input_box_colors (MLV_Input_box * input_box, MLV_Color borderColor, MLV_Color
       textColor, MLV_Color backgroundColor)
       Cette fonction change les différentes couleurs d'une boîte de saisie donnée.

       Paramètres
           input_box La boîte de saisie à modifier.
           borderColor La nouvelle couleur du bord de la boîte de saisie.
           textColor La nouvelle couleur du texte de la boîte de saisie.
           backgroundColor La nouvelle couleur de fond de la boîte de saisie.

   void MLV_change_input_box_geometry (MLV_Input_box * input_box, int top_left_corner_X, int
       top_left_corner_Y, int width, int height)
       Cette fonction change la taille et la position d'une boîte de saisie donnée en paramètre.

       Paramètres
           input_box La boîte de saisie à modifier.
           top_left_corner_X La nouvelle coordonnée en X de la position du sommet Nord-Ouest de
           la boîte de saisie.
           top_left_corner_Y La nouvelle coordonnée en Y de la position du sommet Nord-Ouest de
           la boîte de saisie.
           width La nouvelle largeur de la boîte de saisie.
           height La nouvelle hauteur de la boîte de saisie.

   void MLV_change_input_box_position (MLV_Input_box * input_box, int top_left_corner_X, int
       top_left_corner_Y)
       Cette fonction change la position d'une boîte de saisie donnée en paramètre.

       Paramètres
           input_box La boîte de saisie à modifier.
           top_left_corner_X La nouvelle coordonnée en X de la position du sommet Nord-Ouest de
           la boîte de saisie.
           top_left_corner_Y La nouvelle coordonnée en Y de la position du sommet Nord-Ouest de
           la boîte de saisie.

   void MLV_change_input_box_size (MLV_Input_box * input_box, int width, int height)
       Cette fonction change la taille d'une boîte de saisie.

       Paramètres
           input_box La boîte de saisie à modifier.
           width La nouvelle largeur de la boîte de saisie.
           height La nouvelle hauteur de la boîte de saisie.

   MLV_Input_box* MLV_create_input_box (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,  ...)
       Cette fonction créé une boîte de saisie. Une fois la boîte de saisie créé, si
       l'utilisateur clique sur la boîte de saisie, la boîte de saisie devient active. Cela veux
       dire que tout les évènements clavier sont récupérés par la boîte de saisie qui s'en sert
       pour enregistrer le texte tapé par l'utilisateur. De même, tout clique de souris réalisé
       sur la boîte de saisie est acaparé par la boîte de saisie.

       Pour dessiner une ou toutes les boîtes de saisies, dans la zone où vous les avez créées,
       vous devez utiliser les fonctions :

       • MLV_draw_input_box()

       • MLV_draw_all_input_boxes()

       Paramètres
           top_left_corner_X La coordonnée en X du sommet Nord-Ouest de la boîte de saisie.
           top_left_corner_Y La coordonnée en Y du sommet Nord-Ouest de la boîte de saisie.
           width La largeur de la boîte de saisie.
           height La hauteur de la boîte de saisie.
           borderColor La couleur de la bordure de la boîte de saisie.
           textColor La couleur du texte.
           backgroundColor La couleur du fond.
           informativeMessage La message d'entête de la boîte de saisie.

       Exemples
           medium/03_input_box_events.c, et medium/04_events.c.

   MLV_Input_box* MLV_create_input_box_with_font (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, const MLV_Font * font,  ...)
       Cette fonction créé une boîte de saisie avec une font spécifique.

       Paramètres
           top_left_corner_X La coordonnée en X du sommet Nord-Ouest de la boîte de saisie.
           top_left_corner_Y La coordonnée en Y du sommet Nord-Ouest de la boîte de saisie.
           width La largeur de la boîte de saisie.
           height La hauteur de la boîte de saisie.
           borderColor La couleur de la bordure de la boîte de saisie.
           textColor La couleur du texte.
           backgroundColor La couleur du fond.
           informativeMessage Le message d'entête de la boîte de saisie.
           font La font à utiliser pour le texte.

   void MLV_desactivate_input_box ()
       Cette fonction désactive la boîte de saisie qui est active. Si il n'y a pas de boîte de
       saisie active, cette fonction ne fait rien.

   void MLV_draw_input_box (MLV_Input_box * input_box)
       Cette fonction dessine une boîte de saisie particulière.

       Paramètres
           input_box La boîte de saisie à dessiner.

   void MLV_free_input_box (MLV_Input_box * input_box)
       Cette fonction ferme une boîte de saisie précédement créée. L'espace mémoire allouée à la
       boîte de saisie est libéré.

       Paramètres
           input_box La boîte de saisie à fermer.

       Exemples
           medium/03_input_box_events.c.

   void MLV_suppress_history (MLV_Input_box * input_box)
       Cette fonction supprime l'historique d'une boîte de saisie.

       Paramètres
           input_box La boîte de saisie dont l'histoirque doit être supprimé

   void MLV_wait_input_box (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. 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.

       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
           top_left_corner_X La coordonnée en X du coin Nord-Ouest de la boîte de saisie.
           top_left_corner_Y La coordonnée en Y du coin Nord-Ouest de la boîte de saisie.
           width La largeur de la boîte de saisie.
           height La hauteur de la boîte de saisie.
           borderColor La couleur de la bordure de la boîte de saisie.
           textColor La couleur du texte de la boîte de saisie.
           backgroundColor La couleur de fond de la boîte de saisie.
           informativeMessage Le message à afficher devant la boîte de saisie.
           text L'addresse où sera placé la réponse donnée par l'utilisateur.

       Exemples
           beginner/07_input_box.c.

   void MLV_wait_input_box_with_font (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(), mais il est possible de changer la fonte du du texte.
       MLV_wait_input_box_with_font() 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
           top_left_corner_X La coordonnée en X du coin Nord-Ouest de la boîte de saisie.
           top_left_corner_Y La coordonnée en Y du coin Nord-Ouest de la boîte de saisie.
           width La largeur de la boîte de saisie.
           height La hauteur de la boîte de saisie.
           borderColor La couleur de la bordure de la boîte de saisie.
           textColor La couleur du texte de la boîte de saisie.
           backgroundColor La couleur de fond de la boîte de saisie.
           informativeMessage Le message à afficher devant la boîte de saisie.
           text L'addresse où sera placé la réponse donnée par l'utilisateur.
           font La font du texte à utiliser.

   void MLV_wait_particular_input_box (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.

       Paramètres
           input_box La boîte de saisie qui doit être observée.
           text Le texte récupéré par la boîte de saisie.

Auteur

       Généré automatiquement par Doxygen pour MLV-3.1.0 à partir du code source.