The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui::label Class Reference

#include <label.hpp>

Inheritance diagram for gui::label:
Inheritance graph

Public Member Functions

 label (CVideo &video, const std::string &text, int size=font::SIZE_NORMAL, const SDL_Color &color=font::NORMAL_COLOR, const bool auto_join=true)
 
const std::stringset_text (const std::string &text)
 
const std::stringget_text () const
 
const SDL_Color & set_color (const SDL_Color &color)
 
const SDL_Color & get_color () const
 
virtual void draw_contents ()
 
- Public Member Functions inherited from gui::widget
SDL_Rect const & location () const
 
virtual void set_location (SDL_Rect const &rect)
 
void set_location (int x, int y)
 
void set_width (int w)
 
void set_height (int h)
 
void set_measurements (int w, int h)
 
int width () const
 
int height () const
 
bool focus (const SDL_Event *event)
 
void set_focus (bool focus)
 
virtual void hide (bool value=true)
 
bool hidden () const
 
virtual void enable (bool new_val=true)
 
bool enabled () const
 
void set_clip_rect (const SDL_Rect &rect)
 
void set_volatile (bool val=true)
 
void set_dirty (bool dirty=true)
 
bool dirty () const
 
const std::stringid () const
 
void set_id (const std::string &id)
 
void set_help_string (const std::string &str)
 
void set_tooltip_string (const std::string &str)
 
virtual void process_help_string (int mousex, int mousey)
 
virtual void process_tooltip_string (int mousex, int mousey)
 
- Public Member Functions inherited from events::sdl_handler
virtual void process_event ()
 
virtual bool requires_event_focus (const SDL_Event *=nullptr) const
 
virtual void join ()
 
virtual void join (context &c)
 
virtual void join_same (sdl_handler *parent)
 
virtual void leave ()
 
virtual void join_global ()
 
virtual void leave_global ()
 

Private Member Functions

void update_label_size ()
 

Private Attributes

std::string text_
 
int size_
 
SDL_Color color_
 

Additional Inherited Members

- Protected Member Functions inherited from gui::widget
 widget (widget const &o)
 
 widget (CVideo &video, const bool auto_join=true)
 
virtual ~widget ()
 
void bg_register (SDL_Rect const &rect)
 
void bg_restore () const
 
void bg_restore (SDL_Rect const &rect) const
 
void bg_update ()
 
void bg_cancel ()
 
CVideovideo () const
 
virtual void draw ()
 
virtual void update_location (SDL_Rect const &rect)
 
const SDL_Rect * clip_rect () const
 
virtual sdl_handler_vector member_handlers ()
 
virtual void handle_event (SDL_Event const &)
 
virtual void handle_window_event (SDL_Event const &event)
 
bool mouse_locked () const
 
void aquire_mouse_lock ()
 
void free_mouse_lock ()
 
- Protected Member Functions inherited from events::sdl_handler
 sdl_handler (const bool auto_join=true)
 
virtual ~sdl_handler ()
 
virtual std::vector
< sdl_handler * > 
handler_members ()
 
- Protected Attributes inherited from gui::widget
bool focus_
 

Detailed Description

Definition at line 25 of file label.hpp.

Constructor & Destructor Documentation

gui::label::label ( CVideo video,
const std::string text,
int  size = font::SIZE_NORMAL,
const SDL_Color &  color = font::NORMAL_COLOR,
const bool  auto_join = true 
)

Definition at line 26 of file label.cpp.

References font::render_text(), and update_label_size().

Member Function Documentation

void gui::label::draw_contents ( )
virtual

Reimplemented from gui::widget.

Definition at line 70 of file label.cpp.

References font::draw_text(), get_color(), gui::widget::location(), size_, text_, and gui::widget::video().

const SDL_Color & gui::label::get_color ( ) const

Definition at line 65 of file label.cpp.

References color_, font::DISABLED_COLOR, and gui::widget::enabled().

Referenced by draw_contents(), and set_color().

const std::string & gui::label::get_text ( ) const

Definition at line 50 of file label.cpp.

References text_.

Referenced by mp::ui::append_to_title(), gui::dialog::layout(), and gui::dialog::show().

const SDL_Color & gui::label::set_color ( const SDL_Color &  color)

Definition at line 55 of file label.cpp.

References color_, get_color(), font::render_text(), and gui::widget::set_dirty().

const std::string & gui::label::set_text ( const std::string text)
void gui::label::update_label_size ( )
private

Definition at line 81 of file label.cpp.

References gui::widget::set_measurements(), size_, text_, and font::text_area().

Referenced by label(), and set_text().

Member Data Documentation

SDL_Color gui::label::color_
private

Definition at line 46 of file label.hpp.

Referenced by get_color(), and set_color().

int gui::label::size_
private

Definition at line 45 of file label.hpp.

Referenced by draw_contents(), and update_label_size().

std::string gui::label::text_
private

Definition at line 44 of file label.hpp.

Referenced by draw_contents(), get_text(), set_text(), and update_label_size().


The documentation for this class was generated from the following files: