PLGui::ScrollWidget Class Reference

Container that allows it's content to be scrolled. More...

#include <ScrollWidget.h>

Inheritance diagram for PLGui::ScrollWidget:

List of all members.

Public Member Functions
virtual PLGUI_API void	OnSize (const PLMath::Vector2i &vSize) override
	Called when the widget gets resized.
virtual PLGUI_API void	OnAdjustContent () override
	Called when the widget content has to be adjusted.
Protected Member Functions
void	OnInnerWidgetSize (const PLMath::Vector2i &vSize)
	Called when the size of the inner window has changed.
void	OnScrollBarXChanged (int nX)
	Called when the horizontal scrollbar has changed it's value.
void	OnScrollBarYChanged (int nY)
	Called when the vertical scrollbar has changed it's value.
void	AdjustScrollBars ()
	Show or hide scroll bars according to the widget size.
Protected Attributes
EScrollBarStyle	m_nScrollBarStyleX
EScrollBarStyle	m_nScrollBarStyleY
Widget *	m_pInnerWidget
ScrollBar *	m_pScrollBarX
ScrollBar *	m_pScrollBarY
bool	m_bScrollBarX
bool	m_bScrollBarY

---

Detailed Description

Container that allows it's content to be scrolled.

---

Member Function Documentation

virtual PLGUI_API void PLGui::ScrollWidget::OnSize

(

const PLMath::Vector2i &

vSize

)

[override, virtual]

Called when the widget gets resized.

Parameters:

[in]

vSize

Size

Reimplemented from PLGui::WidgetFunctions.

virtual PLGUI_API void PLGui::ScrollWidget::OnAdjustContent

(

)

[override, virtual]

Called when the widget content has to be adjusted.

Reimplemented from PLGui::ContainerWidget.

void PLGui::ScrollWidget::OnInnerWidgetSize

(

const PLMath::Vector2i &

vSize

)

[protected]

Called when the size of the inner window has changed.

Parameters:

[in]

vSize

Size

void PLGui::ScrollWidget::OnScrollBarXChanged

(

int

nX

)

[protected]

Called when the horizontal scrollbar has changed it's value.

Parameters:

[in]

nX

New X-position

void PLGui::ScrollWidget::OnScrollBarYChanged

(

int

nY

)

[protected]

Called when the vertical scrollbar has changed it's value.

Parameters:

[in]

nY

New Y-position

void PLGui::ScrollWidget::AdjustScrollBars

(

)

[protected]

Show or hide scroll bars according to the widget size.

---

Member Data Documentation

EScrollBarStyle PLGui::ScrollWidget::m_nScrollBarStyleX [protected]

Scrollbar style for horizontal scrollbar

EScrollBarStyle PLGui::ScrollWidget::m_nScrollBarStyleY [protected]

Scrollbar style for vertical scrollbar

Widget* PLGui::ScrollWidget::m_pInnerWidget [protected]

Innermost widget that is scrolled

ScrollBar* PLGui::ScrollWidget::m_pScrollBarX [protected]

Scroll bar (horizontal)

ScrollBar* PLGui::ScrollWidget::m_pScrollBarY [protected]

Scroll bar (vertical)

bool PLGui::ScrollWidget::m_bScrollBarX [protected]

Is a horizontal scrollbar visible?

bool PLGui::ScrollWidget::m_bScrollBarY [protected]

Is a vertical scrollbar visible?

---

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

• ScrollWidget.h