#include <ITblBscSuite.h>

Inheritance diagram for ITblBscSuite:

Public Types
enum	{ kDefaultIID = IID_ITBLBSCSUITE }

Public Member Functions
virtual bool16	CanInsertTable () const =0

virtual ErrorCode	InsertTable (int32 numRows, int32 numCols)=0

virtual bool16	CanSetCellText (int32 row, int32 col) const =0

virtual ErrorCode	SetCellText (int32 row, int32 col, const WideString &text)=0

virtual bool16	CanGetCellText (int32 row, int32 col) const =0

virtual void	GetCellText (int32 row, int32 col, WideString &text) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

From SDK sample; abstract suite interface for table creation and table cell text content manipulation. ITableSuite now provides a method to insert a table but no suites are provided that set and get the text in a table cell. So this custom suite is still required to fully manipulate table content.

Member Function Documentation

virtual bool16 ITblBscSuite::CanGetCellText	(	int32	row,
		int32	col
	)		const

pure virtual

Return kTrue if the text for the given cell in the table in which the selection lies can be read.

Parameters

row	IN number of the cell you want to get the text for.
col	IN column number of the cell you want to get the text for.

Returns: kTrue if the text can be read, kFalse otherwise.

Implemented in TblBscSuiteTextCSB, and TblBscSuiteASB.

virtual bool16 ITblBscSuite::CanInsertTable ( ) const

pure virtual

Return kTrue if ITblBscSuite::InsertTable can be called, kFalse otherwise.

Returns: kTrue if ITblBscSuite::InsertTable can be called, kFalse otherwise.

Implemented in TblBscSuiteTextCSB, and TblBscSuiteASB.

virtual bool16 ITblBscSuite::CanSetCellText	(	int32	row,
		int32	col
	)		const

pure virtual

Return kTrue if the text for the given cell in the table in which the selection lies can be changed, kFalse otherwise.

Parameters

row	IN number of the cell you want to set the text for.
col	IN column number of the cell you want to set the text for.

Returns: kTrue if text can be set, kFalse otherwise.

Implemented in TblBscSuiteTextCSB, and TblBscSuiteASB.

virtual void ITblBscSuite::GetCellText	(	int32	row,
		int32	col,
		WideString &	text
	)		const

pure virtual

Get the text for the given cell in the table in which the selection lies.

Precondition: ITblBscSuite::CanGetCellText == kTrue.

Parameters

row	IN number of the cell you want to get the text for.
col	IN column number of the cell you want to get the text for.
text	OUT the text extracted from the cell.

Implemented in TblBscSuiteTextCSB, and TblBscSuiteASB.

virtual ErrorCode ITblBscSuite::InsertTable	(	int32	numRows,
		int32	numCols
	)

pure virtual

Insert table at the current selection location.

Precondition: ITblBscSuite::CanInsertTable == kTrue.

Parameters

numRows	IN number of rows in the table.
numCols	IN number of columns in the table.

Returns: kSuccess on success, otherwise failure

Implemented in TblBscSuiteTextCSB, and TblBscSuiteASB.

virtual ErrorCode ITblBscSuite::SetCellText	(	int32	row,
		int32	col,
		const WideString &	text
	)

pure virtual

Change the text for the given cell in the table in which the selection lies.

Precondition: ITblBscSuite::CanSetCellText == kTrue.

Parameters

row	IN number of the cell you want to set the text for.
col	IN column number of the cell you want to set the text for.
text	IN the string the cell should contain.

Returns: kSuccess if the text was set successfully.

Implemented in TblBscSuiteTextCSB, and TblBscSuiteASB.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation