The Battle for Wesnoth  1.15.2+dev
Public Member Functions | Public Attributes | List of all members
help::help_text_area::item Struct Reference

An item that is displayed in the text area. More...

Public Member Functions

 item (surface surface, int x, int y, const std::string &text="", const std::string &reference_to="", bool floating=false, bool box=false, ALIGNMENT alignment=HERE)
 
 item (surface surface, int x, int y, bool floating, bool box=false, ALIGNMENT=HERE)
 

Public Attributes

SDL_Rect rect
 Relative coordinates of this item. More...
 
surface surf
 
std::string text
 
std::string ref_to
 
bool floating
 
bool box
 
ALIGNMENT align
 

Detailed Description

An item that is displayed in the text area.

Contains the surface that should be blitted along with some other information.

Definition at line 56 of file help_text_area.hpp.

Constructor & Destructor Documentation

◆ item() [1/2]

help::help_text_area::item::item ( surface  surface,
int  x,
int  y,
const std::string &  text = "",
const std::string &  reference_to = "",
bool  floating = false,
bool  box = false,
ALIGNMENT  alignment = HERE 
)

◆ item() [2/2]

help::help_text_area::item::item ( surface  surface,
int  x,
int  y,
bool  floating,
bool  box = false,
ALIGNMENT  alignment = HERE 
)

Definition at line 88 of file help_text_area.cpp.

References box, help::box_width, rect, gui::scrollarea::x, and gui::scrollarea::y.

Member Data Documentation

◆ align

ALIGNMENT help::help_text_area::item::align

◆ box

bool help::help_text_area::item::box

Definition at line 80 of file help_text_area.hpp.

Referenced by help::help_text_area::handle_img_cfg(), and item().

◆ floating

bool help::help_text_area::item::floating

◆ rect

SDL_Rect help::help_text_area::item::rect

◆ ref_to

std::string help::help_text_area::item::ref_to

Definition at line 75 of file help_text_area.hpp.

◆ surf

surface help::help_text_area::item::surf

◆ text

std::string help::help_text_area::item::text

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