# Documentation de la bibliothèque MLV-1.2.1

- Presentation
- Téléchargement
- Installation
- Compilation
- Exemples
- API
- Liste des fonctions
- bogues
- FAQ
- contacts

Fonctions
Référence du fichier MLV_input_box_va.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. Plus de détails...

Aller au code source de ce fichier.

## Fonctions
void | MLV_wait_input_box_va (int sommetHautGaucheX, int sommetHautGaucheY, int sommetBasDroitX, int sommetBasDroitY, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor, const char *informativeMessage, char **text, va_list pile)
| 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. Plus de détails...
void | MLV_wait_input_box_with_font_va (int sommetHautGaucheX, int sommetHautGaucheY, int sommetBasDroitX, int sommetBasDroitY, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor, const char *informativeMessage, char **text, const MLV_Font *font, va_list pile)
| Même chose que MLV_wait_input_box(), mais il est possible de changer la fonte du du texte. Plus de détails...
MLV_Input_box * | MLV_create_input_box_va (int sommetHautGaucheX, int sommetHautGaucheY, int width, int height, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor, const char *informativeMessage, va_list pile)
| Cette fonction créé une boîte de saisie. Plus de détails...
MLV_Input_box * | MLV_create_input_box_with_font_va (int sommetHautGaucheX, int sommetHautGaucheY, int width, int height, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor, const char *informativeMessage, const MLV_Font *font, va_list pile)
| Cette fonction créé une boîte de saisie avec une font spécifique. Plus de détails...
void | MLV_change_informative_message_of_input_box_va (MLV_Input_box *input_box, const char *message, va_list pile)
| Cette fonction change le message d'entête d'une boîte de saisie. Plus de détails...

## 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_change_informative_message_of_input_box_va | ( | MLV_Input_box * | input_box,
|  | const char * | message,
|  | va_list | pile
| ) |  |

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.
  pile | La pile des complements de paramètres comme dans vaprintf.

MLV_Input_box* MLV_create_input_box_va | ( | int | sommetHautGaucheX,
|  | int | sommetHautGaucheY,
|  | int | width,
|  | int | height,
|  | MLV_Color | borderColor,
|  | MLV_Color | textColor,
|  | MLV_Color | backgroundColor,
|  | const char * | informativeMessage,
|  | va_list | pile
| ) |  |

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

  sommetHautGaucheX | La coordonnée en X du sommet Nord-Ouest de la boîte de saisie.
  sommetHautGaucheY | 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.
  pile | La pile des complements de paramètres comme dans vaprintf.

MLV_Input_box* MLV_create_input_box_with_font_va | ( | int | sommetHautGaucheX,
|  | int | sommetHautGaucheY,
|  | int | width,
|  | int | height,
|  | MLV_Color | borderColor,
|  | MLV_Color | textColor,
|  | MLV_Color | backgroundColor,
|  | const char * | informativeMessage,
|  | const MLV_Font * | font,
|  | va_list | pile
| ) |  |

Cette fonction créé une boîte de saisie avec une font spécifique.

Paramètres

  sommetHautGaucheX | La coordonnée en X du sommet Nord-Ouest de la boîte de saisie.
  sommetHautGaucheY | 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.
  pile | La pile des complements de paramètres comme dans vaprintf.

void MLV_wait_input_box_va | ( | int | sommetHautGaucheX,
|  | int | sommetHautGaucheY,
|  | int | sommetBasDroitX,
|  | int | sommetBasDroitY,
|  | MLV_Color | borderColor,
|  | MLV_Color | textColor,
|  | MLV_Color | backgroundColor,
|  | const char * | informativeMessage,
|  | char ** | text,
|  | va_list | pile
| ) |  |

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

  sommetHautGaucheX | La coordonnée en X du coin Nord-Ouest de la boîte de saisie.
  sommetHautGaucheY | La coordonnée en Y du coin Nord-Ouest de la boîte de saisie.
  sommetBasDroitX | La coordonnée en X du coin Sud-Est de la boîte de saisie.
  sommetBasDroitY | La coordonnée en Y du coin Sud-Est 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.
  pile | La pile des complements de paramètres comme dans vaprintf.

void MLV_wait_input_box_with_font_va | ( | int | sommetHautGaucheX,
|  | int | sommetHautGaucheY,
|  | int | sommetBasDroitX,
|  | int | sommetBasDroitY,
|  | MLV_Color | borderColor,
|  | MLV_Color | textColor,
|  | MLV_Color | backgroundColor,
|  | const char * | informativeMessage,
|  | char ** | text,
|  | const MLV_Font * | font,
|  | va_list | pile
| ) |  |

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

  sommetHautGaucheX | La coordonnée en X du coin Nord-Ouest de la boîte de saisie.
  sommetHautGaucheY | La coordonnée en Y du coin Nord-Ouest de la boîte de saisie.
  sommetBasDroitX | La coordonnée en X du coin Sud-Est de la boîte de saisie.
  sommetBasDroitY | La coordonnée en Y du coin Sud-Est 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.
  pile | La pile des complements de paramètres comme dans vaprintf.