GG
Public Attributes | Static Public Attributes

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:
GG::Wnd

List of all members.

Public Attributes

WndChangedSignalType WndChangedSignal

Static Public Attributes

static const std::size_t NO_WND

Signal Types

typedef boost::signal< void(std::size_t)> WndChangedSignalType

Structors

 TabWnd (X x, Y y, X w, Y h, const boost::shared_ptr< Font > &font, Clr color, Clr text_color=CLR_BLACK, TabBarStyle style=TAB_BAR_ATTACHED, Flags< WndFlag > flags=INTERACTIVE)
 TabWnd ()

Accessors

virtual Pt MinUsableSize () const
bool Empty () const
std::size_t NumWnds () const
WndCurrentWnd () const
std::size_t CurrentWndIndex () const
const TabBarGetTabBar () const
const OverlayWndGetOverlayWnd () const
const std::map< std::string,
Wnd * > & 
WndNames () const

Mutators

std::size_t AddWnd (Wnd *wnd, const std::string &name)
void InsertWnd (std::size_t index, Wnd *wnd, const std::string &name)
WndRemoveWnd (const std::string &name)
void SetCurrentWnd (std::size_t index)

Detailed Description

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

Definition at line 125 of file TabWnd.h.


Member Typedef Documentation

typedef boost::signal<void (std::size_t)> 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 132 of file TabWnd.h.


Constructor & Destructor Documentation

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

Basic 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 MinUsableSize() 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.

bool GG::TabWnd::Empty ( ) const

Returns true iff NumWnds() == 0.

std::size_t GG::TabWnd::NumWnds ( ) const

Returns the number of tabs currently in this TabWnd.

Wnd* GG::TabWnd::CurrentWnd ( ) const

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

std::size_t 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.

std::size_t 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 ( std::size_t  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, or 0 if no such Wnd is found.

void GG::TabWnd::SetCurrentWnd ( std::size_t  index)

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

const TabBar* GG::TabWnd::GetTabBar ( ) const [protected]

Returns the TabBar at the top of this TabWnd.

const OverlayWnd* GG::TabWnd::GetOverlayWnd ( ) const [protected]

Returns the OverlayWnd in this TabWnd.

const std::map<std::string, Wnd*>& GG::TabWnd::WndNames ( ) const [protected]

Returns the set of Wnds currently controlled by this TabWnd, indexed by name.


Member Data Documentation

const std::size_t GG::TabWnd::NO_WND [static]

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

Definition at line 185 of file TabWnd.h.


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