PLGui::LayoutHints Class Reference

Layout information for a widget. More...

#include <LayoutHints.h>

List of all members.

Public Member Functions
PLGUI_API	LayoutHints ()
	Constructor.
PLGUI_API	~LayoutHints ()
	Destructor.
PLGUI_API const SizeHint &	GetSizeX () const
	Get desired size (X)
PLGUI_API void	SetSizeX (const SizeHint &cSize)
	Set desired size (X)
PLGUI_API const SizeHint &	GetSizeY () const
	Get desired size (Y)
PLGUI_API void	SetSizeY (const SizeHint &cSize)
	Set desired size (Y)
PLGUI_API const SizeHint &	GetMinSizeX () const
	Get minimum size (X)
PLGUI_API void	SetMinSizeX (const SizeHint &cSize)
	Set minimum size (X)
PLGUI_API const SizeHint &	GetMinSizeY () const
	Get minimum size (Y)
PLGUI_API void	SetMinSizeY (const SizeHint &cSize)
	Set minimum size (Y)
PLGUI_API const SizeHint &	GetMaxSizeX () const
	Get maximum size (X)
PLGUI_API void	SetMaxSizeX (const SizeHint &cSize)
	Set maximum size (X)
PLGUI_API const SizeHint &	GetMaxSizeY () const
	Get maximum size (Y)
PLGUI_API void	SetMaxSizeY (const SizeHint &cSize)
	Set maximum size (Y)
PLGUI_API const SizeHint &	GetMarginLeft () const
	Get margin (left)
PLGUI_API void	SetMarginLeft (const SizeHint &cSize)
	Set margin (left)
PLGUI_API const SizeHint &	GetMarginRight () const
	Get margin (right)
PLGUI_API void	SetMarginRight (const SizeHint &cSize)
	Set margin (right)
PLGUI_API const SizeHint &	GetMarginTop () const
	Get margin (top)
PLGUI_API void	SetMarginTop (const SizeHint &cSize)
	Set margin (top)
PLGUI_API const SizeHint &	GetMarginBottom () const
	Get margin (bottom)
PLGUI_API void	SetMarginBottom (const SizeHint &cSize)
	Set margin (bottom)
PLGUI_API void	SetMargin (const SizeHint &cSize)
	Set margin (all)
PLGUI_API const SizeHint &	GetPaddingLeft () const
	Get padding (left)
PLGUI_API void	SetPaddingLeft (const SizeHint &cSize)
	Set padding (left)
PLGUI_API const SizeHint &	GetPaddingRight () const
	Get padding (right)
PLGUI_API void	SetPaddingRight (const SizeHint &cSize)
	Set padding (right)
PLGUI_API const SizeHint &	GetPaddingTop () const
	Get padding (top)
PLGUI_API void	SetPaddingTop (const SizeHint &cSize)
	Set padding (top)
PLGUI_API const SizeHint &	GetPaddingBottom () const
	Get padding (bottom)
PLGUI_API void	SetPaddingBottom (const SizeHint &cSize)
	Set padding (bottom)
PLGUI_API void	SetPadding (const SizeHint &cSize)
	Set padding (all)
PLGUI_API EAlign	GetAlign () const
	Get alignment of child elements (horizontal)
PLGUI_API void	SetAlign (EAlign nAlign)
	Set alignment of child elements (horizontal)
PLGUI_API EVAlign	GetVAlign () const
	Get alignment of child elements (vertical)
PLGUI_API void	SetVAlign (EVAlign nAlign)
	Set alignment of child elements (vertical)
PLGUI_API PLCore::uint32	GetSpacing () const
	Get spacing between child elements.
PLGUI_API void	SetSpacing (PLCore::uint32 nSpacing)
	Set spacing between child elements.
Public Attributes
PLCore::Event	EventUpdate
Protected Member Functions
PLGUI_API void	Update ()
	Update layout hints.
Protected Attributes
SizeHint	m_cSizeX
SizeHint	m_cSizeY
SizeHint	m_cMinSizeX
SizeHint	m_cMinSizeY
SizeHint	m_cMaxSizeX
SizeHint	m_cMaxSizeY
SizeHint	m_cMarginLeft
SizeHint	m_cMarginRight
SizeHint	m_cMarginTop
SizeHint	m_cMarginBottom
SizeHint	m_cPaddingLeft
SizeHint	m_cPaddingRight
SizeHint	m_cPaddingTop
SizeHint	m_cPaddingBottom
EAlign	m_nAlign
EVAlign	m_nVAlign
PLCore::uint32	m_nSpacing

---

Detailed Description

Layout information for a widget.

Note:

• Margin defines how much empty space (pixel) should be around an element
• Padding defines the how much empty space (pixel) should be within the borders of a container
• Spacing defines the how much empty space (pixel) should be between elements by default

---

Constructor & Destructor Documentation

PLGUI_API PLGui::LayoutHints::LayoutHints

(

)

Constructor.

PLGUI_API PLGui::LayoutHints::~LayoutHints

(

)

Destructor.

---

Member Function Documentation

PLGUI_API const SizeHint& PLGui::LayoutHints::GetSizeX

(

)

const

Get desired size (X)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetSizeX

(

const SizeHint &

cSize

)

Set desired size (X)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetSizeY

(

)

const

Get desired size (Y)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetSizeY

(

const SizeHint &

cSize

)

Set desired size (Y)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetMinSizeX

(

)

const

Get minimum size (X)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetMinSizeX

