#include <TabWnd.h>

Inheritance diagram for GG::TabWnd:

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

Wnd *	CurrentWnd () const

std::size_t	CurrentWndIndex () const

const TabBar *	GetTabBar () const

const OverlayWnd *	GetOverlayWnd () 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)

Wnd *	RemoveWnd (const std::string &name)

void	SetCurrentWnd (std::size_t index)

Additional Inherited Members
Public Types inherited from GG::Wnd
enum	ChildClippingMode { DontClip, ClipToClient, ClipToWindow, ClipToClientAndWindowSeparately }

typedef std::map< const Wnd *, bool >::iterator	DropsAcceptableIter

Public Member Functions inherited from GG::Wnd
virtual	~Wnd ()

bool	Interactive () const

bool	RepeatButtonDown () const

bool	Dragable () const

bool	Resizable () const

bool	OnTop () const

bool	Modal () const

ChildClippingMode	GetChildClippingMode () const

bool	NonClientChild () const

bool	Visible () const

const std::string &	Name () const

const std::string &	DragDropDataType () const

virtual void	DropsAcceptable (DropsAcceptableIter first, DropsAcceptableIter last, const Pt &pt) const

Pt	UpperLeft () const

Pt	LowerRight () const

Pt	RelativeUpperLeft () const

Pt	RelativeLowerRight () const

X	Width () const

Y	Height () const

int	ZOrder () const

Pt	Size () const

Pt	MinSize () const

Pt	MaxSize () const

virtual Pt	ClientUpperLeft () const

virtual Pt	ClientLowerRight () const

Pt	ClientSize () const

X	ClientWidth () const

Y	ClientHeight () const

Pt	ScreenToWindow (const Pt &pt) const

Pt	ScreenToClient (const Pt &pt) const

virtual bool	InWindow (const Pt &pt) const

virtual bool	InClient (const Pt &pt) const

const std::list< Wnd * > &	Children () const

Wnd *	Parent () const

Wnd *	RootParent () const

Layout *	GetLayout () const

Layout *	ContainingLayout () const

const std::vector < BrowseInfoMode > &	BrowseModes () const

const std::string &	BrowseInfoText (std::size_t mode) const

const boost::shared_ptr < StyleFactory > &	GetStyleFactory () const

virtual WndRegion	WindowRegion (const Pt &pt) const

void	SetDragDropDataType (const std::string &data_type)

virtual void	StartingChildDragDrop (const Wnd *wnd, const Pt &offset)

virtual void	AcceptDrops (const std::vector< Wnd * > &wnds, const Pt &pt)

virtual void	CancellingChildDragDrop (const std::vector< const Wnd * > &wnds)

virtual void	ChildrenDraggedAway (const std::vector< Wnd * > &wnds, const Wnd *destination)

void	SetName (const std::string &name)

void	Hide (bool children=true)

void	Show (bool children=true)

virtual void	ModalInit ()

void	SetChildClippingMode (ChildClippingMode mode)

void	NonClientChild (bool b)

void	MoveTo (const Pt &pt)

void	OffsetMove (const Pt &pt)

virtual void	SizeMove (const Pt &ul, const Pt &lr)

void	Resize (const Pt &sz)

void	SetMinSize (const Pt &sz)

void	SetMaxSize (const Pt &sz)

void	AttachChild (Wnd *wnd)

void	MoveChildUp (Wnd *wnd)

void	MoveChildDown (Wnd *wnd)

void	DetachChild (Wnd *wnd)

void	DetachChildren ()

void	DeleteChild (Wnd *wnd)

void	DeleteChildren ()

void	InstallEventFilter (Wnd *wnd)

void	RemoveEventFilter (Wnd *wnd)

void	HorizontalLayout ()

void	VerticalLayout ()

void	GridLayout ()

void	SetLayout (Layout *layout)

void	RemoveLayout ()

Layout *	DetachLayout ()

