Documentation de la bibliothèque MLV-0.5

Définition de type | Fonctions

Référence du fichier MLV_prompt.h

Ce fichier définit tous les prototypes des fonctions permettant de demander à l'utilisateur du texte par l'intermédiaire de fenêtres. Plus de détails...

Aller au code source de ce fichier.

Définition de type

typedef struct _MLV_Prompt MLV_Prompt
 Définition du type des prompts.

Fonctions

void MLV_wait_prompt (int sommetHautGaucheX, int sommetHautGaucheY, int sommetBasDroitX, int sommetBasDroitY, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor, const char *informativeMessage, char **text)
 Suspend l'exécution du programme et demande du texte à l'utilisateur.
void MLV_wait_particular_prompt (MLV_Prompt *prompt, char **text)
 Suspend l'exécution du programme jusuq'à ce que l'utilisateur valide un texte dans le prompt passé en paramètre de la fonction.
MLV_PromptMLV_create_prompt (int sommetHautGaucheX, int sommetHautGaucheY, int width, int height, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor, const char *informativeMessage)
 Créé un prompt.
void MLV_free_prompt (MLV_Prompt *prompt)
 Ferme un prompt précédement créé.
void MLV_change_informative_message_of_prompt (MLV_Prompt *prompt, const char *message)
 Change le message d'entête d'un prompt.
void MLV_draw_prompt (MLV_Prompt *prompt)
 Dessine un prompt particulier.
void MLV_draw_all_prompt ()
 Dessine tous les prompts.
void MLV_suppress_history (MLV_Prompt *prompt)
 Supprime l'historique d'un prompt.
void MLV_change_prompt_geometry (MLV_Prompt *prompt, int sommetHautGaucheX, int sommetHautGaucheY, int width, int height)
 Change la taille et la position d'un prompt donné en paramètre.
void MLV_change_prompt_size (MLV_Prompt *prompt, int width, int height)
 change la taille d'un prompt
void MLV_change_prompt_position (MLV_Prompt *prompt, int sommetHautGaucheX, int sommetHautGaucheY)
 Change la position d'un prompt donné en paramètre.
void MLV_change_prompt_colors (MLV_Prompt *prompt, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor)
 Change les différentes couleurs d'un prompt donné.
void MLV_activate_prompt (MLV_Prompt *prompt)
 Active un prompt donnée. Cette opération agit comme si l'utilisateur avait cliqué sur le prompt en question.
void MLV_desactivate_prompt ()
 Désactive le prompt actif. Si il n'y a pas de prompt, actif, cette fonction ne fait rient.

Description détaillée

Ce fichier définit tous les prototypes des fonctions permettant de demander à l'utilisateur du texte par l'intermédiaire de fenêtres.

Auteur:
Adrien Boussicault
Marc Zipstein

Documentation des fonctions

void MLV_activate_prompt ( MLV_Prompt prompt  ) 

Active un prompt donnée. Cette opération agit comme si l'utilisateur avait cliqué sur le prompt en question.

Paramètres:
prompt Le prompt à activer.
void MLV_change_informative_message_of_prompt ( MLV_Prompt prompt,
const char *  message 
)

Change le message d'entête d'un prompt.

Paramètres:
prompt Prompt à modifier.
message Message d'entête.
void MLV_change_prompt_colors ( MLV_Prompt prompt,
MLV_Color  borderColor,
MLV_Color  textColor,
MLV_Color  backgroundColor 
)

Change les différentes couleurs d'un prompt donné.

Paramètres:
prompt Le prompt à modifier.
borderColor La nouvelle couleur du bord du prompt.
textColor La nouvelle couleur du texte du prompt.
backgroundColor La nouvelle couleur de fond du prompt.
void MLV_change_prompt_geometry ( MLV_Prompt prompt,
int  sommetHautGaucheX,
int  sommetHautGaucheY,
int  width,
int  height 
)

Change la taille et la position d'un prompt donné en paramètre.

Paramètres:
prompt Le prompt à modifier
sommetHautGaucheX La nouvelle coordonnée en X de la position du sommet Nord-Ouest du prompt.
sommetHautGaucheY La nouvelle coordonnée en Y de la position du sommet Nord-Ouest du prompt.
width La nouvelle largeur du prompt
height La nouvelle hauteur du prompt
void MLV_change_prompt_position ( MLV_Prompt prompt,
int  sommetHautGaucheX,
int  sommetHautGaucheY 
)