(

const SizeHint &

cSize

)

Set minimum size (X)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetMinSizeY

(

)

const

Get minimum size (Y)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetMinSizeY

(

const SizeHint &

cSize

)

Set minimum size (Y)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetMaxSizeX

(

)

const

Get maximum size (X)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetMaxSizeX

(

const SizeHint &

cSize

)

Set maximum size (X)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetMaxSizeY

(

)

const

Get maximum size (Y)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetMaxSizeY

(

const SizeHint &

cSize

)

Set maximum size (Y)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetMarginLeft

(

)

const

Get margin (left)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetMarginLeft

(

const SizeHint &

cSize

)

Set margin (left)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetMarginRight

(

)

const

Get margin (right)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetMarginRight

(

const SizeHint &

cSize

)

Set margin (right)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetMarginTop

(

)

const

Get margin (top)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetMarginTop

(

const SizeHint &

cSize

)

Set margin (top)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetMarginBottom

(

)

const

Get margin (bottom)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetMarginBottom

(

const SizeHint &

cSize

)

Set margin (bottom)

Parameters:

[in]

cSize

Size hint

PLGUI_API void PLGui::LayoutHints::SetMargin

(

const SizeHint &

cSize

)

Set margin (all)

Parameters:

[in]

cSize

Size hint

Remarks:

This function sets all margins (left, right, top and bottom) to the same value

PLGUI_API const SizeHint& PLGui::LayoutHints::GetPaddingLeft

(

)

const

Get padding (left)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetPaddingLeft

(

const SizeHint &

cSize

)

Set padding (left)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetPaddingRight

(

)

const

Get padding (right)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetPaddingRight

(

const SizeHint &

cSize

)

Set padding (right)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetPaddingTop

(

)

const

Get padding (top)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetPaddingTop

(

const SizeHint &

cSize

)

Set padding (top)

Parameters:

[in]

cSize

Size hint

PLGUI_API const SizeHint& PLGui::LayoutHints::GetPaddingBottom

(

)

const

Get padding (bottom)

Returns:

Size hint

PLGUI_API void PLGui::LayoutHints::SetPaddingBottom

(

const SizeHint &

cSize

)

Set padding (bottom)

Parameters:

[in]

cSize

Size hint

PLGUI_API void PLGui::LayoutHints::SetPadding

(

const SizeHint &

cSize

)

Set padding (all)

Parameters:

[in]

cSize

Size hint

Remarks:

This function sets all paddings (left, right, top and bottom) to the same value

PLGUI_API EAlign PLGui::LayoutHints::GetAlign

(

)

const

Get alignment of child elements (horizontal)

Returns:

Alignment

PLGUI_API void PLGui::LayoutHints::SetAlign

(

EAlign

nAlign

)

Set alignment of child elements (horizontal)

Parameters:

[in]

nAlign

Alignment

PLGUI_API EVAlign PLGui::LayoutHints::GetVAlign

(

)

const

Get alignment of child elements (vertical)

Returns:

Alignment

PLGUI_API void PLGui::LayoutHints::SetVAlign

(

EVAlign

nAlign

)

Set alignment of child elements (vertical)

Parameters:

[in]

nAlign

Alignment

PLGUI_API PLCore::uint32 PLGui::LayoutHints::GetSpacing

(

)

const

Get spacing between child elements.

Returns:

Spacing

PLGUI_API void PLGui::LayoutHints::SetSpacing

(

PLCore::uint32

nSpacing

)

Set spacing between child elements.

Parameters:

[in]

nSpacing

Spacing, default is 10 pixel

PLGUI_API void PLGui::LayoutHints::Update

(

)

[protected]

Update layout hints.

---

Member Data Documentation

PLCore::Event PLGui::LayoutHints::EventUpdate

Layout hints have been changed

SizeHint PLGui::LayoutHints::m_cSizeX [protected]

Desired size (X)

SizeHint PLGui::LayoutHints::m_cSizeY [protected]

Desired size (Y)

SizeHint PLGui::LayoutHints::m_cMinSizeX [protected]

Minimum size (X)

SizeHint PLGui::LayoutHints::m_cMinSizeY [protected]

Minimum size (Y)

SizeHint PLGui::LayoutHints::m_cMaxSizeX [protected]

Maximum size (X)

SizeHint PLGui::LayoutHints::m_cMaxSizeY [protected]

Maximum size (Y)

SizeHint PLGui::LayoutHints::m_cMarginLeft [protected]

Margin (left)

SizeHint PLGui::LayoutHints::m_cMarginRight [protected]

Margin (right)

SizeHint PLGui::LayoutHints::m_cMarginTop [protected]

Margin (top)

SizeHint PLGui::LayoutHints::m_cMarginBottom [protected]

Margin (bottom)

SizeHint PLGui::LayoutHints::m_cPaddingLeft [protected]

Padding (left)

SizeHint PLGui::LayoutHints::m_cPaddingRight [protected]

Padding (right)

SizeHint PLGui::LayoutHints::m_cPaddingTop [protected]

Padding (top)

SizeHint PLGui::LayoutHints::m_cPaddingBottom [protected]

Padding (bottom)

EAlign PLGui::LayoutHints::m_nAlign [protected]

Horizontal alignment of child elements

EVAlign PLGui::LayoutHints::m_nVAlign [protected]

Vertical alignment of child elements

PLCore::uint32 PLGui::LayoutHints::m_nSpacing [protected]

Spacing between child elements

---

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

• LayoutHints.h