---
name: "MLV_input_box.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_input_box.h"
---

# MLV\_input\_box.h(3)

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

## 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.