The Battle for Wesnoth  1.17.0-dev
Public Member Functions | Private Member Functions | Private Attributes | List of all members
font::floating_label Class Reference

#include <floating_label.hpp>

Public Member Functions

 floating_label (const std::string &text, const surface &surface=nullptr)
 
void set_font_size (int font_size)
 
void set_position (double xpos, double ypos)
 
void set_move (double xmove, double ymove)
 
void set_lifetime (int lifetime, int fadeout=100)
 
void set_color (const color_t &color)
 
void set_bg_color (const color_t &bg_color)
 
void set_border_size (int border)
 
void set_width (int w)
 
void set_height (int h)
 
void set_clip_rect (const SDL_Rect &r)
 
void set_alignment (ALIGN align)
 
void set_scroll_mode (LABEL_SCROLL_MODE scroll)
 
void use_markup (bool b)
 
void move (double xmove, double ymove)
 
void draw (int time, surface screen)
 
void undraw (surface screen)
 
surface create_surface ()
 
bool expired (int time) const
 
void show (const bool value)
 
LABEL_SCROLL_MODE scroll () const
 

Private Member Functions

int get_time_alive (int current_time) const
 
int xpos (std::size_t width) const
 
SDL_Point get_loc (int time)
 
surface get_surface (int time)
 

Private Attributes

surface surf_
 
surface buf_
 
SDL_Rect buf_pos_
 
int fadeout_
 
int time_start_
 
std::string text_
 
int font_size_
 
color_t color_
 
color_t bgcolor_
 
int bgalpha_
 
double xpos_
 
double ypos_
 
double xmove_
 
double ymove_
 
int lifetime_
 
int width_
 
int height_
 
SDL_Rect clip_rect_
 
bool visible_
 
font::ALIGN align_
 
int border_
 
LABEL_SCROLL_MODE scroll_
 
bool use_markup_
 

Detailed Description

Definition at line 38 of file floating_label.hpp.

Constructor & Destructor Documentation

◆ floating_label()

font::floating_label::floating_label ( const std::string &  text,
const surface &  surface = nullptr 
)

Definition at line 44 of file floating_label.cpp.

Member Function Documentation

◆ create_surface()

surface font::floating_label::create_surface ( )

Definition at line 93 of file floating_label.cpp.

References adjust_surface_alpha(), color_t::b, bgalpha_, bgcolor_, border_, clip_rect_, color_, ERR_FT, sdl::fill_surface_rect(), font::FONT_SANS_SERIF, font_size_, ftofxp, color_t::g, font::get_text_renderer(), height_, color_t::r, font::pango_text::render(), sdl_blit(), font::pango_text::set_alignment(), font::pango_text::set_characters_per_line(), font::pango_text::set_ellipse_mode(), font::pango_text::set_family_class(), font::pango_text::set_font_size(), font::pango_text::set_font_style(), font::pango_text::set_foreground_color(), font::pango_text::set_link_aware(), font::pango_text::set_maximum_height(), font::pango_text::set_maximum_width(), font::pango_text::set_text(), shadow_image(), font::pango_text::STYLE_NORMAL, surf_, text_, use_markup_, and width_.

Referenced by draw().

◆ draw()

void font::floating_label::draw ( int  time,
surface  screen 
)

Definition at line 167 of file floating_label.cpp.

References buf_, buf_pos_, clip_rect_, sdl::create_rect(), create_surface(), get_loc(), get_surface(), sdl_blit(), sdl_copy_portion(), surf_, and visible_.

◆ expired()

bool font::floating_label::expired ( int  time) const
inline

Definition at line 77 of file floating_label.hpp.

◆ get_loc()

SDL_Point font::floating_label::get_loc ( int  time)
private

Definition at line 207 of file floating_label.cpp.

References get_time_alive(), surf_, xmove_, xpos(), ymove_, and ypos_.

Referenced by draw().

◆ get_surface()

surface font::floating_label::get_surface ( int  time)
private

Definition at line 216 of file floating_label.cpp.

References adjust_surface_alpha_add(), fadeout_, get_time_alive(), lifetime_, and surf_.

Referenced by draw().

◆ get_time_alive()

int font::floating_label::get_time_alive ( int  current_time) const
inlineprivate

Definition at line 85 of file floating_label.hpp.

Referenced by get_loc(), and get_surface().

◆ move()

void font::floating_label::move ( double  xmove,
double  ymove 
)

Definition at line 75 of file floating_label.cpp.

References xpos_, and ypos_.

◆ scroll()

LABEL_SCROLL_MODE font::floating_label::scroll ( ) const
inline

Definition at line 81 of file floating_label.hpp.

◆ set_alignment()

void font::floating_label::set_alignment ( ALIGN  align)
inline

Definition at line 67 of file floating_label.hpp.

Referenced by show_tooltip(), and gui::floating_textbox::update_location().

◆ set_bg_color()

void font::floating_label::set_bg_color ( const color_t &  bg_color)
inline

Definition at line 58 of file floating_label.hpp.

References color_t::a.

Referenced by CVideo::set_help_string(), and show_tooltip().

◆ set_border_size()

void font::floating_label::set_border_size ( int  border)
inline

Definition at line 62 of file floating_label.hpp.

Referenced by CVideo::set_help_string(), and show_tooltip().

◆ set_clip_rect()

void font::floating_label::set_clip_rect ( const SDL_Rect &  r)
inline

Definition at line 66 of file floating_label.hpp.

Referenced by display::announce(), game_lua_kernel::intf_print(), playmp_controller::play_human_turn(), display::set_diagnostic(), show_tooltip(), and gui::floating_textbox::update_location().

◆ set_color()

void font::floating_label::set_color ( const color_t &  color)
inline

Definition at line 57 of file floating_label.hpp.

Referenced by display::announce(), terrain_label::draw(), game_display::float_label(), game_lua_kernel::intf_print(), playmp_controller::play_human_turn(), display::set_diagnostic(), show_tooltip(), and gui::floating_textbox::update_location().

◆ set_font_size()

void font::floating_label::set_font_size ( int  font_size)
inline

Definition at line 43 of file floating_label.hpp.

Referenced by display_chat_manager::add_chat_message(), display::announce(), game_display::float_label(), game_lua_kernel::intf_print(), display::set_diagnostic(), CVideo::set_help_string(), show_tooltip(), and display::update_display().

◆ set_height()

void font::floating_label::set_height ( int  h)
inline

Definition at line 65 of file floating_label.hpp.

References h.

◆ set_lifetime()

void font::floating_label::set_lifetime ( int  lifetime,
int  fadeout = 100 
)

Definition at line 199 of file floating_label.cpp.

References fadeout_, lifetime_, and time_start_.

Referenced by display::announce(), game_display::float_label(), game_lua_kernel::intf_print(), and playmp_controller::play_human_turn().

◆ set_move()

void font::floating_label::set_move ( double  xmove,
double  ymove 
)
inline

Definition at line 51 of file floating_label.hpp.

Referenced by game_display::float_label().

◆ set_position()

void font::floating_label::set_position ( double  xpos,
double  ypos 
)
inline

Definition at line 46 of file floating_label.hpp.

Referenced by display::announce(), game_display::float_label(), game_lua_kernel::intf_print(), playmp_controller::play_human_turn(), display::set_diagnostic(), CVideo::set_help_string(), and gui::floating_textbox::update_location().

◆ set_scroll_mode()

void font::floating_label::set_scroll_mode ( LABEL_SCROLL_MODE  scroll)
inline

Definition at line 68 of file floating_label.hpp.

Referenced by game_display::float_label().

◆ set_width()

void font::floating_label::set_width ( int  w)
inline

Definition at line 64 of file floating_label.hpp.

References w.

Referenced by show_tooltip().

◆ show()

void font::floating_label::show ( const bool  value)
inline

Definition at line 79 of file floating_label.hpp.

