gui::layered_region Class Reference

Abstract GUI renderable. More...

#include <gui_layeredregion.hpp>

Inheritance diagram for gui::layered_region:

List of all members.

Public Member Functions
	layered_region (manager *pManager)
	Constructor.
virtual	~layered_region ()
	Destructor.
virtual std::string	serialize (const std::string &sTab) const
	Prints all relevant information about this widget in a string.
virtual void	create_glue ()
	Creates the associated Lua glue.
virtual void	set_parent (uiobject *pParent)
	Changes this widget's parent.
virtual void	show ()
	shows this widget.
virtual void	hide ()
	hides this widget.
virtual bool	is_visible () const
	Checks if this widget can be seen on the screen.
layer_type	get_draw_layer ()
	Returns this layered_region's draw layer.
virtual void	set_draw_layer (layer_type mLayer)
	Sets this layered_region's draw layer.
virtual void	set_draw_layer (const std::string &sLayer)
	Sets this layered_region's draw layer.
virtual void	notify_renderer_need_redraw () const
	Notifies the renderer of this widget that it needs to be redrawn.
virtual void	parse_block (xml::block *pBlock)
	Parses data from an xml::block.
Protected Member Functions
virtual void	parse_attributes_ (xml::block *pBlock)
Protected Attributes
layer_type	mLayer_
frame *	pFrameParent_

---

Detailed Description

Abstract GUI renderable.

Note:

layered regions are contained inside frames.
They are sorted by layers, hence their name.

Definition at line 21 of file gui_layeredregion.hpp.

---

Constructor & Destructor Documentation

gui::layered_region::layered_region

(

manager *

pManager

)

[explicit]

Constructor.

Definition at line 12 of file gui_layeredregion.cpp.

gui::layered_region::~layered_region

(

)

[virtual]

Destructor.

Definition at line 18 of file gui_layeredregion.cpp.

---

Member Function Documentation

void gui::layered_region::create_glue

(

)

[virtual]

Creates the associated Lua glue.

Reimplemented from gui::region.

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

Definition at line 42 of file gui_layeredregion.cpp.

layer_type gui::layered_region::get_draw_layer

(

)

Returns this layered_region's draw layer.

Returns:

this layered_region's draw layer

Definition at line 80 of file gui_layeredregion.cpp.

void gui::layered_region::hide

(

)

[virtual]

hides this widget.

Note:

All its children won't be visible on the screen anymore, even if they are still marked as shown.

Reimplemented from gui::uiobject.

Definition at line 66 of file gui_layeredregion.cpp.

bool gui::layered_region::is_visible

(

)

const [virtual]

Checks if this widget can be seen on the screen.

Returns:

'true' if this widget can be seen on the screen

Reimplemented from gui::uiobject.

Definition at line 75 of file gui_layeredregion.cpp.

void gui::layered_region::notify_renderer_need_redraw

(

)

const [virtual]

Notifies the renderer of this widget that it needs to be redrawn.

Note:

Automatically called by any shape changing function.

Reimplemented from gui::uiobject.

Definition at line 124 of file gui_layeredregion.cpp.

void gui::layered_region::parse_attributes_

(

xml::block *

pBlock

)

[protected, virtual]

Reimplemented from gui::region.

Definition at line 18 of file gui_layeredregion_parser.cpp.

void gui::layered_region::parse_block

(

xml::block *

pBlock

)

[virtual]

Parses data from an xml::block.

Parameters:

pBlock

The frame's xml::block

Reimplemented from gui::region.

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

Definition at line 10 of file gui_layeredregion_parser.cpp.

std::string gui::layered_region::serialize

(

const std::string &

sTab

)

const [virtual]

Prints all relevant information about this widget in a string.

Parameters:

sTab

The offset to give to all lines

Returns:

All relevant information about this widget

Reimplemented from gui::uiobject.

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

Definition at line 22 of file gui_layeredregion.cpp.

void gui::layered_region::set_draw_layer

(

const std::string &

sLayer

)

[virtual]

Sets this layered_region's draw layer.

Parameters:

sLayer

The new layer

Definition at line 95 of file gui_layeredregion.cpp.

void gui::layered_region::set_draw_layer

(

layer_type

mLayer

)

[virtual]

Sets this layered_region's draw layer.

Parameters:

mLayer

The new layer

Definition at line 85 of file gui_layeredregion.cpp.

void gui::layered_region::set_parent

(

uiobject *

pParent

)

[virtual]

Changes this widget's parent.

Parameters:

pParent

The new parent

Note:

Default is nullptr.

Definition at line 51 of file gui_layeredregion.cpp.

void gui::layered_region::show

(

)

[virtual]

shows this widget.

Note:

Its parent must be shown for it to appear on the screen.

Reimplemented from gui::uiobject.

Definition at line 57 of file gui_layeredregion.cpp.

---

Member Data Documentation

layer_type gui::layered_region::mLayer_ [protected]

Definition at line 92 of file gui_layeredregion.hpp.

frame* gui::layered_region::pFrameParent_ [protected]

Definition at line 93 of file gui_layeredregion.hpp.

---

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

• D:/Programmation/Sources/lxgui/bak/lxgui/gui/include/gui_layeredregion.hpp
• D:/Programmation/Sources/lxgui/bak/lxgui/gui/src/gui_layeredregion.cpp
• D:/Programmation/Sources/lxgui/bak/lxgui/gui/src/gui_layeredregion_parser.cpp