CIP C++ documentation for class "wfcSelectionBox"

Class wfcSelectionBox

# include <wfcExternalObject.h> class wfcSelectionBox : public xobject { xdeclare(wfcSelectionBox) ... }; This is a COMPACT class.

Description

A 2x3 array representing a selection box

Array provides methods for accessing its elemnts by index(indices) and for modifying its elements. Array object "does not know" its dimentions.

Array Dimensions: [2] [3]

Method Summary


`static wfcSelectionBox *`	`create ()`
	Creates new array object with uninitialized elements.

`xreal`	`get (xint idx0, xint idx1)`
	Gets an array element with the specified index(indices). If an index is out of range throws exception `cipXInvalidArrayIndex`.

`void`	`set (xint idx0, xint idx1, xreal value)`
	Assignes a new value to an array element with the specified index(indices). If an index is out of range throws exception `cipXInvalidArrayIndex`.

Method Detail

xreal get (xint idx0, xint idx1)

Gets an array element with the specified index(indices). If an index is out of range throws exception cipXInvalidArrayIndex.

Parameters:

idx0: First element index.
idx1: Second element index.

Returns:: Element value.

void set (xint idx0, xint idx1, xreal value)

Assignes a new value to an array element with the specified index(indices). If an index is out of range throws exception cipXInvalidArrayIndex.

Parameters:

idx0: First element index.
idx1: Second element index.
value: New element value.

Returns:

static wfcSelectionBox * create ()

Creates new array object with uninitialized elements.

Returns:: Created array.