PLGui::TabContainer Class Reference

Tab container. More...

#include <TabContainer.h>

Inheritance diagram for PLGui::TabContainer:

List of all members.

Public Member Functions
PLGUI_API	TabContainer (Widget *pParent=nullptr)
	Constructor.
virtual PLGUI_API	~TabContainer ()
	Destructor.
PLGUI_API ESide	GetSide () const
	Get side the tabbar is positioned on.
PLGUI_API void	SetSide (ESide nSide)
	Set side the tabbar is positioned on.
PLGUI_API PLCore::uint32	GetOptions () const
	Get TabBar options.
PLGUI_API void	SetOptions (PLCore::uint32 nOptions)
	Set TabBar options.
PLGUI_API PLCore::uint32	GetTabWidth () const
	Get tab width.
PLGUI_API void	SetTabWidth (PLCore::uint32 nWidth)
	Set tab width.
PLGUI_API PLCore::uint32	GetTabHeight () const
	Get tab height.
PLGUI_API void	SetTabHeight (PLCore::uint32 nHeight)
	Set tab height.
Public Attributes
PLCore::Event	EventCreateWindow
PLCore::EventHandler < TabBarEntry * >	EventHandlerCloseTab
PLCore::EventHandler< int >	EventHandlerSelectTab
PLCore::EventHandler	EventHandlerCreateTab
TabBar *	m_pTabBar
Protected Member Functions
PLGUI_API void	OnCreateWindow ()
	Called when a new window shall be created.
virtual PLGUI_API void	OnAddWindow (Widget *pWindow)
	Called when a window has been added.
virtual PLGUI_API void	OnRemoveWindow (Widget *pWindow)
	Called when a window has been removed.
virtual PLGUI_API void	OnSelectWindow (int nWindow)
	Called when the current selection has been changed.
virtual PLGUI_API void	OnAdjustContent ()
	Called when the widget content has to be adjusted.

---

Detailed Description

Tab container.

---

Constructor & Destructor Documentation

PLGUI_API PLGui::TabContainer::TabContainer

(

Widget *

pParent = nullptr

)

Constructor.

Parameters:

[in]

pParent

Pointer to parent widget

virtual PLGUI_API PLGui::TabContainer::~TabContainer

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLGUI_API ESide PLGui::TabContainer::GetSide

(

)

const

Get side the tabbar is positioned on.

Returns:

Side

PLGUI_API void PLGui::TabContainer::SetSide

(

ESide

nSide

)

Set side the tabbar is positioned on.

Parameters:

[in]

nSide

Side

PLGUI_API PLCore::uint32 PLGui::TabContainer::GetOptions

(

)

const

Get TabBar options.

Returns:

TabBar options (combination of ETabBarOption values)

PLGUI_API void PLGui::TabContainer::SetOptions

(

PLCore::uint32

nOptions

)

Set TabBar options.

Parameters:

[in]

nOptions

TabBar options

PLGUI_API PLCore::uint32 PLGui::TabContainer::GetTabWidth

(

)

const

Get tab width.

Returns:

Tab width

Remarks:

see SetTabWidth()

PLGUI_API void PLGui::TabContainer::SetTabWidth

(

PLCore::uint32

nWidth

)

Set tab width.

Parameters:

[in]

nWidth

Tab width

Note:

• If side is SideTop or SideBottom and StaticTabSize is *not* set, tabs have a floating size. In that case, the width set by nWidth is the maximum size that a tab can have.
• If side is SideLeft or SideRight, or StaticTabSize is set, tabs have a static size. In that case, every tab will get exactly the width set by nWidth.

PLGUI_API PLCore::uint32 PLGui::TabContainer::GetTabHeight

(

)

const

Get tab height.

Returns:

Tab height

PLGUI_API void PLGui::TabContainer::SetTabHeight

(

PLCore::uint32

nHeight

)

Set tab height.

Parameters:

[in]

nHeight

Tab height

PLGUI_API void PLGui::TabContainer::OnCreateWindow

(

)

[protected]

Called when a new window shall be created.

virtual PLGUI_API void PLGui::TabContainer::OnAddWindow

(

Widget *

pWindow

)

[protected, virtual]

Called when a window has been added.

Parameters:

[in]

pWindow

Window

Reimplemented from PLGui::WindowContainer.

virtual PLGUI_API void PLGui::TabContainer::OnRemoveWindow

(

Widget *

pWindow

)

[protected, virtual]

Called when a window has been removed.

Parameters:

[in]

pWindow

Window

Reimplemented from PLGui::WindowContainer.

virtual PLGUI_API void PLGui::TabContainer::OnSelectWindow

(

int

nWindow

)

[protected, virtual]

Called when the current selection has been changed.

Parameters:

[in]

nWindow

Index of currently selected window

Reimplemented from PLGui::WindowContainer.

virtual PLGUI_API void PLGui::TabContainer::OnAdjustContent

(

)

[protected, virtual]

Called when the widget content has to be adjusted.

Reimplemented from PLGui::WindowContainer.

---

Member Data Documentation

PLCore::Event PLGui::TabContainer::EventCreateWindow

New window shall be created

PLCore::EventHandler<TabBarEntry*> PLGui::TabContainer::EventHandlerCloseTab

PLCore::EventHandler<int> PLGui::TabContainer::EventHandlerSelectTab

PLCore::EventHandler PLGui::TabContainer::EventHandlerCreateTab

TabBar* PLGui::TabContainer::m_pTabBar

Tab-bar

---

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

• TabContainer.h