cRect

Rectangle class. More...

#include <rect.h>

Inheritance diagram for cRect:

Public Member Functions
	cRect ()
	default constructor
	cRect (const IRect *pRect)
	constructor from IRect
	cRect (tInt l, tInt t, tInt r, tInt b)
	constructor with parameter
tVoid	Release ()
tVoid	Set (tInt l, tInt t, tInt r, tInt b)
	sets the rect
tInt	GetWidth () const
	returns the width of the rectangle
tInt	GetHeight () const
	returns the height of the rectangle
const cPoint *	GetTopLeft () const
	returns the top left point of the rectangle
const cPoint *	GetBottomRight () const
	returns the bottom right point of the rectangle
tInt	GetLeft () const
tVoid	SetLeft (tInt nLeft)
tInt	GetTop () const
tVoid	SetTop (tInt nTop)
tInt	GetRight () const
tVoid	SetRight (tInt nRight)
tInt	GetBottom () const
tVoid	SetBottom (tInt nBottom)
	operator IRect * ()
	instance of IRect
Public Member Functions inherited from IRect
virtual	~IRect ()
	virtual destructor to ensure proper cleanup.

Public Attributes
tInt	m_nLeft
	left border of the rect
tInt	m_nTop
	top border of the rect
tInt	m_nRight
	right border of the rect
tInt	m_nBottom
	bottom border of the rect

Detailed Description

Rectangle class.

Definition at line 29 of file rect.h.

Constructor & Destructor Documentation

cRect() [1/3]

cRect ( )

inline

default constructor

Definition at line 47 of file rect.h.

References m_nBottom, m_nLeft, m_nRight, m_nTop, and cPoint::Set().

cRect() [2/3]

cRect ( const IRect * pRect )

inline

constructor from IRect

Parameters

[in]

pRect

Rectangle

Definition at line 63 of file rect.h.

References IRect::GetBottom(), IRect::GetLeft(), IRect::GetRight(), IRect::GetTop(), and Set().

cRect() [3/3]

cRect ( tInt l, tInt t, tInt r, tInt b )

inline

constructor with parameter

Parameters

[in]	l	left border
[in]	t	top border
[in]	r	right border
[in]	b	bottom border

Definition at line 76 of file rect.h.

References m_nBottom, m_nLeft, m_nRight, m_nTop, and cPoint::Set().

Member Function Documentation

GetBottom()

tInt GetBottom ( ) const

inlinevirtual

gets the bottom border of the rectangle

Returns

tInt value of the bottom border

Implements IRect.

Definition at line 227 of file rect.h.

References m_nBottom.

GetBottomRight()

const cPoint * GetBottomRight ( ) const

inlinevirtual

returns the bottom right point of the rectangle

Returns

bottom right point

Implements IRect.

Definition at line 151 of file rect.h.

GetHeight()

tInt GetHeight ( ) const

inlinevirtual

returns the height of the rectangle

Returns

height

Implements IRect.

Definition at line 131 of file rect.h.

References m_nBottom, and m_nTop.

GetLeft()

tInt GetLeft ( ) const

inlinevirtual

Gets the left border of the rectangle

Returns

tInt value of the left border

Implements IRect.

Definition at line 161 of file rect.h.

References m_nLeft.

GetRight()

tInt GetRight ( ) const

inlinevirtual

Gets the right border of the rectangle

Returns

tInt value of the right border

Implements IRect.

Definition at line 205 of file rect.h.

References m_nRight.

GetTop()

tInt GetTop ( ) const

inlinevirtual

Gets the top border of the rectangle

Returns

tInt value of the top border

Implements IRect.

Definition at line 183 of file rect.h.

References m_nTop.

GetTopLeft()

const cPoint * GetTopLeft ( ) const

inlinevirtual

returns the top left point of the rectangle

Returns

top left point

Implements IRect.

Definition at line 141 of file rect.h.

GetWidth()

tInt GetWidth ( ) const

inlinevirtual

returns the width of the rectangle

Returns

width

Implements IRect.

Definition at line 121 of file rect.h.

References m_nLeft, and m_nRight.

operator IRect *()

operator IRect * ( )

inlineexplicit

instance of IRect

Returns

object

Definition at line 249 of file rect.h.

Release()

tVoid Release ( )

inlinevirtual

Releases this rectangle

Returns

void

Implements IRect.

Definition at line 91 of file rect.h.

Set()

tVoid Set ( tInt l, tInt t, tInt r, tInt b )

inline

sets the rect

Parameters

[in]	l	left border
[in]	t	top border
[in]	r	right border
[in]	b	bottom border

Returns

void

Definition at line 105 of file rect.h.

References m_nBottom, m_nLeft, m_nRight, m_nTop, and cPoint::Set().

Referenced by cRect().

SetBottom()

tVoid SetBottom ( tInt nBottom )

inlinevirtual

Sets the bottom border of the rectangle with the given value

Parameters

nBottom

[in] bottom border value

Returns

void

Implements IRect.

Definition at line 238 of file rect.h.

References m_nBottom, and cPoint::SetX().

SetLeft()

tVoid SetLeft ( tInt nLeft )

inlinevirtual

Sets the left border of the rectangle with the given value

Parameters

nLeft

[in] left border value

Returns

void

Implements IRect.

Definition at line 172 of file rect.h.

References m_nLeft, and cPoint::SetX().

SetRight()

tVoid SetRight ( tInt nRight )

inlinevirtual

Sets the right border of the rectangle with the given value

Parameters

nRight

[in] right border value

Returns

void

Implements IRect.

Definition at line 216 of file rect.h.

References m_nRight, and cPoint::SetY().

SetTop()

tVoid SetTop ( tInt nTop )

inlinevirtual

Sets the top border of the rectangle with the given value

Parameters

nTop	[in] top border value

Returns

void

Implements IRect.

Definition at line 194 of file rect.h.

References m_nTop, and cPoint::SetY().

Member Data Documentation

m_nBottom

tInt m_nBottom

bottom border of the rect

Definition at line 41 of file rect.h.

Referenced by cRect(), cRect(), cGCLProcessor::CalcScale(), GetBottom(), GetHeight(), Set(), and SetBottom().

m_nLeft

tInt m_nLeft

left border of the rect

Definition at line 38 of file rect.h.

Referenced by cRect(), cRect(), cGCLProcessor::CalcScale(), cGCLProcessor::GetCoords(), GetLeft(), GetWidth(), Set(), and SetLeft().

m_nRight

tInt m_nRight

right border of the rect

Definition at line 40 of file rect.h.

Referenced by cRect(), cRect(), cGCLProcessor::CalcScale(), GetRight(), GetWidth(), Set(), and SetRight().

m_nTop

tInt m_nTop

top border of the rect

Definition at line 39 of file rect.h.

Referenced by cRect(), cRect(), cGCLProcessor::CalcScale(), cGCLProcessor::GetCoords(), GetHeight(), GetTop(), Set(), and SetTop().