GG::TabWnd Class Reference

Contains several Wnds and a TabBar, and only displays the Wnd currently selected in the TabBar. More...

#include <TabWnd.h>

Inheritance diagram for GG::TabWnd:

List of all members.

Signal Types
typedef boost::signal< void(int)>	WndChangedSignalType
Slot Types
typedef WndChangedSignalType::slot_type	WndChangedSlotType
Structors
	TabWnd (int x, int y, int w, int h, const boost::shared_ptr< Font > &font, Clr color, Clr text_color=CLR_BLACK, TabBarStyle style=TAB_BAR_ATTACHED, Flags< WndFlag > flags=CLICKABLE|DRAGABLE)
Accessors
virtual Pt	MinUsableSize () const
Wnd *	CurrentWnd () const
int	CurrentWndIndex () const
Mutators
virtual void	Render ()
int	AddWnd (Wnd *wnd, const std::string &name)
void	InsertWnd (int index, Wnd *wnd, const std::string &name)
Wnd *	RemoveWnd (const std::string &name)
void	SetCurrentWnd (int index)
Structors
	TabWnd ()
Public Attributes
WndChangedSignalType	WndChangedSignal
Static Public Attributes
static const int	NO_WND

---

Detailed Description

Contains several Wnds and a TabBar, and only displays the Wnd currently selected in the TabBar.

Definition at line 42 of file TabWnd.h.

---

Member Typedef Documentation

typedef boost::signal<void (int)> GG::TabWnd::WndChangedSignalType

Emitted when the currently-selected Wnd has changed; the new selected Wnd's index in the group is provided (this may be NO_WND if no Wnd is currently selected).

Definition at line 48 of file TabWnd.h.

typedef WndChangedSignalType::slot_type GG::TabWnd::WndChangedSlotType

Type of functor(s) invoked on a WndChangedSignalType.

Definition at line 52 of file TabWnd.h.

---

Constructor & Destructor Documentation

GG::TabWnd::TabWnd	(	int	x,
		int	y,
		int	w,
		int	h,
		const boost::shared_ptr< Font > &	font,
		Clr	color,
		Clr	text_color = CLR_BLACK,
		TabBarStyle	style = TAB_BAR_ATTACHED,
		Flags< WndFlag >	flags = CLICKABLE|DRAGABLE
	)

Basic ctor.

GG::TabWnd::TabWnd

(

)

[protected]

default ctor

---

Member Function Documentation

virtual Pt GG::TabWnd::MinUsableSize

(

)

const [virtual]

returns the size of the minimum bounding box that can enclose the Wnd and still show all of its elements, plus enough room for interaction with those elements (if applicable).

For example, a TextControl's MinUsableSize() is just the area of its text, and a Scroll's RenderableMinSize() is the combined sizes of its up-button, down-button, and tab (plus a bit of room in which to drag the tab).

Reimplemented from GG::Wnd.

Wnd* GG::TabWnd::CurrentWnd

(

)

const

Returns the Wnd currently visible in the TabWnd, or 0 if there is none.

int GG::TabWnd::CurrentWndIndex

(

)

const

Returns the index into the sequence of Wnds in this TabWnd of the Wnd currently shown.

NO_WND is returned if there is no Wnd currently visible.

virtual void GG::TabWnd::Render

(

)

[virtual]

draws this Wnd.

Note that Wnds being dragged for a drag-and-drop operation are rendered twice -- once in-place as normal, once in the location of the drag operation, attached to the cursor. Such Wnds may wish to render themselves differently in those two cases. To determine which render is being performed, they can call GUI::GetGUI()->RenderingDragDropWnds().

Reimplemented from GG::Wnd.

int GG::TabWnd::AddWnd	(	Wnd *	wnd,
		const std::string &	name
	)

Adds wnd to the sequence of Wnds in this TabWnd, with name name.

name can be used later to remove the Wnd (name is not checked for uniqueness). Returns the index at which wnd is placed.

void GG::TabWnd::InsertWnd	(	int	index,
		Wnd *	wnd,
		const std::string &	name
	)

Adds wnd to the sequence of Wnds in this TabWnd, inserting it at the index location within the sequence.

name can be used later to remove the Wnd (name is not checked for uniqueness). Not range checked.

Wnd* GG::TabWnd::RemoveWnd

(

const std::string &

name

)

Removes and returns the first Wnd previously added witht he name name from the sequence of Wnds in this TabWnd.

void GG::TabWnd::SetCurrentWnd

(

int

index

)

Sets the currently visible Wnd in the sequence to the Wnd in the index position within the sequence.

Not range checked.

---

Member Data Documentation

WndChangedSignalType GG::TabWnd::WndChangedSignal [mutable]

The Wnd change signal object for this Button.

Definition at line 97 of file TabWnd.h.

const int GG::TabWnd::NO_WND [static]

The invalid Wnd position index that there is no currently-selected Wnd.

Definition at line 100 of file TabWnd.h.

---

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

• TabWnd.h

---