SDK Home Glossary Index Left Right Up

Size


Section contents


Overview

Defined in

ce32base.oxh

Description

<TBS>


Construction / destruction


NewSize - Constructor

Usage

this& = NewSize&:(width&,height&)

Description

Creates a size object and returns a handle which allows the object to be manipulated.

Parameters
width& The width of the size.
height& The height of the size
Return Value
this& An value which represents the created size
Error Handling

If the object could not be created then an error is generated which should be trapped by an ONERR handler.

Example
  LOCAL this&

  this& = NewSize&:(50,50)
  DeleteSize:(this&) 

DeleteSize - Destructor

Usage

DeleteSize:(this&)

Description

Destroys the size object.

Arguments
this& A handle to a size object
Example
  LOCAL this&

  this& = NewSize&:(50,50)
  DeleteSize:(this&) 

Methods provided


SizeAdd

Usage

this& = SizeAdd&:(this&,size&)

Description

Adds the size in size& to the size in this& and returns the handle this&.

Arguments
this& A handle to a size object
size& A handle to a size objec
Return value
this& A handle to a size object

SizeAddPoint

Usage

this& = SizeAddPoint&:(this&,point&)

Description

Adds the point in point& to the size in this& and returns the handle this&.

Arguments
this& A handle to a size object
point& A handle to a point objec
Return value
this& A handle to a size object

SizeAsPoint

Usage

point& = SizeAsPoint&:(this&)

Description

<TBS>

Arguments
this& A handle to a size object
Return value
point& A point object created. The handle should be freed by the caller when it is no longer required.
Error Handling

If the point& object cannot be created then an error is generated which should be trapped by an ONERR handler.


SizeEQ

Usage

result% = SizeEQ%:(this&,size&)

Description

Compares the 2 sizes for equality.

Arguments
this& A handle to a size object
size& A handle to a size objec
Return value
result% Returns -1 (true) if the sizes described by this& and size& are the same, otherwise returns 0

SizeHeight

Usage

height& = SizeHeight&:(this&)

Description

Returns the height of the size object..

Arguments
this& A handle to a size object
Return value
height& The height of the size object

SizeMinus

Usage

this& = SizeMinus&:(this&,size&)

Description

Subtracts the size in size& from the size in this& and returns the handle this&.

Arguments
this& A handle to a size object
size& A handle to a size objec
Return value
this& A handle to a size object

SizeMinusPoint

Usage

this& = SizeMinusPoint&:(this&,size&)

Description

Subtracts the point in point& from the size in this& and returns the handle this&.

Arguments
this& A handle to a size object
point& A handle to a point objec
Return value
this& A handle to a size object

SizeNE

Usage

result% = SizeNE%:(this&,size&)

Description

Compares the 2 size for inequality.

Arguments
this& A handle to a size object
size& A handle to a size objec
Return value
result% Returns -1 (true) if the sizes described by this& and size& are not the same, otherwise returns 0

SizeNegate

Usage

this& = SizeNegate&:(this&)

Description

Negates the size in this& and returns the handle this&.

Arguments
this& A handle to a size object
Return value
this& A handle to a size object

SizeSetSize

Usage

SizeSetSize:(this&,width&,height&)

Description

Set the width and height of the size object..

Arguments
this& A handle to a size object
width& The width
height& The height

SizeWidth

Usage

width& = SizeWidth&:(this&)

Description

Returns the width of the size object..

Arguments
this& A handle to a size object
Return value
width& The width of the size object

  SDK Home Glossary Index Left Right Up