GridSpan Class Reference

#include <TableTypes.h>

Public Types
typedef base_type	data_type

Public Member Functions
	GridSpan ()
	GridSpan (int32 inHeight, int32 inWidth)
void	Set (int32 inHeight, int32 inWidth)
bool16	IsUnitSpan () const
bool16	IsEmpty () const
bool16	operator== (const GridSpan &rhs) const
bool16	operator!= (const GridSpan &rhs) const
void	ReadWrite (IPMStream *stream)

Public Attributes
int32	height
int32	width

Detailed Description

Row and column span of cells.

Author

Joe Shankar

See Also

ITableModel

Member Typedef Documentation

typedef base_type GridSpan::data_type

For K2Vector. Specifies that this is a data class that has no specialised copy semantics- shallow copy of the fields is enough to copy state of an instance.

Constructor & Destructor Documentation

GridSpan::GridSpan ( )

inline

No-args constructor.

GridSpan::GridSpan ( int32  inHeight, int32  inWidth  )

inline

Constructor.

Parameters

inHeight	specifies the rows spanned
inWidth	specifies the columns spanned

Member Function Documentation

bool16 GridSpan::IsEmpty ( void  ) const

inline

Query to determine if both the row and column spans are zero.

Returns

kTrue if this is an empty span, with both row and column span of zero, kFalse otherwise

bool16 GridSpan::IsUnitSpan ( ) const

inline

Determine if this is a 'trivial' or unit span.

Returns

kTrue if unit span(1,1), kFalse otherwise

bool16 GridSpan::operator!= ( const GridSpan &  rhs ) const

inline

Overload of not-equal operator. Semantics; if this span and the rhs differ in height or width then they are not identical.

Returns

kTrue if width or height of this and comparand grid-span objects differ, kFalse otherwise

bool16 GridSpan::operator== ( const GridSpan &  rhs ) const

inline

Overload of equality comparison operator. Semantics; this and rhs span are identical iff the height and width of both are identical.

Returns

kTrue if the width and height of this and comparand grid-spans are equal, kFalse otherwise

void GridSpan::Set ( int32  inHeight, int32  inWidth  )

inline

Mutator.

Parameters

inHeight	rows spanned
inWidth	columns spanned

Member Data Documentation

int32 GridSpan::height

Represents the count of rows spanned.

int32 GridSpan::width

Represents the count of columns spanned