TblAttQueryMutHelper Class Reference

#include <TblAttQueryMutHelper.h>

Public Member Functions
	TblAttQueryMutHelper ()
virtual	~TblAttQueryMutHelper ()
bool16	IsValidCondition ()
void	SetCellAttributeReal (const ClassID &classID, const PMReal realParam)
void	SetTableAttributeReal (const ClassID &classID, const PMReal realParam)
void	SetCellStroke (const Tables::ESelectionSides sides, const PMReal strokeWeight)
PMReal	GetCellAttributeReal (const ClassID &classID)
PMReal	GetTableAttributeReal (const ClassID &classID)
PMReal	GetCellStroke (const Tables::ESelectionSides sides)

Detailed Description

Class TblAttQueryMutHelper to provide get/set methods for table attributes. Also contains test-helper code.

Constructor & Destructor Documentation

TblAttQueryMutHelper::TblAttQueryMutHelper

(

)

Constructor.

TblAttQueryMutHelper::~TblAttQueryMutHelper ( )

virtual

Destructor.

Member Function Documentation

PMReal TblAttQueryMutHelper::GetCellAttributeReal

(

const ClassID &

classID

)

Get the value of a cell attribute by ClassID.

Parameters

classID

IN The ClassID of the attribute to get.

Returns

the attribute value if unique, (-1) otherwise

PMReal TblAttQueryMutHelper::GetCellStroke

(

const Tables::ESelectionSides

sides

)

Get a cell stroke attribute.

Parameters

sides

IN The side(s) of the cell to get.

Returns

the attribute value if available, (-1) otherwise

PMReal TblAttQueryMutHelper::GetTableAttributeReal

(

const ClassID &

classID

)

Get the value of a table-wide attribute by ClassID.

Parameters

classID

IN The ClassID of the attribute to get.

Returns

the attribute value if available, (-1) otherwise

bool16 TblAttQueryMutHelper::IsValidCondition

(

)

Return true if the methods are liable to perform correctly. Helper for test methods. Called e.g. from test-harness.

Returns

kTrue if in valid state, kFalse otherwise.

void TblAttQueryMutHelper::SetCellAttributeReal	(	const ClassID &	classID,
		const PMReal	realParam
	)

Set a cell attribute with given ClassID to the specified real-number.

Parameters

classID	IN The ClassID of the attribute to set.
realParam	IN The value of the attribute to set.

void TblAttQueryMutHelper::SetCellStroke	(	const Tables::ESelectionSides	sides,
		const PMReal	strokeWeight
	)

Set a cell stroke attribute to the specified stroke weight.

Parameters

sides	IN The side(s) of the cell to set.
strokeWeight	IN The stroke weight to set.

void TblAttQueryMutHelper::SetTableAttributeReal	(	const ClassID &	classID,
		const PMReal	realParam
	)

Set a table-wide attribute with given ClassID to the specified real-number.

Parameters

classID	IN The ClassID of the attribute to set.
realParam	IN The value of the attribute to set.