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 58 of file help_text_area.hpp.

Constructor & Destructor Documentation

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
	)

Definition at line 67 of file help_text_area.cpp.

References box, help::box_width, and rect.

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

Definition at line 83 of file help_text_area.cpp.

References box, help::box_width, and rect.

Member Data Documentation

ALIGNMENT help::help_text_area::item::align

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(), and help::help_text_area::get_min_x().

bool help::help_text_area::item::box

Definition at line 82 of file help_text_area.hpp.

Referenced by item().

bool help::help_text_area::item::floating

Definition at line 81 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().

SDL_Rect help::help_text_area::item::rect

Relative coordinates of this item.

Definition at line 68 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()().

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

Definition at line 77 of file help_text_area.hpp.

surface help::help_text_area::item::surf

Definition at line 70 of file help_text_area.hpp.

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

Definition at line 73 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