/*
* UltraStar Deluxe - Karaoke Game
*
* UltraStar Deluxe is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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 2
* of the License, or (at your option) any later version.
*
* This program 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 program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef TEXT_HPP
#define TEXT_HPP
#include <string>
#include <ftgl.h>
#include <boost/thread/shared_mutex.hpp>
#include <log4cpp/Category.hh>
#include "drawable_control.hpp"
#include "container.hpp"
#include "utils/point.hpp"
#include "vertical_text_alignment.hpp"
namespace usdx
{
class Text : public DrawableControl
{
private:
static log4cpp::Category& log;
/**
* text that should be displayed
*/
std::string text;
/**
* If true, the text may overlap the rectangle of the control, otherwise
* it will be cut off, if the text is larger than the rectangle.
*/
bool auto_size;
/**
* If true, and the text to long and would exceeds the bounds,
* the font size is shirked until the text fit to the
* bounds. (Works only if auto size is false.)
*/
bool stretch;
/**
* Offset of the baseline of the text to the top left corner of the
* control.
*/
Point<int> offset;
FTFont *font;
const VerticalTextAlignment *valign;
mutable boost::shared_mutex font_mutex;
/**
* This function is used to recalculate the offset of the drawn
* text. It should be called every time the text or the font size is
* changed.
*
* @see: offset
*/
void realign(void);
/**
* Helper to create a Rectangle<int> object out of an FTBBox. This is
* used for converting the BBox from ftgl to the common internal format.
*/
static Rectangle<int> makeRect(const FTBBox& bbox);
protected:
virtual void draw(void);
public:
Text(Container*, const std::string = "", const unsigned int = 60,
const VerticalTextAlignment* = new VerticalTextAlignmentTop());
virtual ~Text();
void set_font_size(const unsigned int value);
unsigned int get_font_size(void) const;
void set_text(const std::string value);
std::string get_text(void) const;
virtual void set_size(const Dimension<int>& size);
virtual void set_size(int width, int height);
void set_auto_size(const bool value);
bool get_auto_size(void) const;
};
};
#endif
