Pyrogenesis  trunk
Public Member Functions | Public Attributes | List of all members
CClientArea Class Reference

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

#include <GUIbase.h>

Collaboration diagram for CClientArea:
Collaboration graph
[legend]

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...
 
bool operator== (const CClientArea &other) const
 

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.

Constructor & Destructor Documentation

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

Member Function Documentation

CRect CClientArea::GetClientArea ( const CRect parent) const

Get client area rectangle when the parent is given.

bool CClientArea::operator== ( const CClientArea other) const
inline
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.

Member Data Documentation

CRect CClientArea::percent

Percent modifiers.

CRect CClientArea::pixel

Pixel modifiers.


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