Documentation of the MLV-0.6.713 library

/*
 *   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/>.
 */

#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

typedef struct _MLV_Input_box MLV_Input_box;

void MLV_wait_input_box(
        int sommetHautGaucheX, int sommetHautGaucheY,
        int sommetBasDroitX, int sommetBasDroitY,
        MLV_Color borderColor, MLV_Color textColor,
        MLV_Color backgroundColor,
        const char* informativeMessage,
        char** text
);

void MLV_wait_input_box_with_font(
        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
);


void MLV_wait_particular_input_box( MLV_Input_box* input_box, char** text);


MLV_Input_box* MLV_create_input_box(
        int sommetHautGaucheX, int sommetHautGaucheY,
        int width, int height,
        MLV_Color borderColor, MLV_Color textColor,
        MLV_Color backgroundColor,
        const char* informativeMessage
);

MLV_Input_box* MLV_create_input_box_with_font(
        int sommetHautGaucheX, int sommetHautGaucheY,
        int width, int height,
        MLV_Color borderColor, MLV_Color textColor,
        MLV_Color backgroundColor,
        const char* informativeMessage,
        const MLV_Font* font
);


void MLV_free_input_box( MLV_Input_box* input_box );

void MLV_change_informative_message_of_input_box(
        MLV_Input_box* input_box, const char* message
);

void MLV_draw_input_box( MLV_Input_box* input_box );

void MLV_draw_all_input_boxes();

void MLV_suppress_history( MLV_Input_box* input_box );

void MLV_change_input_box_geometry(
        MLV_Input_box* input_box,  int sommetHautGaucheX, int sommetHautGaucheY,
        int width, int height
);

void MLV_change_input_box_size(MLV_Input_box* input_box, int width, int height);

void MLV_change_input_box_position(
        MLV_Input_box* input_box, int sommetHautGaucheX, int sommetHautGaucheY
);

void MLV_change_input_box_colors( 
        MLV_Input_box* input_box,  MLV_Color borderColor, MLV_Color textColor,
        MLV_Color backgroundColor
);

void MLV_activate_input_box( MLV_Input_box* input_box );

void MLV_desactivate_input_box( );

#ifdef __cplusplus
}
#endif

#endif