Change la position d'un prompt donné en paramètre.

Paramètres:
prompt L prompt à modifier
sommetHautGaucheX La nouvelle coordonnée en X de la position du sommet Nord-Ouest du prompt.
sommetHautGaucheY La nouvelle coordonnée en Y de la position du sommet Nord-Ouest du prompt.
void MLV_change_prompt_size ( MLV_Prompt prompt,
int  width,
int  height 
)

change la taille d'un prompt

Paramètres:
prompt Le prompt à modifier.
width La nouvelle largeur du prompt
height La nouvelle hauteur du prompt
MLV_Prompt* MLV_create_prompt ( int  sommetHautGaucheX,
int  sommetHautGaucheY,
int  width,
int  height,
MLV_Color  borderColor,
MLV_Color  textColor,
MLV_Color  backgroundColor,
const char *  informativeMessage 
)

Créé un prompt.

Une fois le prompt créé, si l'utilisateur clique dans la zone du prompt, le prompt devient actif. Cela veux dire que tout les évènements clavier sont récupérés par le prompt qui s'en sert pour enregistrer le texte tapé par l'utilisateur. De même, tout clique de souris réalisé dans la zonne du prompt est acaparé par le prompt.

Pour dessiner un prompt ou tous les prompts, dans la zone où vous l'avez créé, vous devez utiliser les fonctions : MLV_draw_prompt MLV_draw_all_prompt

Bogue:
Les prompt n'utilisent pas la meme police que les autres textes de la librairie MLV. Ce bug devrait disparaitre prochainement.
Paramètres:
sommetHautGaucheX Coordonnée en X du sommet Nord-Ouest du prompt.
sommetHautGaucheY Coordonnée en Y du sommet Nord-Ouest du prompt.
width Largeur du prompt
height Hauteur du prompt
borderColor Couleur de la bordure du prompt.
textColor Couleur du texte.
backgroundColor Couleur du fond.
informativeMessage Message d'entête du prompt.
Exemples:
medium/3_prompt_events.c, et medium/4_events.c.
void MLV_draw_prompt ( MLV_Prompt prompt  ) 

Dessine un prompt particulier.

Paramètres:
prompt Le prompt à dessiner.
void MLV_free_prompt ( MLV_Prompt prompt  ) 

Ferme un prompt précédement créé.

Paramètres:
prompt Le prompt à fermer.
Exemples:
medium/3_prompt_events.c.
void MLV_suppress_history ( MLV_Prompt prompt  ) 

Supprime l'historique d'un prompt.

Paramètres:
prompt Le prompt dont l'histoirque doit être supprimé
void MLV_wait_particular_prompt ( MLV_Prompt prompt,
char **  text 
)

Suspend l'exécution du programme jusuq'à ce que l'utilisateur valide un texte dans le prompt passé en paramètre de la fonction.

Paramètres:
prompt prompt qui doit être observé.
text text récupéré par le prompt.
void MLV_wait_prompt ( int  sommetHautGaucheX,
int  sommetHautGaucheY,
int  sommetBasDroitX,
int  sommetBasDroitY,
MLV_Color  borderColor,
MLV_Color  textColor,
MLV_Color  backgroundColor,
const char *  informativeMessage,
char **  text 
)

Suspend l'exécution du programme et demande du texte à l'utilisateur.

Suspend l'exécution du programme et affiche deux zones de textes. La première zone n'est pas modifiable et sert à afficher un message d'information. La deuxième est vide et peut être modifié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 des différents éléments sont paramétrables.

MLV_wait_prompt alloue lui même la mémoire associée au texte. Une fois l'espace mémoire alloué, il ne le libère à aucun moment. Cette tâche est laissé au programmeur.

Bogue:
Les prompt n'utilisent pas la meme police que les autres textes de la librairie MLV. Ce bug devrait disparaitre prochainement.
Paramètres:
sommetHautGaucheX Coordonnée en X du coin Nord-Ouest du prompt
sommetHautGaucheY Coordonnée en Y du coin Nord-Ouest du prompt
sommetBasDroitX Coordonnée en X du coin Sud-Est du prompt
sommetBasDroitY Coordonnée en Y du coin Sud-Est du prompt
borderColor Couleur de la bordure du prompt
textColor Couleur du texte du prompt
backgroundColor Couleur de fond du prompt
informativeMessage Message à afficher devant le prompt
text Addresse où sera placé la réponse donnée par l'utilisateur.
Exemples:
beginner/7_prompt.c.