Documentation of the MLV-2.0.2 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_EVENT_H__
#define __MLV__MLV_EVENT_H__

#include "MLV_device_with_buttons.h"
#include "MLV_keyboard.h"
#include "MLV_mouse.h"
#include "MLV_input_box.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
        MLV_NONE = 0, 
        MLV_KEY = 1, 
        MLV_INPUT_BOX = 2, 
        MLV_MOUSE_BUTTON = 3, 
        MLV_MOUSE_MOTION = 4 
} MLV_Event;


MLV_Event MLV_get_event( 
        MLV_Keyboard_button* key_sym, MLV_Keyboard_modifier* key_mod, int* unicode, 
        char** texte, MLV_Input_box** input_box,
        int* mouse_x, int* mouse_y, MLV_Mouse_button* mouse_button,
        MLV_Button_state* state
);



MLV_Event MLV_wait_event( 
        MLV_Keyboard_button* key_sym, MLV_Keyboard_modifier* key_mod, int* unicode,
        char** texte, MLV_Input_box** input_box,
        int* mouse_x, int* mouse_y, MLV_Mouse_button* mouse_button,
        MLV_Button_state* state
);


MLV_Event MLV_wait_event_or_seconds( 
        MLV_Keyboard_button* key_sym, MLV_Keyboard_modifier* key_mod, int* unicode,
        char** texte, MLV_Input_box** input_box,
        int* mouse_x, int* mouse_y, MLV_Mouse_button* mouse_button,
        MLV_Button_state* state, int seconds
);



void MLV_flush_event_queue();

MLV_Event MLV_wait_keyboard_or_mouse(
        MLV_Keyboard_button* sym, MLV_Keyboard_modifier* mod, int* unicode,
        int* mouse_x, int* mouse_y
);


MLV_Event MLV_wait_keyboard_or_mouse_or_seconds(
        MLV_Keyboard_button* sym, MLV_Keyboard_modifier* mod, int* unicode,
        int* mouse_x, int* mouse_y,
        int seconds
);

const char* MLV_convert_event_to_string( MLV_Event event_code );

MLV_Event MLV_convert_string_to_event( const char* event_string );

const char* MLV_convert_button_state_to_string( MLV_Button_state state_code );

MLV_Button_state MLV_convert_string_to_button_state( const char* state_string );

#ifdef __cplusplus
}
#endif

#endif