CClientArea Class Reference

Client Area is a rectangle relative to a parent rectangle. More...

#include <GUIbase.h>

Public Member Functions
	CClientArea ()
	CClientArea (const CStr &Value)
	CClientArea (const CRect &pixel, const CRect &percent)
CRect	GetClientArea (const CRect &parent) const
	Get client area rectangle when the parent is given. More...
bool	SetClientArea (const CStr &Value)
	The ClientArea can be set from a string looking like: More...

Public Attributes
CRect	pixel
	Pixel modifiers. More...
CRect	percent
	Percent modifiers. More...

Detailed Description

Client Area is a rectangle relative to a parent rectangle.

You can input the whole value of the Client Area by string. Like used in the GUI.

Definition at line 179 of file GUIbase.h.

Constructor & Destructor Documentation

CClientArea::CClientArea

(

)

Definition at line 32 of file GUIbase.cpp.

CClientArea::CClientArea

(

const CStr &

Value

)

Definition at line 36 of file GUIbase.cpp.

CClientArea::CClientArea	(	const CRect &	pixel,
		const CRect &	percent
	)

Definition at line 41 of file GUIbase.cpp.

Member Function Documentation

CRect CClientArea::GetClientArea

(

const CRect &

parent

)

const

Get client area rectangle when the parent is given.

Definition at line 46 of file GUIbase.cpp.

bool CClientArea::SetClientArea

(

const CStr &

Value

)

The ClientArea can be set from a string looking like:

"0 0 100% 100%" "50%-10 50%-10 50%+10 50%+10"

i.e. First percent modifier, then + or - and the pixel modifier. Although you can use just the percent or the pixel modifier. Notice though that the percent modifier must always be the first when both modifiers are inputted.

Returns

true if success, false if failure. If false then the client area will be unchanged.

Definition at line 63 of file GUIbase.cpp.

Member Data Documentation

CRect CClientArea::percent

Percent modifiers.

Definition at line 190 of file GUIbase.h.

CRect CClientArea::pixel

Pixel modifiers.

Definition at line 187 of file GUIbase.h.

---

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

• /home/sathyam/0ad.svn/source/gui/GUIbase.h
• /home/sathyam/0ad.svn/source/gui/GUIbase.cpp