INewTableCmdData Class Reference

#include <INewTableCmdData.h>

Inheritance diagram for INewTableCmdData:

Public Types
enum	{ kDefaultIID = IID_INEWTABLECMDDATA }

Public Member Functions
virtual void	Set (IDataBase *db, UID textModelUID, TextIndex insertionPoint, int32 numBodyRows, int32 numColumns, const PMReal &tableWidth, const PMReal &tableHeight, CellType cellType, bool16 useExistingAnchor=kFalse)=0
virtual void	Set (IDataBase *db, UID textModelUID, TextIndex insertionPoint, int32 numHeaderRows, int32 numBodyRows, int32 numFooterRows, int32 numColumns, const PMReal &tableWidth, const PMReal &tableHeight, CellType cellType, bool16 useExistingAnchor=kFalse)=0
virtual void	Get (int32 &numHeaderRows, int32 &numBodyRows, int32 &numFooterRows, int32 &numColumns, PMReal &tableWidth, PMReal &tableHeight, CellType &cellType) const =0
virtual IDataBase *	GetDataBase (void) const =0
virtual UID	GetTextModelUID () const =0
virtual TextIndex	GetTextIndex () const =0
virtual bool16	GetUseExistingAnchor () const =0
virtual void	SetDirection (Tables::EDirection direction)=0
virtual Tables::EDirection	GetDirection () 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

Is a holder class for specifications for a new table, used when call ITableUtils::InsertTable.

Author

jshankar

See Also

ITableUtils.h

Member Function Documentation

virtual void INewTableCmdData::Get ( int32 &  numHeaderRows, int32 &  numBodyRows, int32 &  numFooterRows, int32 &  numColumns, PMReal &  tableWidth, PMReal &  tableHeight, CellType &  cellType  ) const

pure virtual

Get data from this holder class.

Parameters

numHeaderRows	Number of header rows in new table.
numBodyRows	Number of body rows in new table.
numFooterRows	Number of footer rows in new table.
numColumns	Number of columns in new table.
tableWidth	New table width in points.
tableHeight	New table height in points.
cellType	Type of cell (no content, text, etc.).

virtual IDataBase* INewTableCmdData::GetDataBase ( void  ) const

pure virtual

Get DataBase from this holder class.

Returns

IDatabase* Target story's database.

virtual Tables::EDirection INewTableCmdData::GetDirection ( ) const

pure virtual

Get use direction from this holder class.

Returns

EDirection direction

virtual TextIndex INewTableCmdData::GetTextIndex ( ) const

pure virtual

Get TextIndex from this holder class.

Returns

TextIndex Text insertion point of the new table's table character.

virtual UID INewTableCmdData::GetTextModelUID ( ) const

pure virtual

Get TextModel UID from this holder class.

Returns

UID TextModel of the new table.

virtual bool16 INewTableCmdData::GetUseExistingAnchor ( ) const

pure virtual

Get use existing anchor from this holder class.

Returns

bool16 no anchors

virtual void INewTableCmdData::Set ( IDataBase *  db, UID  textModelUID, TextIndex  insertionPoint, int32  numBodyRows, int32  numColumns, const PMReal &  tableWidth, const PMReal &  tableHeight, CellType  cellType, bool16  useExistingAnchor = kFalse  )

pure virtual

Set data in this holder class.

Parameters

db	Target story's database.
textModelUID	TextModel in which to make the new table.
insertionPoint	Text insertion point at which to make the new table.
numBodyRows	Number of body rows in new table.
numColumns	Number of columns in new table.
tableWidth	New table width in points.
tableHeight	New table height in points.
cellType	Type of cell (no content, text, etc.).
useExistingAnchor	optional parameter that allows the Table to inherit the first anchor character that already exist at the insertion point.

virtual void INewTableCmdData::Set ( IDataBase *  db, UID  textModelUID, TextIndex  insertionPoint, int32  numHeaderRows, int32  numBodyRows, int32  numFooterRows, int32  numColumns, const PMReal &  tableWidth, const PMReal &  tableHeight, CellType  cellType, bool16  useExistingAnchor = kFalse  )

pure virtual

Set data in this holder class.

Parameters

db	Target story's database.
textModelUID	TextModel in which to make the new table.
insertionPoint	Text insertion point at which to make the new table.
numHeaderRows	Number of header rows in new table.
numBodyRows	Number of body rows in new table.
numFooterRows	Number of footer rows in new table.
numColumns	Number of columns in new table.
tableWidth	New table width in points.
tableHeight	New table height in points.
cellType	Type of cell (no content, text, etc.).
useExistingAnchor	optional parameter that allows the Table to inherit the first anchor character that already exist at the insertion point.

virtual void INewTableCmdData::SetDirection ( Tables::EDirection  direction )

pure virtual

Set the direction for this holder class.

Returns

EDirection direction