gui::region Class Reference

Simple GUI region (not renderable). More...

#include <gui_region.hpp>

Inheritance diagram for gui::region:

List of all members.

Public Member Functions
	region (manager *pManager)
	Constructor.
virtual	~region ()
	Destructor.
virtual void	render ()
	Renders this widget on the current render target.
virtual bool	is_in_region (int iX, int iY) const
	Checks if the provided coordinates are inside this region.
virtual void	create_glue ()
	Creates the associated Lua glue.
virtual void	parse_block (xml::block *pBlock)
	Parses data from an xml::block.
Protected Member Functions
virtual void	parse_attributes_ (xml::block *pBlock)

---

Detailed Description

Simple GUI region (not renderable).

Note:

It is the simplest derivate of uiobject, so if you just need a widget that has a position and a size (like frame's title region), then this is the best choice.

Definition at line 15 of file gui_region.hpp.

---

Constructor & Destructor Documentation

gui::region::region

(

manager *

pManager

)

[explicit]

Constructor.

Definition at line 5 of file gui_region.cpp.

gui::region::~region

(

)

[virtual]

Destructor.

Definition at line 10 of file gui_region.cpp.

---

Member Function Documentation

void gui::region::create_glue

(

)

[virtual]

Creates the associated Lua glue.

Implements gui::uiobject.

Reimplemented in gui::button, gui::check_button, gui::edit_box, gui::focus_frame, gui::font_string, gui::frame, gui::layered_region, gui::scroll_frame, gui::slider, gui::status_bar, and gui::texture.

Definition at line 18 of file gui_region.cpp.

bool gui::region::is_in_region	(	int	iX,
		int	iY
	)			const [virtual]

Checks if the provided coordinates are inside this region.

Parameters:

	iX	The horizontal coordinate
	iY	The vertical coordinate

Returns:

'true' if the provided coordinates are inside this region

Definition at line 27 of file gui_region.cpp.

void gui::region::parse_attributes_

(

xml::block *

pBlock

)

[protected, virtual]

Reimplemented in gui::frame, and gui::layered_region.

Definition at line 16 of file gui_region_parser.cpp.

void gui::region::parse_block

(

xml::block *

pBlock

)

[virtual]

Parses data from an xml::block.

Parameters:

pBlock

The frame's xml::block

Implements gui::uiobject.

Reimplemented in gui::button, gui::check_button, gui::edit_box, gui::focus_frame, gui::font_string, gui::frame, gui::layered_region, gui::scroll_frame, gui::slider, gui::status_bar, and gui::texture.

Definition at line 8 of file gui_region_parser.cpp.

void gui::region::render

(

)

[virtual]

Renders this widget on the current render target.

Note:

Does nothing.

Implements gui::uiobject.

Reimplemented in gui::font_string, gui::frame, and gui::texture.

Definition at line 14 of file gui_region.cpp.

---

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

• D:/Programmation/Sources/lxgui/bak/lxgui/gui/include/gui_region.hpp
• D:/Programmation/Sources/lxgui/bak/lxgui/gui/src/gui_region.cpp
• D:/Programmation/Sources/lxgui/bak/lxgui/gui/src/gui_region_parser.cpp