gui2::tpanel Class Reference

Visible container to hold multiple widgets. More...

#include <panel.hpp>

Inheritance diagram for gui2::tpanel:

Collaboration diagram for gui2::tpanel:

List of all members.

Public Member Functions
	tpanel (const unsigned canvas_count=2)
	Constructor.
virtual SDL_Rect	get_client_rect () const
	Returns the client rect.
bool	get_active () const
	Inherited from tcontrol.
unsigned	get_state () const
	Inherited from tcontrol.
Private Member Functions
void	impl_draw_background (surface &frame_buffer)
	Inherited from tcontrol.
void	impl_draw_background (surface &frame_buffer, int x_offset, int y_offset)
void	impl_draw_foreground (surface &frame_buffer)
	Inherited from tcontrol.
void	impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset)
const std::string &	get_control_type () const
	Inherited from tcontrol.
tpoint	border_space () const
	Inherited from tcontainer_.
void	set_self_active (const bool)
	Inherited from tcontainer_.

---

Detailed Description

Visible container to hold multiple widgets.

This widget can draw items beyond the widgets it holds and in front of them. A panel is always active so these functions return dummy values.

Definition at line 29 of file panel.hpp.

---

Constructor & Destructor Documentation

gui2::tpanel::tpanel

(

const unsigned

canvas_count = 2

)

[inline, explicit]

Constructor.

Parameters:

canvas_count

The canvas count for tcontrol.

Definition at line 39 of file panel.hpp.

---

Member Function Documentation

tpoint gui2::tpanel::border_space

(

)

const [private, virtual]

Inherited from tcontainer_.

Reimplemented from gui2::tcontainer_.

Definition at line 87 of file panel.cpp.

References gui2::tcontrol::config().

Here is the call graph for this function:

bool gui2::tpanel::get_active

(

)

const [inline, virtual]

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 55 of file panel.hpp.

SDL_Rect gui2::tpanel::get_client_rect

(

)

const [virtual]

Returns the client rect.

The client rect is the area which is used for child items. The rest of the area of this widget is used for its own decoration.

Returns:

The client rect.

Reimplemented from gui2::tcontainer_.

Definition at line 34 of file panel.cpp.

const std::string & gui2::tpanel::get_control_type

(

)

const [private, virtual]

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 97 of file panel.cpp.

References type.

unsigned gui2::tpanel::get_state

(

)

const [inline, virtual]

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 58 of file panel.hpp.

void gui2::tpanel::impl_draw_background

(

surface &

frame_buffer

)

[private, virtual]

Inherited from tcontrol.

Reimplemented from gui2::tcontrol.

Definition at line 49 of file panel.cpp.

References gui2::tcontrol::canvas(), DBG_GUI_D, gui2::twidget::get_rect(), and LOG_HEADER.

Here is the call graph for this function:

void gui2::tpanel::impl_draw_background	(	surface &	frame_buffer,
		int	x_offset,
		int	y_offset
	)			[private, virtual]

Reimplemented from gui2::tcontrol.

Definition at line 58 of file panel.cpp.

References gui2::twidget::calculate_blitting_rectangle(), gui2::tcontrol::canvas(), DBG_GUI_D, gui2::twidget::get_rect(), and LOG_HEADER.

Here is the call graph for this function:

void gui2::tpanel::impl_draw_foreground

(

surface &

frame_buffer

)

[private, virtual]

Inherited from tcontrol.

Reimplemented from gui2::tcontrol.

Definition at line 72 of file panel.cpp.

References gui2::tcontrol::canvas(), and gui2::twidget::get_rect().

Here is the call graph for this function:

void gui2::tpanel::impl_draw_foreground	(	surface &	frame_buffer,
		int	x_offset,
		int	y_offset
	)			[private, virtual]

Reimplemented from gui2::tcontrol.

Definition at line 77 of file panel.cpp.

References gui2::twidget::calculate_blitting_rectangle(), and gui2::tcontrol::canvas().

Here is the call graph for this function:

void gui2::tpanel::set_self_active

(

const

bool

)

[inline, private, virtual]

Inherited from tcontainer_.

Implements gui2::tcontainer_.

Definition at line 83 of file panel.hpp.

---

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

• gui/widgets/panel.hpp
• gui/widgets/panel.cpp