marked-up_text.cpp File Reference

Support for simple markup in text (fonts, colors, images). More...

#include "global.hpp"
#include "font.hpp"
#include "gettext.hpp"
#include "marked-up_text.hpp"
#include "serialization/string_utils.hpp"
#include "video.hpp"
#include "wml_exception.hpp"

Include dependency graph for marked-up_text.cpp:

Go to the source code of this file.

Namespaces
namespace	font
	Graphical text output.
Defines
#define	GETTEXT_DOMAIN   "wesnoth-lib"
Functions
std::string::const_iterator	font::parse_markup (std::string::const_iterator i1, std::string::const_iterator i2, int *font_size, SDL_Color *color, int *style)
	Parses the markup-tags at the front of a string.
std::string	font::del_tags (const std::string &text)
	Copy string, but without tags at the beginning.
std::string	font::color2markup (const SDL_Color &color)
	Create string of color-markup, such as "<255,255,0>" for yellow.
std::string	font::color2hexa (const SDL_Color &color)
	Creates the hexadecimal string of a color, such as "#ffff00" for yellow.
std::string	font::span_color (const SDL_Color &color)
	Creates pango markup of a color.
SDL_Rect	font::text_area (const std::string &text, int size, int style=0)
	Calculate the size of a text (in pixels) if it were to be drawn.
SDL_Rect	font::draw_text (surface dst, const SDL_Rect &area, int size, const SDL_Color &color, const std::string &text, int x, int y, bool use_tooltips=false, int style=0)
	Function to draw text on a surface.
SDL_Rect	font::draw_text (CVideo *gui, const SDL_Rect &area, int size, const SDL_Color &color, const std::string &text, int x, int y, bool use_tooltips=false, int style=0)
	wrapper of the previous function, gui can also be NULL
bool	font::is_format_char (char c)
	Determine if char is one of the special chars used as markup.
bool	font::is_cjk_char (const wchar_t ch)
	Determine if a wchar_t is a CJK character.
static void	font::cut_word (std::string &line, std::string &word, int font_size, int style, int max_width)
std::string	font::word_wrap_text (const std::string &unwrapped_text, int font_size, int max_width, int max_height=-1, int max_lines=-1, bool partial_line=false)
	Wrap text.
SDL_Rect	font::draw_wrapped_text (CVideo *gui, const SDL_Rect &area, int font_size, const SDL_Color &color, const std::string &text, int x, int y, int max_width)
	Draw text on the screen, fit text to maximum width, no markup, no tooltips.
Variables
const char	font::LARGE_TEXT = '*'
	Standard markups for color, size, font, images.
const char	font::SMALL_TEXT = '`'
const char	font::BOLD_TEXT = '~'
const char	font::NORMAL_TEXT = '{'
const char	font::NULL_MARKUP = '^'
const char	font::BLACK_TEXT = '}'
const char	font::GRAY_TEXT = '|'
const char	font::GOOD_TEXT = '@'
const char	font::BAD_TEXT = '#'
const char	font::GREEN_TEXT = '@'
const char	font::RED_TEXT = '#'
const char	font::COLOR_TEXT = '<'
const char	font::IMAGE = '&'
const std::string	font::weapon = "<245,230,193>"
const std::string	font::weapon_details = "<166,146,117>"
const std::string	font::unit_type = "<245,230,193>"
const std::string	font::race = "<166,146,117>"
const SDL_Color	font::weapon_color = { 245, 230, 193, 255 }
const SDL_Color	font::good_dmg_color = { 130, 240, 50, 255 }
const SDL_Color	font::bad_dmg_color = { 250, 140, 80, 255 }
const SDL_Color	font::weapon_details_color = { 166, 146, 117, 255 }
const SDL_Color	font::unit_type_color = { 245, 230, 193, 255 }
const SDL_Color	font::race_color = { 166, 146, 117, 255 }
const std::string	font::weapon_numbers_sep = "–"
const std::string	font::weapon_details_sep = "–"

---

Detailed Description

Support for simple markup in text (fonts, colors, images).

E.g. "@Victory" will be shown in green.

Definition in file marked-up_text.cpp.

---

Define Documentation

#define GETTEXT_DOMAIN   "wesnoth-lib"

Definition at line 22 of file marked-up_text.cpp.