◆ undraw()

void font::floating_label::undraw ( surface  screen)

Definition at line 229 of file floating_label.cpp.

References buf_, buf_pos_, clip_rect_, and sdl_blit().

◆ use_markup()

void font::floating_label::use_markup ( bool  b)
inline

Definition at line 69 of file floating_label.hpp.

References b.

Referenced by show_tooltip().

◆ xpos()

int font::floating_label::xpos ( std::size_t  width) const
private

Definition at line 81 of file floating_label.cpp.

References align_, font::CENTER_ALIGN, font::RIGHT_ALIGN, and xpos_.

Referenced by get_loc().

Member Data Documentation

◆ align_

font::ALIGN font::floating_label::align_
private

Definition at line 102 of file floating_label.hpp.

Referenced by xpos().

◆ bgalpha_

int font::floating_label::bgalpha_
private

Definition at line 96 of file floating_label.hpp.

Referenced by create_surface().

◆ bgcolor_

color_t font::floating_label::bgcolor_
private

Definition at line 95 of file floating_label.hpp.

Referenced by create_surface().

◆ border_

int font::floating_label::border_
private

Definition at line 103 of file floating_label.hpp.

Referenced by create_surface().

◆ buf_

surface font::floating_label::buf_
private

Definition at line 89 of file floating_label.hpp.

Referenced by draw(), and undraw().

◆ buf_pos_

SDL_Rect font::floating_label::buf_pos_
private

Definition at line 90 of file floating_label.hpp.

Referenced by draw(), and undraw().

◆ clip_rect_

SDL_Rect font::floating_label::clip_rect_
private

Definition at line 100 of file floating_label.hpp.

Referenced by create_surface(), draw(), and undraw().

◆ color_

color_t font::floating_label::color_
private

Definition at line 95 of file floating_label.hpp.

Referenced by create_surface().

◆ fadeout_

int font::floating_label::fadeout_
private

Definition at line 91 of file floating_label.hpp.

Referenced by get_surface(), and set_lifetime().

◆ font_size_

int font::floating_label::font_size_
private

Definition at line 94 of file floating_label.hpp.

Referenced by create_surface().

◆ height_

int font::floating_label::height_
private

Definition at line 99 of file floating_label.hpp.

Referenced by create_surface().

◆ lifetime_

int font::floating_label::lifetime_
private

Definition at line 98 of file floating_label.hpp.

Referenced by get_surface(), and set_lifetime().

◆ scroll_

LABEL_SCROLL_MODE font::floating_label::scroll_
private

Definition at line 104 of file floating_label.hpp.

◆ surf_

surface font::floating_label::surf_
private

Definition at line 89 of file floating_label.hpp.

Referenced by create_surface(), draw(), get_loc(), and get_surface().

◆ text_

std::string font::floating_label::text_
private

Definition at line 93 of file floating_label.hpp.

Referenced by create_surface().

◆ time_start_

int font::floating_label::time_start_
private

Definition at line 92 of file floating_label.hpp.

Referenced by set_lifetime().

◆ use_markup_

bool font::floating_label::use_markup_
private

Definition at line 105 of file floating_label.hpp.

Referenced by create_surface().

◆ visible_

bool font::floating_label::visible_
private

Definition at line 101 of file floating_label.hpp.

Referenced by draw().

◆ width_

int font::floating_label::width_
private

Definition at line 99 of file floating_label.hpp.

Referenced by create_surface().

◆ xmove_

double font::floating_label::xmove_
private

Definition at line 97 of file floating_label.hpp.

Referenced by get_loc().

◆ xpos_

double font::floating_label::xpos_
private

Definition at line 97 of file floating_label.hpp.

Referenced by move(), and xpos().

◆ ymove_

double font::floating_label::ymove_
private

Definition at line 97 of file floating_label.hpp.

Referenced by get_loc().

◆ ypos_

double font::floating_label::ypos_
private

Definition at line 97 of file floating_label.hpp.

Referenced by get_loc(), and move().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13