This file is indexed.

/usr/include/MLV/MLV_input_box.h is in libmlv3-dev 3.1.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
/*
 *   This file is part of the MLV Library.
 *
 *   Copyright (C) 2010,2011,2012 Adrien Boussicault, Marc Zipstein
 *
 *
 *    This Library is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This Library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this Library.  If not, see <http://www.gnu.org/licenses/>.
 */

/** \~french 
 * \file MLV_input_box.h
 *
 * \author Adrien Boussicault
 * \author Marc Zipstein
 *
 * \brief Ce fichier définit les prototypes des fonctions permettant de 
 *        demander à l'utilisateur du texte par l'intermédiaire de boîtes 
 *        de saisie.
 *
 */

#ifndef __MLV__MLV_INPUT_BOX_H__
#define __MLV__MLV_INPUT_BOX_H__

#include "MLV_color.h"
#include "MLV_text.h"

#ifdef __cplusplus
extern "C" {
#endif

/** \~french 
 * \brief Définition du type des boîtes de saisies
 *
 */
typedef struct _MLV_Input_box MLV_Input_box;

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

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

/** \~french 
 * \brief 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 input_box La boîte de saisie qui doit être observée.
 * \param text Le texte récupéré par la boîte de saisie.
 */
void MLV_wait_particular_input_box( MLV_Input_box* input_box, char** text);

/** \~french 
 * \brief 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 top_left_corner_X La coordonnée en X du sommet Nord-Ouest de la boîte 
 *                          de saisie.
 * \param top_left_corner_Y La coordonnée en Y du sommet Nord-Ouest de la boîte 
 *                          de saisie.
 * \param width La largeur de la boîte de saisie.
 * \param height La hauteur de la boîte de saisie.
 * \param borderColor La couleur de la bordure de la boîte de saisie.
 * \param textColor La couleur du texte.
 * \param backgroundColor La couleur du fond.
 * \param informativeMessage La message d'entête 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, ...
);

/** \~french 
 * \brief Cette fonction créé une boîte de saisie avec une font spécifique.
 *
 * \param top_left_corner_X La coordonnée en X du sommet Nord-Ouest de la boîte de saisie.
 * \param top_left_corner_Y La coordonnée en Y du sommet Nord-Ouest de la boîte de saisie.
 * \param width La largeur de la boîte de saisie.
 * \param height La hauteur de la boîte de saisie.
 * \param borderColor La couleur de la bordure de la boîte de saisie.
 * \param textColor La couleur du texte.
 * \param backgroundColor La couleur du fond.
 * \param informativeMessage Le message d'entête de la boîte de saisie.
 * \param font La font à utiliser pour le texte.
 */
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, ...
);


/** \~french 
 * \brief 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 input_box La boîte de saisie à fermer.
 */
void MLV_free_input_box( MLV_Input_box* input_box );

/** \~french 
 * \brief Cette fonction change le message d'entête d'une boîte de saisie.
 *
 * \param input_box La boîte de saisie à modifier.
 * \param message Le message d'entête.
 */
void MLV_change_informative_message_of_input_box(
	MLV_Input_box* input_box, const char* message, ...
);

/** \~french 
 * \brief Cette fonction dessine une boîte de saisie particulière.
 *
 * \param input_box La boîte de saisie à dessiner.
 */
void MLV_draw_input_box( MLV_Input_box* input_box );

/** \~french 
 * \brief Cette fonction dessine tous les boîtes de saisies.
 *

 */
void MLV_draw_all_input_boxes();

/** \~french 
 * \brief Cette fonction supprime l'historique d'une boîte de saisie.
 *
 * \param input_box La boîte de saisie dont l'histoirque doit être supprimé
 */
void MLV_suppress_history( MLV_Input_box* input_box );

/** \~french 
 * \brief Cette fonction change la taille et la position d'une boîte de saisie donnée en paramètre.
 *
 * \param input_box La boîte de saisie à modifier.
 * \param top_left_corner_X La nouvelle coordonnée en X de la position du sommet
 *                          Nord-Ouest de la boîte de saisie.
 * \param top_left_corner_Y La nouvelle coordonnée en Y de la position du sommet
 *                          Nord-Ouest de la boîte de saisie.
 * \param width La nouvelle largeur de la boîte de saisie.
 * \param height La nouvelle hauteur 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
);

/** \~french 
 * \brief Cette fonction change la taille d'une boîte de saisie.
 *
 * \param input_box La boîte de saisie à modifier.
 * \param width La nouvelle largeur de la boîte de saisie.
 * \param height La nouvelle hauteur de la boîte de saisie.
 */
void MLV_change_input_box_size(MLV_Input_box* input_box, int width, int height);

/** \~french 
 * \brief Cette fonction change la position d'une boîte de saisie donnée en paramètre.
 *
 * \param input_box La boîte de saisie à modifier.
 * \param top_left_corner_X La nouvelle coordonnée en X de la position du sommet
 *                          Nord-Ouest de la boîte de saisie.
 * \param 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_position(
	MLV_Input_box* input_box, int top_left_corner_X, int top_left_corner_Y
);

/** \~french 
 * \brief Cette fonction change les différentes couleurs d'une boîte de saisie donnée
 *
 * \param input_box La boîte de saisie à modifier.
 * \param borderColor La nouvelle couleur du bord de la boîte de saisie.
 * \param textColor La nouvelle couleur du texte de la boîte de saisie.
 * \param backgroundColor La nouvelle couleur de fond de la boîte de saisie.
 */
void MLV_change_input_box_colors( 
	MLV_Input_box* input_box,  MLV_Color borderColor, MLV_Color textColor,
	MLV_Color backgroundColor
);

/** \~french 
 * \brief 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 input_box La boîte de saisie à activer.
 */
void MLV_activate_input_box( MLV_Input_box* input_box );

/** \~french 
 * \brief 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_desactivate_input_box( );

#ifdef __cplusplus
}
#endif

#endif