PLGui::WindowContainer Class Reference

Base class for window containers. More...

#include <WindowContainer.h>

Inheritance diagram for PLGui::WindowContainer:

List of all members.

Public Member Functions
PLGUI_API	WindowContainer (Widget *pParent=nullptr)
	Constructor.
virtual PLGUI_API	~WindowContainer ()
	Destructor.
virtual PLGUI_API Widget *	GetContentWidget () const
	Get content widget.
PLGUI_API void	Clear ()
	Clear container.
PLGUI_API const PLCore::Container< Widget * > &	GetWindows () const
	Get list of windows inside the container.
PLGUI_API void	AddWindow (Widget *pWindow)
	Add window to container.
PLGUI_API void	RemoveWindow (Widget *pWindow)
	Remove window from container.
PLGUI_API int	GetSelection () const
	Get currently selected window.
PLGUI_API void	SetSelection (int nWindow)
	Set currently selected window.
PLGUI_API void	SetSelection (Widget *pWindow)
	Set currently selected window.
Public Attributes
PLCore::Event< Widget * >	EventAddWindow
PLCore::Event< Widget * >	EventRemoveWindow
PLCore::Event< int >	EventSelectWindow
Widget *	m_pContentWidget
PLCore::List< Widget * >	m_lstWindows
int	m_nSelection
Widget *	m_pSelection
Protected Member Functions
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

Base class for window containers.

---

Constructor & Destructor Documentation

PLGUI_API PLGui::WindowContainer::WindowContainer

(

Widget *

pParent = nullptr

)

Constructor.

Parameters:

[in]

pParent

Pointer to parent widget

virtual PLGUI_API PLGui::WindowContainer::~WindowContainer

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual PLGUI_API Widget* PLGui::WindowContainer::GetContentWidget

(

)

const [virtual]

Get content widget.

Returns:

Content widget

Remarks:

If a widget is a container for other widgets, a container widget is often used as the parent for all of the child widgets. This is e.g. necessary to separate the "outside" from the "inside", e.g. there may be other (internal) child widgets, that are also children of the same parent (e.g. buttons in the title bar or frame widgets). So if you want to insert widgets inside other widgets, you should use the widget returned by GetContentWidget() as the parent widget, not the widget itself. If a widget don't have a content widget, it will return a pointer to itself as the content widget.

Reimplemented from PLGui::Widget.

PLGUI_API void PLGui::WindowContainer::Clear

(

)

Clear container.

PLGUI_API const PLCore::Container<Widget*>& PLGui::WindowContainer::GetWindows

(

)

const

Get list of windows inside the container.

Returns:

List of windows

PLGUI_API void PLGui::WindowContainer::AddWindow

(

Widget *

pWindow

)

Add window to container.

Parameters:

[in]

pWindow

Window

PLGUI_API void PLGui::WindowContainer::RemoveWindow

(

Widget *

pWindow

)

Remove window from container.

Parameters:

[in]

pWindow

Window

PLGUI_API int PLGui::WindowContainer::GetSelection

(

)

const

Get currently selected window.

Returns:

Index of currently selected window

PLGUI_API void PLGui::WindowContainer::SetSelection

(

int

nWindow

)

Set currently selected window.

Parameters:

[in]

nWindow

Index of currently selected window

PLGUI_API void PLGui::WindowContainer::SetSelection

(

Widget *

pWindow

)

Set currently selected window.

Parameters:

[in]

pWindow

Pointer to currently selected window

virtual PLGUI_API void PLGui::WindowContainer::OnAddWindow

(

Widget *

pWindow

)

[protected, virtual]

Called when a window has been added.

Parameters:

[in]

pWindow

Window

Reimplemented in PLGui::TabContainer.

virtual PLGUI_API void PLGui::WindowContainer::OnRemoveWindow

(

Widget *

pWindow

)

[protected, virtual]

Called when a window has been removed.

Parameters:

[in]

pWindow

Window

Reimplemented in PLGui::TabContainer.

virtual PLGUI_API void PLGui::WindowContainer::OnSelectWindow

(

int

nWindow

)

[protected, virtual]

Called when the current selection has been changed.

Parameters:

[in]

nWindow

Index of currently selected window

Reimplemented in PLGui::TabContainer.

virtual PLGUI_API void PLGui::WindowContainer::OnAdjustContent

(

)

[protected, virtual]

Called when the widget content has to be adjusted.

Reimplemented from PLGui::Widget.

Reimplemented in PLGui::TabContainer.

---

Member Data Documentation

PLCore::Event<Widget*> PLGui::WindowContainer::EventAddWindow

Window has been added

PLCore::Event<Widget*> PLGui::WindowContainer::EventRemoveWindow

Window has been removed

PLCore::Event<int> PLGui::WindowContainer::EventSelectWindow

Current selection has been changed

Widget* PLGui::WindowContainer::m_pContentWidget

Inner widget that contains the content windows

PLCore::List<Widget*> PLGui::WindowContainer::m_lstWindows

List of windows

int PLGui::WindowContainer::m_nSelection

Index of currently selected window

Widget* PLGui::WindowContainer::m_pSelection

Pointer to currently selected window

---

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

• WindowContainer.h