help::help_text_area::item Struct Reference

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

Public Member Functions
	item (const texture &tex, int x, int y, const std::string &text="", const std::string &reference_to="", bool floating=false, bool box=false, ALIGNMENT alignment=HERE)
	item (const texture &tex, int x, int y, bool floating, bool box=false, ALIGNMENT=HERE)

Public Attributes
rect	rect_
	Relative coordinates of this item. More...
texture	tex
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 60 of file help_text_area.hpp.

Constructor & Destructor Documentation

item() [1/2]

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

Definition at line 74 of file help_text_area.cpp.

References box, help::box_width, texture::h(), rect_, tex, texture::w(), gui::scrollarea::x, and gui::scrollarea::y.

item() [2/2]

help::help_text_area::item::item	(	const texture &	tex,
		int	x,
		int	y,
		bool	floating,
		bool	box = false,
		ALIGNMENT	alignment = HERE
	)

Definition at line 90 of file help_text_area.cpp.

References box, help::box_width, texture::h(), rect_, tex, texture::w(), gui::scrollarea::x, and gui::scrollarea::y.

Member Data Documentation

align

ALIGNMENT help::help_text_area::item::align

Definition at line 85 of file help_text_area.hpp.

Referenced by help::help_text_area::add_item(), help::help_text_area::get_max_x(), and help::help_text_area::get_min_x().

box

bool help::help_text_area::item::box

Definition at line 84 of file help_text_area.hpp.

Referenced by item().

floating

bool help::help_text_area::item::floating

Definition at line 83 of file help_text_area.hpp.

Referenced by help::help_text_area::add_item(), help::help_text_area::get_max_x(), help::help_text_area::get_min_x(), and help::help_text_area::get_y_for_floating_img().

rect_

rect help::help_text_area::item::rect_

Relative coordinates of this item.

Definition at line 70 of file help_text_area.hpp.

Referenced by help::help_text_area::add_item(), help::help_text_area::adjust_last_row(), help::help_text_area::get_max_x(), help::help_text_area::get_min_x(), help::help_text_area::get_y_for_floating_img(), item(), and help::help_text_area::item_at::operator()().

ref_to

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

Definition at line 79 of file help_text_area.hpp.

tex

texture help::help_text_area::item::tex

Definition at line 72 of file help_text_area.hpp.

Referenced by item().

text

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

Definition at line 75 of file help_text_area.hpp.

---

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

• help/help_text_area.hpp
• help/help_text_area.cpp