Object rectangle.

The PMRect class represents a rectangular area defined by start point and rectangle size. It provides mechanisms for sizes comparison.

You can construct, destruct, copy, and assign objects of this class.

Source:

pm_rectangle.h:26

Author:

Dmitry A.Steklenev

Version:

$Revision: 1.4 $

Entity	Type	Scope	Short Description
sys_rectangle	typedef	public	System dependent type defines a rectangle coordinates.
inclusive_type	enum	public	Defines inclusive-inclusive type of a system rectangle.
exclusive_type	enum	public	Defines inclusive-exclusive type of a system rectangle.
PMRect	constructor	public	Constructs the empty rectangle object.
PMRect	constructor	public	Constructs the rectangle object from coordinates.
PMRect	constructor	public	Constructs the rectangle from inclusive-inclusive system rectangle.
PMRect	constructor	public	Constructs the rectangle from inclusive-exclusive system rectangle.
x	attribute	public	The rectangle's x-coordinate.
y	attribute	public	The rectangle's y-coordinate.
cx	attribute	public	The rectangle's width.
cy	attribute	public	The rectangle's height.
empty	method	public	If the width or height of this rectangle is zero, TRUE is returned.
intersects	method	public	If the rectangle and specified rectangle overlap, TRUE is returned.
contains	method	public	If the rectangle contains the specified point, TRUE is returned.
shrink_by	method	public	Shrinks the rectangle.
expand_by	method	public	Expands the rectangle.
map	method	public	Maps a rectangle.
operator ==	operator	public	Compares this object to another rectangle object for equality.
operator !=	operator	public	Compares this object to another rectangle object for inequality.
as_sys_value	method	public	Converts the rectangle value to inclusive-inclusive system rectangle.
as_sys_value	method	public	Converts the rectangle value to inclusive-exclusive system rectangle.

System dependent type defines a rectangle coordinates.

Source:

pm_rectangle.h:29

Code:

public typedef struct _RECTL sys_rectangle

Defines inclusive-inclusive type of a system rectangle.

Locations of window rectangles are described by sys_rectangle structures, which contain the coordinates of two points that define the opposite corners of the rectangle.

There are two types of sytem rectangles: inclusive-inclusive and inclusive-exclusive. In inclusive-exclusive rectangles, the first corner of the rectangle is included within the rectangle area, while the second corner is excluded from the rectangle area. In an inclusive-inclusive rectangle, both the corners are included in the rectangle.

Source:

pm_rectangle.h:46

Code:

public enum inclusive_type {

inclusive }

Defines inclusive-exclusive type of a system rectangle.

Locations of window rectangles are described by sys_rectangle structures, which contain the coordinates of two points that define the opposite corners of the rectangle.

There are two types of sytem rectangles: inclusive-inclusive and inclusive-exclusive. In inclusive-exclusive rectangles, the first corner of the rectangle is included within the rectangle area, while the second corner is excluded from the rectangle area. In an inclusive-inclusive rectangle, both the corners are included in the rectangle.

Source:

pm_rectangle.h:63

Code:

public enum exclusive_type {

exclusive }

Constructs the empty rectangle object.

Source:

pm_rectangle.h:66

Code:

public PMRect (

)

Constructs the rectangle object from coordinates.

Source:

pm_rectangle.h:68

Code:

public PMRect (	long x ,
	long y ,
	long cx ,
	long cy )

Constructs the rectangle from inclusive-inclusive system rectangle.

Source:

pm_rectangle.h:70

Code:

public PMRect (	const sys_rectangle & ,
	const inclusive_type & )

Constructs the rectangle from inclusive-exclusive system rectangle.

Source:

pm_rectangle.h:72

Code:

public PMRect (	const sys_rectangle & ,
	const exclusive_type & )

The rectangle's x-coordinate.

Source:

pm_rectangle.h:74

Code:

public long x

The rectangle's y-coordinate.

Source:

pm_rectangle.h:75

Code:

public long y

The rectangle's width.

Source:

pm_rectangle.h:76

Code:

public long cx

The rectangle's height.

Source:

pm_rectangle.h:77

Code:

public long cy

If the width or height of this rectangle is zero, TRUE is returned.

Source:

pm_rectangle.h:80

Code:

public BOOL empty (

) const

If the rectangle and specified rectangle overlap, TRUE is returned.

Source:

pm_rectangle.h:83

Code:

public BOOL intersects (

const PMRect & ) const

If the rectangle contains the specified point, TRUE is returned.

Source:

pm_rectangle.h:85

Code:

public BOOL contains (	long x ,
	long y ) const

Shrinks the rectangle.

Moves the corners of the rectangle inward toward the center by the specified amount

Source:

pm_rectangle.h:94

Code:

public void shrink_by (

long amount )

Expands the rectangle.

Moves the corners of the rectangle outward from the center by the specified amount

Source:

pm_rectangle.h:103

Code:

public void expand_by (

long amount )

Maps a rectangle.

Maps a rectangle from one window's coordinate space to another's, such as mapping from screen coordinates to window coordinates.

Source:

pm_rectangle.h:112

Code:

public void map (	HWND hfrom ,
	HWND hto )

Compares this object to another rectangle object for equality.

Source:

pm_rectangle.h:115

Code:

public BOOL operator == (

const PMRect & ) const

Compares this object to another rectangle object for inequality.

Source:

pm_rectangle.h:117

Code:

public BOOL operator != (

const PMRect & ) const

Converts the rectangle value to inclusive-inclusive system rectangle.

Source:

pm_rectangle.h:120

Code:

public sys_rectangle as_sys_value (

const inclusive_type & ) const

Converts the rectangle value to inclusive-exclusive system rectangle.

Source:

pm_rectangle.h:122

Code:

public sys_rectangle as_sys_value (

const exclusive_type & ) const