PLGui::SizeHint Class Reference

Size hint. More...

#include <SizeHint.h>

List of all members.

Public Types
enum	EPolicy { Pixel, Percent, Preferred, Floating }
	Size policy. More...
Public Member Functions
PLGUI_API	SizeHint (EPolicy nPolicy=Floating, PLCore::uint32 nSize=0)
	Constructor.
PLGUI_API	SizeHint (const SizeHint &cSizeHint)
	Copy constructor.
PLGUI_API	~SizeHint ()
	Destructor.
PLGUI_API SizeHint &	operator= (const SizeHint &cSizeHint)
	Copy operator.
PLGUI_API bool	operator== (const SizeHint &cSizeHint) const
	Comparison operator.
PLGUI_API EPolicy	GetPolicy () const
	Get size policy.
PLGUI_API void	SetPolicy (EPolicy nPolicy)
	Set size policy.
PLGUI_API PLCore::uint32	GetSize () const
	Get size.
PLGUI_API float	GetSizeFloat () const
	Get size in float.
PLGUI_API void	SetSize (PLCore::uint32 nSize)
	Set size.
PLGUI_API void	SetSizeFloat (float fSize)
	Set size in float.
PLGUI_API void	Set (EPolicy nPolicy, PLCore::uint32 nSize)
	Set policy and size.
PLGUI_API void	SetFloat (EPolicy nPolicy, float fSize)
	Set policy and size in float.
PLGUI_API int	CalculateSize (PLCore::uint32 nParentSize, int nPreferredSize) const
	Calculate actual size specified by this size hint.
PLGUI_API PLCore::String	ToString () const
	To string.
PLGUI_API bool	FromString (const PLCore::String &sString)
	From string.
Protected Attributes
EPolicy	m_nPolicy
float	m_fSize

---

Detailed Description

Size hint.

---

Member Enumeration Documentation

enum PLGui::SizeHint::EPolicy

Size policy.

Enumerator:

Pixel	The element will have a specific size specified in pixels
Percent	The element will have a specific size specified in percent of available space
Preferred	The element will try to take exactly the preferred size
Floating	The element will take as much place as it can get

---

Constructor & Destructor Documentation

PLGUI_API PLGui::SizeHint::SizeHint	(	EPolicy	nPolicy = Floating,
		PLCore::uint32	nSize = 0
	)

Constructor.

Parameters:

[in]	nPolicy	Size policy
[in]	nSize	Size

PLGUI_API PLGui::SizeHint::SizeHint

(

const SizeHint &

cSizeHint

)

Copy constructor.

Parameters:

[in]

cSizeHint

Source to copy from

PLGUI_API PLGui::SizeHint::~SizeHint

(

)

Destructor.

---

Member Function Documentation

PLGUI_API SizeHint& PLGui::SizeHint::operator=

(

const SizeHint &

cSizeHint

)

Copy operator.

Parameters:

[in]

cSizeHint

Source to copy from

Returns:

Reference to this object

PLGUI_API bool PLGui::SizeHint::operator==

(

const SizeHint &

cSizeHint

)

const

Comparison operator.

Parameters:

[in]

cSizeHint

Object to compare with

Returns:

'true' if both objects are equal, else 'false'

PLGUI_API EPolicy PLGui::SizeHint::GetPolicy

(

)

const

Get size policy.

Returns:

Size policy

PLGUI_API void PLGui::SizeHint::SetPolicy

(

EPolicy

nPolicy

)

Set size policy.

Parameters:

[in]

nPolicy

Size policy

PLGUI_API PLCore::uint32 PLGui::SizeHint::GetSize

(

)

const

Get size.

Returns:

Size

PLGUI_API float PLGui::SizeHint::GetSizeFloat

(

)

const

Get size in float.

Returns:

Size

PLGUI_API void PLGui::SizeHint::SetSize

(

PLCore::uint32

nSize

)

Set size.

Parameters:

[in]

nSize

Size

PLGUI_API void PLGui::SizeHint::SetSizeFloat

(

float

fSize

)

Set size in float.

Parameters:

[in]

fSize

Size

PLGUI_API void PLGui::SizeHint::Set	(	EPolicy	nPolicy,
		PLCore::uint32	nSize
	)

Set policy and size.

Parameters:

[in]	nPolicy	Size policy
[in]	nSize	Size

PLGUI_API void PLGui::SizeHint::SetFloat	(	EPolicy	nPolicy,
		float	fSize
	)

Set policy and size in float.

Parameters:

[in]	nPolicy	Size policy
[in]	fSize	Size

PLGUI_API int PLGui::SizeHint::CalculateSize	(	PLCore::uint32	nParentSize,
		int	nPreferredSize
	)		const

Calculate actual size specified by this size hint.

Parameters:

[in]	nParentSize	Size of the parent element, needed to calculate sizes specified in percentages
[in]	nPreferredSize	Preferred size of the element, can be -1 if no preferred size is specified

Returns:

Size, or -1 of policy is Floating

PLGUI_API PLCore::String PLGui::SizeHint::ToString

(

)

const

To string.

Returns:

String representation

PLGUI_API bool PLGui::SizeHint::FromString

(

const PLCore::String &

sString

)

From string.

Parameters:

[in]

sString

String representation

Returns:

'true' on success, else 'false'

---

Member Data Documentation

EPolicy PLGui::SizeHint::m_nPolicy [protected]

Size policy

float PLGui::SizeHint::m_fSize [protected]

Size

---

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

• SizeHint.h