IlvWindowsPoint Class Reference

This class is a helper to deal with the Windows API structure POINT in Rogue Wave Views code. More...

#include <ilviews/windows/config.h>

Inheritance diagram for IlvWindowsPoint:

Public Member Functions
	IlvWindowsPoint (const POINT &pt)
	Conversion constructor from a Windows API structure POINT. More...
	IlvWindowsPoint (IlvPos x, IlvPos y)
	Constructor from coordinates. More...
	IlvWindowsPoint (const IlvPoint &pt)
	Constructor from an IlvPoint. More...
	IlvWindowsPoint ()
	The default constructor. More...
POINT &	fill (POINT &pt)
	Fills a Windows API structure POINT. More...
	operator const POINT ()
	Conversion operator into a Windows API Structure POINT. More...
Public Member Functions inherited from IlvPoint
	IlvPoint (IlvPos x=0, IlvPos y=0)
	Constructor. More...
IlvPos	getX () const
	Retrieves the current x coordinate. More...
IlvPos	getY () const
	Retrieves the current y coordinate. More...
void	move (IlvPos x, IlvPos y)
	Sets the new position. More...
int	operator!= (const IlvPoint &p) const
	Inequality operator. More...
IlvPoint &	operator= (const IlvPoint &p)
	Assignment operator. More...
int	operator== (const IlvPoint &p) const
	Equality operator. More...
void	set (IlvPos x, IlvPos y)
	Sets the new position. More...
void	setX (IlvPos newX)
	Sets the x coordinate. More...
void	setY (IlvPos yy)
	Sets the y coordinate. More...
void	translate (IlvPos dx, IlvPos dy)
	Translates to a new position. More...
void	translate (const IlvPoint &delta)
	Translates to a new position. More...
IlvPos	x () const
	Retrieves the current x coordinate. More...
void	x (IlvPos newX)
	Sets the x coordinate. More...
IlvPos	y () const
	Retrieves the current y coordinate. More...
void	y (IlvPos newY)
	Sets the y coordinate. More...

Detailed Description

This class is a helper to deal with the Windows API structure POINT in Rogue Wave Views code.

Library: winviews

Constructor & Destructor Documentation

IlvWindowsPoint() [1/4]

IlvWindowsPoint::IlvWindowsPoint

(

const POINT &

pt

)

Conversion constructor from a Windows API structure POINT.

Parameters

pt	A const reference to a POINT to be converted into an IlvWindowsPoint.

IlvWindowsPoint() [2/4]

IlvWindowsPoint::IlvWindowsPoint	(	IlvPos	x,
		IlvPos	y
	)

Constructor from coordinates.

Parameters

x	An IlvPos that is the abscissa of the point.
y	An IlvPos that is the ordinate of the point.

IlvWindowsPoint() [3/4]

IlvWindowsPoint::IlvWindowsPoint

(

const IlvPoint &

pt

)

Constructor from an IlvPoint.

Parameters

pt	A const reference to an IlvPoint.

IlvWindowsPoint() [4/4]

IlvWindowsPoint::IlvWindowsPoint

(

)

The default constructor.

The coordinates of the point are (0, 0).

Member Function Documentation

fill()

POINT& IlvWindowsPoint::fill

(

POINT &

pt

)

Fills a Windows API structure POINT.

Parameters

pt	A reference to a Windows API structure POINT to be filled with the values of the instance of IlvWindowsPoint.

Returns

A reference to the Windows API structure POINT given as the parameter.

operator const POINT()

IlvWindowsPoint::operator const POINT

(

)

Conversion operator into a Windows API Structure POINT.

The Windows API Structure POINT is filled with the values of the instance of IlvWindowsPoint.

Returns

A constant Windows API structure POINT.