Humble Framework for SkyOS


Main Page | Modules | Class Hierarchy | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

HPoint Class Reference
[Graphical User Interface]

#include <HGUI.h>

Inheritance diagram for HPoint:

HObj

Detailed Description

Currently, there is no "point" structure recognized by the SkyOS API, so this is class is completely independent of the SkyGI.

Definition at line 152 of file HGUI.h.

Public Member Functions

 HPoint (int32 nX, int32 nY)
void Offset (int32 nXDelta, int32 nYDelta)
 moves the point by a given delta
virtual StringPtr ToString (void) const
 Returns the variable's value as a human-readble string.
void Set (int32 nX, int32 nY)
 Sets the point to a caller-supplied value.
void SetEmpty (void)
 Sets the point to zero.
bool IsZero (void) const
 Evaluates to true if the point is non-zero.
bool operator== (const HPoint &rhs) const
bool operator!= (const HPoint &rhs) const
HPointoperator+= (const HPoint &rhs)
HPointoperator-= (const HPoint &rhs)
HPointoperator+= (const int32 nDelta)
HPointoperator-= (const int32 nDelta)

Data Fields

int32 x
 X coordinate.
int32 y
 Y coordinate.


Member Function Documentation

void HPoint::Offset int32  nXDelta,
int32  nYDelta
 

Adjusts the location of a point by a caller-supplied delta.

Parameters:
nXDelta Horizontal delta (negative = to the left)
nYDelta Vertical delta (negative = upwards)

Definition at line 183 of file HGUI.h.

virtual StringPtr HPoint::ToString void   )  const [virtual]
 

Returns:
Ptr to string

Definition at line 191 of file HGUI.h.

void HPoint::Set int32  nX,
int32  nY
 

Parameters:
nX X coordinate
nY Y coordinate

Definition at line 204 of file HGUI.h.

bool HPoint::IsZero void   )  const
 

Returns:
True if non-zero, false otherwise

Definition at line 214 of file HGUI.h.


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

2006.01.09-16:37