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_MOUSE_H__
#define __MLV__MLV_MOUSE_H__

#ifndef MEMORY_DEBUG
#include <SDL/SDL.h>
#else
#include "memory_debug.h"
#endif

#include "MLV_device_with_buttons.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum{
        MLV_BUTTON_LEFT = SDL_BUTTON_LEFT, 
        MLV_BUTTON_MIDDLE = SDL_BUTTON_MIDDLE, 
        MLV_BUTTON_RIGHT = SDL_BUTTON_RIGHT 
} MLV_Mouse_button;

void MLV_wait_mouse(int *x, int *y);

int MLV_wait_mouse_or_seconds(int *x, int *y, int seconds);

const char* MLV_convert_mouse_button_to_string( MLV_Mouse_button button_code );

MLV_Mouse_button MLV_convert_string_to_mouse_button( const char* button_string );

void MLV_get_mouse_position( int* x, int* y );

MLV_Button_state MLV_get_mouse_button_state( MLV_Mouse_button mouse_button );

#ifdef __cplusplus
}
#endif

#endif