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_TEXT_H__
#define __MLV__MLV_TEXT_H__

#include "MLV_color.h"
#include "MLV_image.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
        MLV_TEXT_CENTER, 
        MLV_TEXT_LEFT, 
        MLV_TEXT_RIGHT 
} MLV_Text_justification;

typedef enum {
        MLV_HORIZONTAL_CENTER, 
        MLV_HORIZONTAL_LEFT, 
        MLV_HORIZONTAL_RIGHT 
} MLV_Horizontal_position;

typedef enum {
        MLV_VERTICAL_CENTER, 
        MLV_VERTICAL_TOP, 
        MLV_VERTICAL_BOTTOM 
} MLV_Vertical_position;

typedef struct _MLV_Font MLV_Font;

MLV_Font* MLV_load_font( const char* file_font, int size );

void MLV_free_font( MLV_Font* font );

void MLV_get_size_of_text( const char *text, int *width, int *height );

void MLV_get_size_of_text_with_font(
        const char *text, int *width, int *height, const MLV_Font* font
);

void MLV_draw_text(int x, int y, const char *text, MLV_Color color);

void MLV_draw_text_with_font(
        int x, int y, const char *text, const MLV_Font* font, MLV_Color color
);

void MLV_draw_text_on_image(
        int x, int y, const char *text, MLV_Color color, MLV_Image* image
);

void MLV_draw_text_with_font_on_image(
        int x, int y, const char *text, const MLV_Font* font, MLV_Color color, 
        MLV_Image* image
);

void MLV_draw_adapted_text_box(
        int x, int y,
        const char* message,
        int sizeInterligne,
        MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
        MLV_Text_justification text_justification
);

void MLV_draw_adapted_text_box_on_image(
        int x, int y,
        const char* message,
        int sizeInterligne,
        MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
        MLV_Text_justification text_justification,
        MLV_Image* image
);

int MLV_get_size_of_adapted_text_box(
        const char* message,
        int sizeInterligne,
        int *result_width, int *result_height
);

void MLV_draw_adapted_text_box_with_font(
        int x, int y,
        const char* message,
        const MLV_Font* font, 
        int sizeInterligne,
        MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
        MLV_Text_justification text_justification
);

void MLV_draw_adapted_text_box_with_font_on_image(
        int x, int y,
        const char* message,
        const MLV_Font* font, 
        int sizeInterligne,
        MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
        MLV_Text_justification text_justification,
        MLV_Image* image
);


int MLV_get_size_of_adapted_text_box_with_font(
        const char* message,
        const MLV_Font* font, 
        int sizeInterligne,
        int *result_width, int *result_height
);

void MLV_draw_text_box( 
        int x, int y, 
        int width, int height, 
        const char* message , 
        int sizeInterligne,
        MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
        MLV_Text_justification text_justification,
        MLV_Horizontal_position horizontal_position,
        MLV_Vertical_position vertical_position
);

void MLV_draw_text_box_on_image( 
        int x, int y, 
        int width, int height, 
        const char* message , 
        int sizeInterligne,
        MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
        MLV_Text_justification text_justification,
        MLV_Horizontal_position horizontal_position,
        MLV_Vertical_position vertical_position,
        MLV_Image* image
);

void MLV_draw_text_box_with_font( 
        int x, int y, 
        int width, int height, 
        const char* message , 
        const MLV_Font* font, 
        int sizeInterligne,
        MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
        MLV_Text_justification text_justification,
        MLV_Horizontal_position horizontal_position,
        MLV_Vertical_position vertical_position
);

void MLV_draw_text_box_with_font_on_image( 
        int x, int y, 
        int width, int height, 
        const char* message , 
        MLV_Font* font, 
        int sizeInterligne,
        MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
        MLV_Text_justification text_justification,
        MLV_Horizontal_position horizontal_position,
        MLV_Vertical_position vertical_position,
        MLV_Image* image
);

char* MLV_convert_unicode_to_string( int unicode );

#ifdef __cplusplus
}
#endif

#endif