void	SetLayoutBorderMargin (unsigned int margin)

void	SetLayoutCellMargin (unsigned int margin)

virtual void	Render ()

virtual bool	Run ()

void	EndRun ()

void	SetBrowseModeTime (unsigned int time, std::size_t mode=0)

void	SetBrowseInfoWnd (const boost::shared_ptr< BrowseInfoWnd > &wnd, std::size_t mode=0)

void	ClearBrowseInfoWnd (std::size_t mode=0)

void	SetBrowseText (const std::string &text, std::size_t mode=0)

void	SetBrowseModes (const std::vector< BrowseInfoMode > &modes)

void	SetStyleFactory (const boost::shared_ptr< StyleFactory > &factory)

	GG_ABSTRACT_EXCEPTION (Exception)

	GG_CONCRETE_EXCEPTION (BadLayout, GG::Wnd, Exception)

Static Public Member Functions inherited from GG::Wnd
static unsigned int	DefaultBrowseTime ()

static void	SetDefaultBrowseTime (unsigned int time)

static const boost::shared_ptr < BrowseInfoWnd > &	DefaultBrowseInfoWnd ()

static void	SetDefaultBrowseInfoWnd (const boost::shared_ptr< BrowseInfoWnd > &browse_info_wnd)

Protected Types inherited from GG::Wnd
enum	DragDropRenderingState { NOT_DRAGGED, IN_PLACE_COPY, DRAGGED_OVER_UNACCEPTING_DROP_TARGET, DRAGGED_OVER_ACCEPTING_DROP_TARGET }

Protected Member Functions inherited from GG::Wnd
	Wnd ()

	Wnd (X x, Y y, X w, Y h, Flags< WndFlag > flags=INTERACTIVE\|DRAGABLE)

DragDropRenderingState	GetDragDropRenderingState () const

virtual void	LButtonDown (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	LDrag (const Pt &pt, const Pt &move, Flags< ModKey > mod_keys)

virtual void	LButtonUp (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	LClick (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	LDoubleClick (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	MButtonDown (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	MDrag (const Pt &pt, const Pt &move, Flags< ModKey > mod_keys)

virtual void	MButtonUp (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	MClick (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	MDoubleClick (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	RButtonDown (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	RDrag (const Pt &pt, const Pt &move, Flags< ModKey > mod_keys)

virtual void	RButtonUp (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	RClick (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	RDoubleClick (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	MouseEnter (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	MouseHere (const Pt &pt, Flags< ModKey > mod_keys)

virtual void	MouseLeave ()

virtual void	MouseWheel (const Pt &pt, int move, Flags< ModKey > mod_keys)

virtual void	DragDropEnter (const Pt &pt, const std::map< Wnd *, Pt > &drag_drop_wnds, Flags< ModKey > mod_keys)

virtual void	DragDropHere (const Pt &pt, const std::map< Wnd *, Pt > &drag_drop_wnds, Flags< ModKey > mod_keys)

virtual void	DragDropLeave ()

virtual void	KeyPress (Key key, boost::uint32_t key_code_point, Flags< ModKey > mod_keys)

virtual void	KeyRelease (Key key, boost::uint32_t key_code_point, Flags< ModKey > mod_keys)

virtual void	GainingFocus ()

virtual void	LosingFocus ()

virtual void	TimerFiring (unsigned int ticks, Timer *timer)

virtual bool	EventFilter (Wnd *w, const WndEvent &event)

void	HandleEvent (const WndEvent &event)

void	ForwardEventToParent ()

void	BeginClipping ()

void	EndClipping ()

void	BeginNonclientClipping ()

void	EndNonclientClipping ()

Protected Attributes inherited from GG::Wnd
bool	m_done

Detailed Description

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

Definition at line 121 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 128 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 181 of file TabWnd.h.

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

TabWnd.h

Public Attributes

Static Public Attributes

Signal Types

Structors

Accessors

Mutators

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation