#include <ITableSuite.h>

Inheritance diagram for ITableSuite:

Classes
class	FreezeTickHolder

struct	OverrideState

class	UserRowNumber

Public Types
enum	{ kDefaultIID = IID_ITABLE_ISUITE }

enum	ESplitDirection { eVerticalSplit, eHorizontalSplit }

typedef K2Vector< OverrideState >	OverrideStateVector

Public Member Functions
virtual bool16	CanInsertRows (Tables::ERelativePosition pos) const =0

virtual bool16	CanInsertColumns (Tables::ERelativePosition pos) const =0

virtual bool16	CanDeleteRows (void) const =0

virtual bool16	CanDeleteColumns (void) const =0

virtual bool16	CanMergeCells (void) const =0

virtual bool16	CanUnmergeCell (void) const =0

virtual bool16	CanSplitCells (ESplitDirection direction) const =0

virtual bool16	CanEditTable (void) const =0

virtual bool16	CanConvertTableToText () const =0

virtual bool16	CanDeleteTable () const =0

virtual void	InsertRows (int32 howMany, Tables::ERelativePosition pos, const PMReal &rowHeight, Tables::EContinuation continuation=Tables::eStructureAllAttrs)=0

virtual void	InsertColumns (int32 howMany, Tables::ERelativePosition pos, const PMReal &colWidth, Tables::EContinuation continuation=Tables::eStructureAllAttrs)=0

virtual void	DeleteRows (void)=0

virtual void	DeleteColumns (void)=0

virtual void	MergeCells (void)=0

virtual void	UnmergeCell (void)=0

virtual void	SplitCells (ESplitDirection direction)=0

virtual void	ConvertTableToText (const PMString colSeparator="\t", const PMString rowSeparator="\r")=0

virtual void	DeleteTable ()=0

virtual bool16	CanClearAllTableOverrides () const =0

virtual bool16	CanClearSelectionOverrides () const =0

virtual void	ClearAllTableOverrides (AttributeBossList &attrs) const =0

virtual void	ClearSelectionOverrides (AttributeBossList &attrs, ICellStrokeAttrData::Data &data) const =0

virtual bool16	CanResizeRows (void) const =0

virtual bool16	CanResizeColumns (void) const =0

virtual void	ResizeRows (const PMReal &height)=0

virtual void	ResizeColumns (const PMReal &width)=0

virtual bool16	CanResizeCellHeight (void) const =0

virtual bool16	CanResizeCellWidth (void) const =0

virtual void	ResizeCellHeight (const PMReal &height)=0

virtual void	ResizeCellWidth (const PMReal &width)=0

virtual bool16	CanRedistributeRows (void) const =0

virtual bool16	CanRedistributeColumns (void) const =0

virtual void	RedistributeRows (void)=0

virtual void	RedistributeColumns (void)=0

virtual bool16	CanSwapCellStrokeFill (void) const =0

virtual void	SwapCellStrokeFill (void)=0

virtual void	ChangeBodyRowDimensionTo (int32 newRowDim) const =0

virtual void	ChangeColumnDimensionTo (int32 newColDim) const =0

virtual void	ChangeHeaderRowDimensionTo (int32 newRowDim) const =0

virtual void	ChangeFooterRowDimensionTo (int32 newRowDim) const =0

virtual bool16	CanChangeTableDimensions (void) const =0

virtual bool16	CanConvertToHeaderRows (void) const =0

virtual void	ConvertToHeaderRows (void)=0

virtual bool16	CanConvertToFooterRows (void) const =0

virtual void	ConvertToFooterRows (void)=0

virtual bool16	CanConvertToBodyRows (void) const =0

virtual void	ConvertToBodyRows (void)=0

virtual bool16	CanCreateTableStyleFromSelection (void) const =0

virtual void	CreateTableStyleFromSelection (void)=0

virtual bool16	CanApplyTableStyle (int32 nthStyle) const =0

virtual void	ApplyTableStyle (int32 nthStyle)=0

virtual bool16	CanFreezeTick () const =0

virtual FreezeTickHolder *	FreezeTick ()=0

virtual bool16	CanGetRowSize (void) const =0

virtual bool16	CanGetColumnSize (void) const =0

virtual PMReal	GetRowSize (void) const =0

virtual PMReal	GetColumnSize (void) const =0

virtual bool16	CanGetCellWidth (void) const =0

virtual bool16	CanGetCellHeight (void) const =0

virtual PMReal	GetCellWidth (void) const =0

virtual PMReal	GetCellHeight (void) const =0

virtual bool16	CanApplyTableOverrides () const =0

virtual void	ApplyTableOverrides (const AttributeBossList *attrs)=0

virtual const IPMUnknown *	QueryTableAttribute (ClassID whichAttr) const =0

virtual void	ApplyCellOverrides (const AttributeBossList *attrs)=0

virtual bool16	CanApplyCellOverrides (void) const =0

virtual bool16	CanGetCellAttribute (ClassID whichAttr) const =0

virtual const IPMUnknown *	QueryCellAttribute (ClassID whichAttr) const =0

virtual bool16	CanApplyCellStrokes (const ICellStrokeAttrData::Data &data) const =0

virtual void	ApplyCellStrokes (const ICellStrokeAttrData::Data &data)=0

virtual bool16	CanGetCellStrokes (const ICellStrokeAttrData::Data &data) const =0

virtual void	GetCellStrokes (ICellStrokeAttrData::Data &data) const =0

virtual bool16	CanGetApplyCellStrokesBySelection (void) const =0

virtual void	ApplyCellStrokesBySelection (const IPMUnknown *attr)=0

virtual const IPMUnknown *	GetCellStrokesBySelection () const =0

virtual void	ApplyRowOverrides (const AttributeBossList *attrs)=0

virtual bool16	CanApplyRowOverrides (void) const =0

virtual bool16	CanApplyRowKeeps (void) const =0

virtual bool16	CanGetRowAttribute (ClassID whichAttr) const =0

virtual const IPMUnknown *	QueryRowAttribute (ClassID whichAttr) const =0

virtual bool16	CanGetColAttribute (ClassID whichAttr) const =0

virtual const IPMUnknown *	QueryColAttribute (ClassID whichAttr) const =0

virtual bool16	CanGetOverridesInTable () const =0

virtual void	GetOverridesInTable (Tables::ERowColumn patternType, int32 firstPatternCount, int32 secondPatternCount, int32 skipFirst, int32 skipLast, const AttributeBossList findAttrsFirst, const AttributeBossList findAttrsSecond, OverrideStateVector resultFirst, OverrideStateVector resultSecond) const =0

virtual void	ClearRowPatternFillOverrides (const AttributeBossList firstOverrideAttrs, const AttributeBossList secondOverrideAttrs, const int32 pattern1, const int32 pattern2, const int32 skipFirst, const int32 skipLast)=0

virtual void	ClearColumnPatternFillOverrides (const AttributeBossList firstOverrideAttrs, const AttributeBossList secondOverrideAttrs, const int32 pattern1, const int32 pattern2, const int32 skipFirst, const int32 skipLast)=0

virtual void	GetStrokeOverridesInTable (Tables::ERowColumn patternType, int32 firstPatternCount, int32 secondPatternCount, int32 skipFirst, int32 skipLast, const ICellStrokeAttrData::Data &firstData, const ICellStrokeAttrData::Data &secontData, ICellStrokeAttrData::Data &resultFirst, ICellStrokeAttrData::Data &resultSecond) const =0

virtual void	ClearRowPatternStrokeOverrides (const ICellStrokeAttrData::Data &firstOverrideAttrs, const ICellStrokeAttrData::Data &secondOverrideAttrs, const int32 pattern1, const int32 pattern2, const int32 skipFirst, const int32 skipLast)=0

virtual void	ClearColumnPatternStrokeOverrides (const ICellStrokeAttrData::Data &firstOverrideAttrs, const ICellStrokeAttrData::Data &secondOverrideAttrs, const int32 pattern1, const int32 pattern2, const int32 skipFirst, const int32 skipLast)=0

virtual void	GetBorderOverridesInTable (const AttributeBossList findAttrs, OverrideStateVector results) const =0

virtual void	ClearOverridesIntersectingBorder (const AttributeBossList leftSideAttrs, const AttributeBossList topSideAttrs, const AttributeBossList rightSideAttrs, const AttributeBossList bottomSideAttrs)=0

virtual bool16	CanGetWritingDirection (void) const =0

virtual bool16	IsWritingDirectionHorizontal (void) const =0

virtual UserRowNumber	GetUserCurrentRowNumber (void) const =0

virtual int32	GetUserCurrentColNumber (void) const =0

virtual bool16	CanGetTextFramesSpannedBySelection () const =0

virtual K2Vector < ITextFrameColumn * > *	GetTextFramesSpannedBySelection () const =0

virtual bool16	CanGetSpanInformationFromSelection () const =0

virtual int32	GetHSpanSmallestHorizMergedCellInSelection () const =0

virtual int32	GetHSpanLargestHorizMergedCellInSelection () const =0

virtual int32	GetVSpanSmallestVertMergedCellInSelection () const =0

virtual int32	GetVSpanLargestVertMergedCellInSelection () const =0

virtual bool16	CanGetUserRowSelection (int32 rowNum) const =0

virtual int32	GetUserRowSelection (const int32 rowNum, const ITableSuite::UserRowNumber::RowType rowType) const =0

virtual bool16	IsHeaderSelection () const =0

virtual bool16	IsFooterSelection () const =0

virtual bool16	isWholeTableSelected () const =0

virtual bool16	CanGetMaxMinRowSizeOfSelection () const =0

virtual PMReal	GetMaxRowSizeOfSelection () const =0

virtual PMReal	GetMinRowSizeOfSelection () const =0

virtual bool16	CanGetSelectionActiveStrokes (void) const =0

virtual Tables::ESelectionSides	GetSelectionActiveStrokes (void)=0

virtual bool16	CanGetTableProperties (void) const =0

virtual bool16	CanGetHeader (void) const =0

virtual bool16	CanGetFooter (void) const =0

virtual int32	GetNumRowsInTable (void) const =0

virtual int32	GetNumColsInTable (void) const =0

virtual int32	GetNumHeaderRowsInTable (void) const =0

virtual int32	GetNumFooterRowsInTable (void) const =0

virtual int32	GetUserNumRowsInTable (void) const =0

virtual int32	GetUserNumColsInTable (void) const =0

virtual bool16	TableContainsHeaders (void) const =0

virtual bool16	TableContainsFooters (void) const =0

virtual bool16	CanInsertTable () const =0

virtual void	InsertTable (const int32 numRows, const int32 numCols, const int32 headerRows, const int32 footerRows, const UID &tableStyleUID=kInvalidUID, const Tables::EDirection direction=Tables::eLTR)=0

virtual bool16	CanConvertTextToTable () const =0

virtual UIDRef	ConvertTextToTable (const PMString colSeparator="\t", const PMString rowSeparator="\r", const int32 userNumCols=1, const UID &tableStyleUID=kInvalidUID) const =0

virtual UIDRef	ConvertTextToTable (const K2Vector< PMString > &colSeparators, const K2Vector< PMString > &rowSeparators, const int32 userNumCols=1, const UID &tableStyleUID=kInvalidUID) const =0

virtual bool16	AnyFootnotesInSelection () const =0

virtual bool16	CanGetTableDirection (void) const =0

virtual Tables::EDirection	GetTableDirection (void) const =0

virtual bool16	CanChangeTableDirection (void) const =0

virtual void	ChangeTableDirection (Tables::EDirection NewDirection) const =0

virtual bool16	CanMoveRows (int32 toRow) const =0

virtual void	MoveRows (ITableModel *sourceTable, GridArea fromArea, int32 toRow, Tables::ERelativePosition, bool16 duplicateFlag)=0

virtual bool16	CanMoveColumns (int32 toColumn) const =0

virtual void	MoveColumns (ITableModel *sourceTable, GridArea fromArea, int32 toColumn, Tables::ERelativePosition pos, bool16 duplicateFlag)=0

virtual bool16	CanPasteRows (bool16 isPasteAfter) const =0

virtual bool16	CanConvertCellsType (CellType destType) const =0

virtual void	ConvertCellsType (CellType destType, bool16 tryToPreserveData)=0

virtual bool16	CanPasteColumns (bool16 isPasteAfter) const =0

virtual GridArea	GetFocussedArea () const =0

virtual bool16	CanGetFocussedArea () const =0

virtual bool16	CanPastePageItem () const =0

virtual void	PastePageItem (const GridAddress &anchor, UIDRef pageItemUID, bool16 preventCopy)=0

virtual bool16	IsAnyTextCellSelected () const =0

virtual bool16	IsAnyGraphicCellSelected () 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

Manipulates the table selection.

See Also: ISelectionUtils

Member Typedef Documentation

typedef K2Vector<OverrideState> ITableSuite::OverrideStateVector

Collection of override state information returned by GetOverridesInTable().

Member Enumeration Documentation

enum ITableSuite::ESplitDirection

Directions in which a cell can be split.

Member Function Documentation

virtual bool16 ITableSuite::AnyFootnotesInSelection ( ) const

pure virtual

Returns true if any footnotes were found in the selection

Returns: bool16 true if any footnotes were found in the selection

virtual void ITableSuite::ApplyCellOverrides ( const AttributeBossList * attrs )

pure virtual

Override the given cell attributes.

Parameters

attrs list of attributes to be overridden.

Precondition: CanApplyCellOverrides() == kTrue.

virtual void ITableSuite::ApplyCellStrokes ( const ICellStrokeAttrData::Data & data )

pure virtual

Change the cell stroke attributes to the values given by data. The attributes to be changed and their new values are identified by the data interface which allows them to be set in a single call.

Parameters

data	identifyies cell stroke attributes to be changed and their new values.

Precondition: CanApplyCellStrokes() == kTrue.

virtual void ITableSuite::ApplyCellStrokesBySelection ( const IPMUnknown * attr )

pure virtual

Change cell stroke attributes using the selection's cell stroke data.

Parameters

interface pointer to data boss class

virtual void ITableSuite::ApplyRowOverrides ( const AttributeBossList * attrs )

pure virtual

Override the given row attributes associated with the selection.

Precondition: CanApplyRowOverrides() == kTrue.

Parameters

attrs list of attributes to be overridden.

virtual void ITableSuite::ApplyTableOverrides ( const AttributeBossList * attrs )

pure virtual

Override the given table attributes.

Parameters

attrs list of attributes to be overridden.

Precondition: CanApplyTableOverrides() == kTrue.

virtual void ITableSuite::ApplyTableStyle ( int32 nthStyle )

pure virtual

INTERNAL USE ONLY, UNTESTED!

virtual bool16 ITableSuite::CanApplyCellOverrides ( void ) const

pure virtual

Returns kTrue if ApplyCellOverrides() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanApplyCellStrokes ( const ICellStrokeAttrData::Data & data ) const

pure virtual

Returns kTrue if ApplyCellStrokes() can be called to change the cell stroke attributes indicated in data, kFalse otherwise.

Parameters

data	identifies the cell stroke attributes to be changed.

virtual bool16 ITableSuite::CanApplyRowKeeps ( void ) const

pure virtual

Returns kTrue if you can apply keeps/start on attributes to this row

virtual bool16 ITableSuite::CanApplyRowOverrides ( void ) const

pure virtual

Returns kTrue if ApplyRowOverrides() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanApplyTableOverrides ( ) const

pure virtual

Returns kTrue if ApplyTableOverrides() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanApplyTableStyle ( int32 nthStyle ) const

pure virtual

INTERNAL USE ONLY, UNTESTED!

virtual bool16 ITableSuite::CanChangeTableDimensions ( void ) const

pure virtual

Returns kTrue if ChangeBodyRowDimensionTo(), ChangeColumnDimensionTo(), ChangeHeaderRowDimensionTo() or ChangeFooterRowDimensionTo() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanChangeTableDirection ( void ) const

pure virtual

Returns true if you can change the table direction

Returns: bool16 true if you can change the table direction

virtual bool16 ITableSuite::CanClearAllTableOverrides ( ) const

pure virtual

Returns kTrue if ClearAllTableOverrides() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanClearSelectionOverrides ( ) const

pure virtual

Returns kTrue if ClearSelectionOverrides() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanConvertCellsType ( CellType destType ) const

pure virtual

Returns kTrue if ConvertCellsType() can be called on selected cells, kFalse otherwise.

Parameters

destType cell type to be converted into

virtual bool16 ITableSuite::CanConvertTableToText ( ) const

pure virtual

Returns kTrue if ConvertTableToText() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanConvertTextToTable ( ) const

pure virtual

Returns true if you can convert the selected text to a table

Returns: bool16 true if can convert text to a table

virtual bool16 ITableSuite::CanConvertToBodyRows ( void ) const

pure virtual

Returns kTrue if Can Convert the selection To Body Rows

Returns: bool16

virtual bool16 ITableSuite::CanConvertToFooterRows ( void ) const

pure virtual

Returns kTrue if Can Convert the selection To Footer Rows

Returns: bool16

virtual bool16 ITableSuite::CanConvertToHeaderRows ( void ) const

pure virtual

Returns kTrue if Can Convert the selection To Header Rows

Returns: bool16

virtual bool16 ITableSuite::CanCreateTableStyleFromSelection ( void ) const

pure virtual

INTERNAL USE ONLY, UNTESTED!

virtual bool16 ITableSuite::CanDeleteColumns ( void ) const

pure virtual

Returns kTrue if DeleteColumns() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanDeleteRows ( void ) const

pure virtual

Returns kTrue if DeleteRows() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanDeleteTable ( ) const

pure virtual

Returns kTrue if DeleteTable() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanEditTable ( void ) const

pure virtual

Returns kTrue if you can edit the table, this is for InCopy because you can lock text

virtual bool16 ITableSuite::CanGetApplyCellStrokesBySelection ( void ) const

pure virtual

Returns kTrue if GetCellStrokesBySelection() or ApplyCellStrokesBySelection() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanGetCellAttribute ( ClassID whichAttr ) const

pure virtual

Returns kTrue if the value of the given attribute is the same for all selected cells and QueryCellAttribute() can be called, kFalse otherwise.

Parameters

whichAttr identifies the attribute to be checked, kCellAttrBottomInsetBoss for example.

virtual bool16 ITableSuite::CanGetCellHeight ( void ) const

pure virtual

Returns kTrue if GetCellHeight() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanGetCellStrokes ( const ICellStrokeAttrData::Data & data ) const

pure virtual

Returns kTrue if GetCellStrokes() can be called to get the value of the attributes indicated by data, kFalse otherwise.

Parameters

data	identifies the cell stroke attributes to be obtained.

virtual bool16 ITableSuite::CanGetCellWidth ( void ) const

pure virtual

Returns kTrue if GetCellWidth() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanGetColAttribute ( ClassID whichAttr ) const

pure virtual

Returns kTrue if all cols in the selection have the same value for whichAttr and QueryColAttribute() can be called, kFalse otherwise.

Parameters

whichAttr identifies the attribute to be checked, kColAttrWidthBoss for example.

virtual bool16 ITableSuite::CanGetColumnSize ( void ) const

pure virtual

Returns kTrue if selected columns have the same width and GetColumnSize() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanGetFocussedArea ( ) const

pure virtual

Returns kTrue if the grid area of selected region is valid area, kFalse otherwise.

Returns: bool16 return kTrue if a valid grid area can be returned

virtual bool16 ITableSuite::CanGetFooter ( void ) const

pure virtual

Returns true if you there is a footer in the table and you can make a selection in it

Returns: bool16 true if you there is a footer in the table and you can make a selection in it

virtual bool16 ITableSuite::CanGetHeader ( void ) const

pure virtual

Returns true if you there is a header in the table and you can make a selection in it

Returns: bool16 true if you there is a header in the table and you can make a selection in it

virtual bool16 ITableSuite::CanGetMaxMinRowSizeOfSelection ( ) const

pure virtual

Returns true if you can get the max/min row size of the selecton

Returns: bool16 true if you can get the max/min row size of the selecton

virtual bool16 ITableSuite::CanGetOverridesInTable ( ) const

pure virtual

Returns kTrue if GetOverridesInTable() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanGetRowAttribute ( ClassID whichAttr ) const

pure virtual

Returns kTrue if all rows in the selection have the same value for whichAttr and QueryRowAttribute() can be called, kFalse otherwise.

Parameters

whichAttr identifies the attribute to be checked, kRowAttrHeightBoss for example.

virtual bool16 ITableSuite::CanGetRowSize ( void ) const

pure virtual

Returns kTrue if selected rows have the same height and GetRowSize() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanGetSelectionActiveStrokes ( void ) const

pure virtual

Returns the sides of the cells which are active in the selection (sides can be set using the stroke proxy)

Returns: sides selected

virtual bool16 ITableSuite::CanGetSpanInformationFromSelection ( ) const

pure virtual

The following functions are used to find the span of the smallest/largest merged cell in the selection should only be used by the ui when calculating the min and max values for a edit box

virtual bool16 ITableSuite::CanGetTableDirection ( void ) const

pure virtual

Returns true if you can get the table direction

Returns: bool16 true if you can get direction

virtual bool16 ITableSuite::CanGetTableProperties ( void ) const

pure virtual

Returns true if you can get the properties of the table

Returns: bool16 true if you can get the properties of the table

virtual bool16 ITableSuite::CanGetTextFramesSpannedBySelection ( ) const

pure virtual

Returns kTrue if GetTextFramesSpannedBySelection() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanGetUserRowSelection ( int32 rowNum ) const

pure virtual

Returns the model row number that corresponds with the row number and row type as the user see it. USED ONLY BY THE GOTOROW DIALOG

Parameters

int32	row number as the user sees it (1-based)
ITableSuite::UserRowNumber::RowType	(eHeader, eFooter, eBody)

Precondition: rowNum > currentSelectionModel.TotalRows.start && rowNum <= currentSelectionModel.TotalRows.End

Postcondition: result >= currentSelectionModel.TotalRows.start && result < currentSelectionModel.TotalRows.End

virtual bool16 ITableSuite::CanGetWritingDirection ( void ) const

pure virtual

Returns kTrue if IsWritingDirectionHorizontal() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanInsertColumns ( Tables::ERelativePosition pos ) const

pure virtual

Returns kTrue if InsertColumns() can be called, kFalse otherwise.

Parameters

pos	insert before or after the columns in the selection.

virtual bool16 ITableSuite::CanInsertRows ( Tables::ERelativePosition pos ) const

pure virtual

Returns kTrue if InsertRows() can be called, kFalse otherwise.

Parameters

pos	insert before or after the rows in the selection.

virtual bool16 ITableSuite::CanInsertTable ( ) const

pure virtual

Returns true if you can insert a new table

Returns: bool16 true if you can insert a table

virtual bool16 ITableSuite::CanMergeCells ( void ) const

pure virtual

Returns kTrue if MergeCells() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanMoveColumns ( int32 toColumn ) const

pure virtual

Returns kTrue if columns can be moved to destination column, kFalse otherwise.

Parameters

toColumn The destination column

Returns: bool16 return kTrue if columns can be moved to destination column, kFalse otherwise

virtual bool16 ITableSuite::CanMoveRows ( int32 toRow ) const

pure virtual

Returns kTrue if rows can be moved to destination row, kFalse otherwise.

Parameters

toRow The destination row

Returns: bool16 return kTrue if rows can be moved to destination row, kFalse otherwise

virtual bool16 ITableSuite::CanPasteColumns ( bool16 isPasteAfter ) const

pure virtual

Returns kTrue if column(s) can be pasted after/before the selected area in the table, kFalse otherwise.

Parameters

isPasteAfter specifies whether the column is to be pasted after the selected area or before the selected area

Returns: bool16 return kTrue if column(s) can be pasted

virtual bool16 ITableSuite::CanPastePageItem ( ) const

pure virtual

Returns kTrue if we can paste page item into the grid area of selected region, kFalse otherwise.

Returns: bool16 return kTrue if we can paste page item into the grid area of selected region

virtual bool16 ITableSuite::CanPasteRows ( bool16 isPasteAfter ) const

pure virtual

Returns kTrue if row(s) can be pasted after/before the selected area in the table, kFalse otherwise.

Parameters

isPasteAfter specifies whether the row is to be pasted after the selected area or before the selected area

Returns: bool16 return kTrue if row(s) can be pasted

virtual bool16 ITableSuite::CanRedistributeColumns ( void ) const

pure virtual

Returns kTrue if RedistributeColumns() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanRedistributeRows ( void ) const

pure virtual

Returns kTrue if RedistributeRows() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanResizeCellHeight ( void ) const

pure virtual

Returns kTrue if ResizeCellHeight() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanResizeCellWidth ( void ) const

pure virtual

Returns kTrue if ResizeCellWidth() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanResizeColumns ( void ) const

pure virtual

Returns kTrue if ResizeColumns() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanResizeRows ( void ) const

pure virtual

Returns kTrue if ResizeRows() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanSplitCells ( ESplitDirection direction ) const

pure virtual

This method is obsolete. Please use CanSplitCells(). Returns kTrue if SplitCell() can be called, kFalse otherwise.

Parameters

direction	of split, vertical or horizontal. Returns kTrue if SplitCells() can be called, kFalse otherwise.
direction	of split, vertical or horizontal.

virtual bool16 ITableSuite::CanSwapCellStrokeFill ( void ) const

pure virtual

Returns kTrue if SwapCellStrokeFill() can be called, kFalse otherwise.

virtual bool16 ITableSuite::CanUnmergeCell ( void ) const

pure virtual

Returns kTrue if UnmergeCell() can be called, kFalse otherwise.

virtual void ITableSuite::ChangeBodyRowDimensionTo ( int32 newRowDim ) const

pure virtual

Increase or decrease the number of body rows in the selected table to match the specified dimension.

Parameters

newRowDim total number of body rows the table will have.

Precondition: CanChangeTableDimensions() == kTrue.

virtual void ITableSuite::ChangeColumnDimensionTo ( int32 newColDim ) const

pure virtual

Increase or decrease the number of columns in the selected table to match the specified dimension.

Parameters

newColDim total number of columns the table will have.

Precondition: CanChangeTableDimensions() == kTrue.

virtual void ITableSuite::ChangeFooterRowDimensionTo ( int32 newRowDim ) const

pure virtual

Increase or decrease the number of footer rows in the selected table to match the specified dimension.

Parameters

newRowDim total number of footer rows the table will have.

Precondition: CanChangeTableDimensions() == kTrue.

virtual void ITableSuite::ChangeHeaderRowDimensionTo ( int32 newRowDim ) const

pure virtual

Increase or decrease the number of header rows in the selected table to match the specified dimension.

Parameters

newRowDim total number of header rows the table will have.

Precondition: CanChangeTableDimensions() == kTrue.

virtual void ITableSuite::ChangeTableDirection ( Tables::EDirection NewDirection ) const

pure virtual

Change direction of table

Parameters

NewDirection the direction for the new table

virtual void ITableSuite::ClearAllTableOverrides ( AttributeBossList & attrs ) const

pure virtual

Clear the given table attribute overides for the selected table. Table attribute boss classes have one of the following prefixes in their name:

kTableAttr
kCellAttr
kRowAttr
kColAttr

Parameters

attrs list of table attributes to be cleared.

Precondition: CanClearAllTableOverrides() == kTrue.

virtual void ITableSuite::ClearColumnPatternFillOverrides	(	const AttributeBossList *	firstOverrideAttrs,
		const AttributeBossList *	secondOverrideAttrs,
		const int32	pattern1,
		const int32	pattern2,
		const int32	skipFirst,
		const int32	skipLast
	)

pure virtual

INTERNAL USE ONLY The following function clears the FILL overrides which intersect with alternating row or column FILL pattern Note: This function is called when using the table alternating pattern UI, there is no use otherwise

Parameters

firstOverrideAttrs	the overrides on the first set
secondOverrideAttrs	the overrides on the first set
pattern1	count in first set
pattern2	count in second set
skipFirst	number from top skipped
skipLast	number from bottom skipped

virtual void ITableSuite::ClearColumnPatternStrokeOverrides	(	const ICellStrokeAttrData::Data &	firstOverrideAttrs,
		const ICellStrokeAttrData::Data &	secondOverrideAttrs,
		const int32	pattern1,
		const int32	pattern2,
		const int32	skipFirst,
		const int32	skipLast
	)

pure virtual

INTERNAL USE ONLY The following function clears the STROKE overrides which intersect with alternating row or column STROKE pattern Note: This function is called when using the table alternating pattern UI, there is no use otherwise

Parameters

firstOverrideAttrs	the overrides on the first set
secondOverrideAttrs	the overrides on the first set
pattern1	count in first set
pattern2	count in second set
skipFirst	number from top skipped
skipLast	number from bottom skipped

virtual void ITableSuite::ClearOverridesIntersectingBorder	(	const AttributeBossList *	leftSideAttrs,
		const AttributeBossList *	topSideAttrs,
		const AttributeBossList *	rightSideAttrs,
		const AttributeBossList *	bottomSideAttrs
	)

pure virtual

Clears the overrides which intersect the table border The attributes to clear for each side

Note: This function is called when using the table border UI, there is no need to call it otherwise

virtual void ITableSuite::ClearRowPatternFillOverrides	(	const AttributeBossList *	firstOverrideAttrs,
		const AttributeBossList *	secondOverrideAttrs,
		const int32	pattern1,
		const int32	pattern2,
		const int32	skipFirst,
		const int32	skipLast
	)

pure virtual

INTERNAL USE ONLY The following function clears the FILL overrides which intersect with alternating row or column FILL pattern Note: This function is called when using the table alternating pattern UI, there is no use otherwise

Parameters

firstOverrideAttrs	the overrides on the first set
secondOverrideAttrs	the overrides on the first set
pattern1	count in first set
pattern2	count in second set
skipFirst	number from top skipped
skipLast	number from bottom skipped

virtual void ITableSuite::ClearRowPatternStrokeOverrides	(	const ICellStrokeAttrData::Data &	firstOverrideAttrs,
		const ICellStrokeAttrData::Data &	secondOverrideAttrs,
		const int32	pattern1,
		const int32	pattern2,
		const int32	skipFirst,
		const int32	skipLast
	)

pure virtual

INTERNAL USE ONLY The following function clears the STROKE overrides which intersect with alternating row or column STROKE pattern Note: This function is called when using the table alternating pattern UI, there is no use otherwise

Parameters

firstOverrideAttrs	the overrides on the first set
secondOverrideAttrs	the overrides on the first set
pattern1	count in first set
pattern2	count in second set
skipFirst	number from top skipped
skipLast	number from bottom skipped

virtual void ITableSuite::ClearSelectionOverrides	(	AttributeBossList &	attrs,
		ICellStrokeAttrData::Data &	data
	)		const

pure virtual

Clear the given table attribute overides for the selected cells.

Parameters

attrs	gives the table attributes to be cleared.
data	gives the cell stroke attributes to be cleared.

Precondition: CanClearSelectionOverrides() == kTrue.

virtual void ITableSuite::ConvertCellsType	(	CellType	destType,
		bool16	tryToPreserveData
	)

pure virtual

Method to convert the type of cells in sellection

Parameters

destType	cell type to be converted into
tryToPreserveData	if true, the data is preserved into the cell after converion, if possible.

virtual void ITableSuite::ConvertTableToText	(	const PMString	colSeparator = `"\t"`,
		const PMString	rowSeparator = `"\r"`
	)

pure virtual

Convert selected table to text.

Precondition: CanConvertTableToText() == kTrue.

virtual UIDRef ITableSuite::ConvertTextToTable	(	const PMString	colSeparator = `"\t"`,
		const PMString	rowSeparator = `"\r"`,
		const int32	userNumCols = `1`,
		const UID &	tableStyleUID = `kInvalidUID`
	)		const

pure virtual

Converts the current text selection to a table at the selection's location

Parameters

colSeparator	column separator to delimit end of column
rowSeparator	row separator to delimit end of row
userNumCols	number of columns specified by user, used if rowSeparator==colSeparator
tableStyleUID	[IN] optional, the table style for the new table, if this is `kInvalidUID`, the root table style is used

Returns: UIDRef the UIDRef of the table created

virtual UIDRef ITableSuite::ConvertTextToTable	(	const K2Vector< PMString > &	colSeparators,
		const K2Vector< PMString > &	rowSeparators,
		const int32	userNumCols = `1`,
		const UID &	tableStyleUID = `kInvalidUID`
	)		const

pure virtual

Same as above except parameters 1 and 2 are lists instead of single strings

Parameters

colSeparator	list of column separators to delimit end of column
rowSeparator	list of row separators to delimit end of row
userNumCols	number of columns specified by user, used if rowSeparator==colSeparator
tableStyleUID	[IN] optional, the table style for the new table, if this is `kInvalidUID`, the root table style is used

Returns: UIDRef the UIDRef of the table created

virtual void ITableSuite::ConvertToBodyRows ( void )

pure virtual

Converts the selection To Body Rows

virtual void ITableSuite::ConvertToFooterRows ( void )

pure virtual

Converts the selection To Footer Rows

virtual void ITableSuite::ConvertToHeaderRows ( void )

pure virtual

Converts the selection To Header Rows

virtual void ITableSuite::CreateTableStyleFromSelection ( void )

pure virtual

INTERNAL USE ONLY, UNTESTED!

virtual void ITableSuite::DeleteColumns ( void )

pure virtual

Delete selected columns.

Precondition: CanDeleteColumns() == kTrue.

virtual void ITableSuite::DeleteRows ( void )

pure virtual

Delete selected rows.

Precondition: CanDeleteRows() == kTrue.

virtual void ITableSuite::DeleteTable ( )

pure virtual

Delete selected table.

Precondition: CanDeleteTable() == kTrue.

virtual void ITableSuite::GetBorderOverridesInTable	(	const AttributeBossList *	findAttrs,
		OverrideStateVector *	results
	)		const

pure virtual

Collects the overrides in the table that intersect the table border Finds the attributes in findAttrs Returns in results

Parameters

findAttrs
results

virtual PMReal ITableSuite::GetCellHeight ( void ) const

pure virtual

Get visible height of cell, note if one cell is merged with another the overall height of both cells is returned.

Precondition: CanGetCellHeight() == kTrue

Returns: cell height.

See Also: GridAddress

virtual void ITableSuite::GetCellStrokes ( ICellStrokeAttrData::Data & data ) const

pure virtual

Get the value of the attributes indicated by data. Use of data allows the values of several attributes (stroke weight, color etc.) to be retrieved in a single call rather than individually.

Parameters

data	identifies the cell stroke attributes to be obtained on input and contains their values on return.

Precondition: CanGetCellStrokes()

virtual const IPMUnknown* ITableSuite::GetCellStrokesBySelection ( ) const

pure virtual

Acquire an interface pointer to the selection's cell stroke data. The IPMUnknown returned can be used to query an ICellStrokeAttrData interface that carries the cell stroke data.

Precondition: CanGetApplyCellStrokesBySelection() == kTrue.

Returns: IPMUnkown interface pointer to data boss object.

Postcondition: caller is responsible for releasing the returned interface pointer.

virtual PMReal ITableSuite::GetCellWidth ( void ) const

pure virtual

Get visible width of cell, for example if one cell is merged with another the overall width of both is returned.

Precondition: CanGetCellWidth() == kTrue

Returns: cell width.

See Also: GridAddress

virtual PMReal ITableSuite::GetColumnSize ( void ) const

pure virtual

Get width of columns in the underlying grid of the table.

Precondition: CanGetColumnSize() == kTrue

Returns: column width.

See Also: GridAddress

virtual GridArea ITableSuite::GetFocussedArea ( ) const

pure virtual

Returns the grid area of selected region inside table

Returns: GridArea

virtual PMReal ITableSuite::GetMaxRowSizeOfSelection ( ) const

pure virtual

Finds the row in the selection with the maximum row size

Returns: PMReal the maximum row size

virtual PMReal ITableSuite::GetMinRowSizeOfSelection ( ) const

pure virtual

Finds the row in the selection with the minumun row size

Returns: PMReal the minumun row size

virtual int32 ITableSuite::GetNumColsInTable ( void ) const

pure virtual

Returns the number of columns in the underlying grid of the selected table. For example if a table was created with 5 columns then two of the columns were merged together the user would see 4 columns but the number of columns in the underlying grid would still be 5.

Returns: the number of columns in the underlying grid of the selected table.

See Also: GridAddress

virtual int32 ITableSuite::GetNumFooterRowsInTable ( void ) const

pure virtual

Returns the number of footer rows in this table

Returns: int32 the number of footer rows in the table

virtual int32 ITableSuite::GetNumHeaderRowsInTable ( void ) const

pure virtual

Returns the number of header rows in this table

Returns: int32 the number of header rows in the table

virtual int32 ITableSuite::GetNumRowsInTable ( void ) const

pure virtual

Returns the number of rows in the underlying grid of the selected table. For example if a table was created with 5 rows then two of the rows were merged together the user would see 4 rows but the number of rows in the underlying grid would still be 5.

Returns: the number of rows in the underlying grid of the selected table.

See Also: GridAddress

virtual void ITableSuite::GetOverridesInTable	(	Tables::ERowColumn	patternType,
		int32	firstPatternCount,
		int32	secondPatternCount,
		int32	skipFirst,
		int32	skipLast,
		const AttributeBossList *	findAttrsFirst,
		const AttributeBossList *	findAttrsSecond,
		OverrideStateVector *	resultFirst,
		OverrideStateVector *	resultSecond
	)		const

pure virtual

INTERNAL USE ONLY Note: This function is called when using the table alternating pattern UI, there is no use otherwise Collects the overrides in the table based on the pattern passed in, findAttrsFirst and findAttrsSecond. findAttrsFirst maybe nil only if firstPatterCount = 0 findAttrsSecond maybe nil only if secondPatternCount = 0

For each attribute in the findAttrs (first or second) that is overriden, an entry is made in the corresponding result OverrideStateVector. If the value of all override is the same as that of the attribute in the findAttrs then the OverrideState entry.valueSameAsFind is set to kTrue. A value of kFalse indicates the presence of override(s) but the value being different from that in findAttrs. If no entry is made in resultFirst || resultSecond for the corresponding attribute then there are no overrides.

Parameters

patternType	column or row
firstPatternCount	count in first set
secondPatternCount	count in second set
skipFirst	number from top skipped
skipLast	number from bottom skipped
findAttrsFirst	IN attributes in first set to look for
findAttrsSecond	IN attributes in first set to look for
resultFirst	OUT the overrides on the first set
resultSecond	OUT the overrides on the second set

Postcondition: delete resultFirst and resultSecond before they go out of scope.

virtual PMReal ITableSuite::GetRowSize ( void ) const

pure virtual

Get height of rows in the underlying grid of the table.

Precondition: CanGetRowSize() == kTrue.

Returns: row height.

See Also: GridAddress

virtual void ITableSuite::GetStrokeOverridesInTable	(	Tables::ERowColumn	patternType,
		int32	firstPatternCount,
		int32	secondPatternCount,
		int32	skipFirst,
		int32	skipLast,
		const ICellStrokeAttrData::Data &	firstData,
		const ICellStrokeAttrData::Data &	secontData,
		ICellStrokeAttrData::Data &	resultFirst,
		ICellStrokeAttrData::Data &	resultSecond
	)		const

pure virtual

INTERNAL USE ONLY Collects the overrides in the table based on the pattern passed in, findAttrsFirst and findAttrsSecond. findAttrsFirst maybe nil only if firstPatterCount = 0 findAttrsSecond maybe nil only if secondPatternCount = 0

For each attribute in the findAttrs (first or second) that is overriden, an entry is made in the corresponding result ICellStrokeAttrData::Data. If the value of all override is the same as that of the attribute in the findAttrs then the ICellStrokeAttrData::Data entry is set. No value indicates the presence of override(s) but the value being different from that in findAttrs. If no entry is made in resultFirst || resultSecond for the corresponding attribute then there are no overrides.

Parameters

patternType	column or row
firstPatternCount	count in first set
secondPatternCount	count in second set
skipFirst	number from top skipped
skipLast	number from bottom skipped
findAttrsFirst	IN attributes in first set to look for
findAttrsSecond	IN attributes in first set to look for
resultFirst	OUT the overrides on the first set
resultSecond	OUT the overrides on the second set

Postcondition: delete resultFirst and resultSecond before they go out of scope.

virtual Tables::EDirection ITableSuite::GetTableDirection ( void ) const

pure virtual

Get direction of table

Returns: EDirection the direction of the table

virtual K2Vector<ITextFrameColumn*>* ITableSuite::GetTextFramesSpannedBySelection ( ) const

pure virtual

Returns a collection of ITextFrameColumn interface pointers to each text frame touched by the selection.

Returns: a collection of ITextFrameColumn interface pointers to each text frame touched by the selection.

Postcondition: delete the returned K2Vector pointer before it goes out of scope.

virtual int32 ITableSuite::GetUserCurrentColNumber ( void ) const

pure virtual

Returns the number the column in which the selection lies as seen by the user. For example if two columns are merged together they are seen as one column to the user.

Returns: the current column as seen by the user (1 >= result <= GetUserNumColsInTable()).

See Also: GridAddress

virtual UserRowNumber ITableSuite::GetUserCurrentRowNumber ( void ) const

pure virtual

Returns the number of the row in which the selection lies as seen by the user. For example if two rows are merged together they are seen as one row by the user.

Returns: the current row as seen by the user (1 >= result <= GetUserNumRowsInTable()).

See Also: GridAddress

virtual int32 ITableSuite::GetUserNumColsInTable ( void ) const

pure virtual

Returns the number of columns in the selected table as seen by the user. If two columns are merged together they count as one column to the user.

Returns: the number of columns in the selected table as seen by the user.

See Also: GridAddress

virtual int32 ITableSuite::GetUserNumRowsInTable ( void ) const

pure virtual

Returns the number of rows in the selected table as seen by the user. If two rows are merged together they count as one row to the user.

Returns: the number of rows in the selected table as seen by the user.

See Also: GridAddress

virtual void ITableSuite::InsertColumns	(	int32	howMany,
		Tables::ERelativePosition	pos,
		const PMReal &	colWidth,
		Tables::EContinuation	continuation = `Tables::eStructureAllAttrs`
	)

pure virtual

Insert columns before or after the columns in the selection. Width is in points. If colWidth is zero then the new width is determined from the column relative to which the insertion is being made. A non zero colWidth value will result in all inserted columns having that width.

Parameters

howMany	number of columns to insert.
pos	before or after the columns in the selection.
colWidth	width of columns or zero to determine automatically.
continuation

Precondition: CanInsertColumns() == kTrue.

virtual void ITableSuite::InsertRows	(	int32	howMany,
		Tables::ERelativePosition	pos,
		const PMReal &	rowHeight,
		Tables::EContinuation	continuation = `Tables::eStructureAllAttrs`
	)

pure virtual

Insert rows before or after the rows in the selection. The rowHeight is in points. If rowHeight is zero then the row height is determined by the auto-grow and minimum row height attribute of the row relative to which the insertion is being made. A non zero rowHeight value will result in all inserted rows having that minimum height.

Parameters

howMany	number of rows to insert.
pos	before or after the rows in the selection.
continuation
rowHeight	height of rows in points or zero to determine automatically.

Precondition: CanInsertRows() == kTrue.

virtual void ITableSuite::InsertTable	(	const int32	numRows,
		const int32	numCols,
		const int32	headerRows,
		const int32	footerRows,
		const UID &	tableStyleUID = `kInvalidUID`,
		const Tables::EDirection	direction = `Tables::eLTR`
	)

pure virtual

Inserts a new table at the current text selection location

Parameters

numRows	number of rows
numCols	number of columns
headerRows	number of header rows
footerRows	number of footer rows
[IN]	tableStyleUID optional, the table style for the new table, if this is not provided, the default table style is used
direction	the direction for the new table

virtual bool16 ITableSuite::IsAnyGraphicCellSelected ( ) const

pure virtual

Returns kTrue if there is any graphic cell in the grid area of selected region, kFalse otherwise

Returns: bool16 Returns kTrue if there is any graphic cell in the grid area of selected region

virtual bool16 ITableSuite::IsAnyTextCellSelected ( ) const

pure virtual

Returns kTrue if there is any text cell in the grid area of selected region, kFalse otherwise

Returns: bool16 Returns kTrue if there is any text cell in the grid area of selected region

virtual bool16 ITableSuite::IsFooterSelection ( ) const

pure virtual

Returns true if this selection is in the footer set Note: Will return false if the selection spans all three sets (ie is a whole table selection)

virtual bool16 ITableSuite::IsHeaderSelection ( ) const

pure virtual

Returns true if this selection is in the header set Note: Will return false if the selection spans all three sets (ie is a whole table selection)

virtual bool16 ITableSuite::isWholeTableSelected ( ) const

pure virtual

Returns true if this selection is the whole table Note: IsHeaderSelection and IsFooterSelection will return false if this is true

virtual bool16 ITableSuite::IsWritingDirectionHorizontal ( void ) const

pure virtual

Returns kTrue if the Writing direction of the story the table is in is horizontal

virtual void ITableSuite::MergeCells ( void )

pure virtual

Merge selected cells.

Precondition: CanMergeCells() == kTrue.

virtual void ITableSuite::MoveColumns	(	ITableModel *	sourceTable,
		GridArea	fromArea,
		int32	toColumn,
		Tables::ERelativePosition	pos,
		bool16	duplicateFlag
	)

pure virtual

Method to move column(s) in a table

Parameters

sourceTable	specifies the table within which columns are to be moved
fromArea	specifies the grid area which is to be moved
toColumn	specifies the column where the selected columns are to be moved
pos	specifies the relative position with respect to toColumn
duplicateFlag	specifies whether columns need to be duplicated or not

virtual void ITableSuite::MoveRows	(	ITableModel *	sourceTable,
		GridArea	fromArea,
		int32	toRow,
		Tables::ERelativePosition	,
		bool16	duplicateFlag
	)

pure virtual

Method to move row(s) in a table

Parameters

sourceTable	specifies the table within which rows are to be moved
fromArea	specifies the grid area which is to be moved
toRow	specifies the row where the selected rows are to be moved
pos	specifies the relative position with respect to toRow
duplicateFlag	specifies whether rows need to be duplicated or not

virtual void ITableSuite::PastePageItem	(	const GridAddress &	anchor,
		UIDRef	pageItemUID,
		bool16	preventCopy
	)

pure virtual

Method to paste a page item into a graphic cell. Call CanPastePageItem before this operation

Parameters

anchor	GridAddress of destination cell
pageItemUID	UID of object to be pasted into the cell
preventCopy	The object would not be copied, just removed from the source and pasted here. This is not cut-paste. It should be used, only if object is already in the scrap database.

virtual const IPMUnknown* ITableSuite::QueryCellAttribute ( ClassID whichAttr ) const

pure virtual

Acquire the IPMUnknown interface pointer of the given cell attribute for the selection. Using this pointer a data interface can be queried on the boss object to find the attribute value.

Parameters

whichAttr identifies the table attribute boss class wanted, kCellAttrBottomInsetBoss for example.

Returns: IPMUnknown interface pointer of the given cell attribute for the selection.

Precondition: CanGetCellAttribute() == kTrue.

Postcondition: caller is responsible for releasing the returned interface pointer.

virtual const IPMUnknown* ITableSuite::QueryColAttribute ( ClassID whichAttr ) const

pure virtual

Acquire an IPMUnkown interface pointer for whichAttr.

Parameters

whichAttr identifies the attribute wanted, kColAttrWidthBoss for example.

Precondition: self.CanGetColAttribute(whichAttr) == kTrue.

Returns: IPMUnkown interface pointer for whichAttr.

Postcondition: caller is responsible for releasing the returned interface pointer.

virtual const IPMUnknown* ITableSuite::QueryRowAttribute ( ClassID whichAttr ) const

pure virtual

Acquire an IPMUnkown interface pointer for whichAttr.

Parameters

whichAttr identifies the attribute wanted, kRowAttrHeightBoss for example.

Precondition: self.CanGetRowAttribute(whichAttr) == kTrue.

Returns: IPMUnkown interface pointer for whichAttr.

Postcondition: caller is responsible for releasing the returned interface pointer.

virtual const IPMUnknown* ITableSuite::QueryTableAttribute ( ClassID whichAttr ) const

pure virtual

Acquire the IPMUnknown interface pointer of the given table attribute for the selection. Other interfaces that exist on the boss object can be queried from this.

Parameters

whichAttr identifies the table attribute boss class wanted, kTableAttrColStrokeWeightBoss for example.

Returns: IPMUnknown interface pointer of the given table attribute for the selection.

Postcondition: caller is responsible for releasing the returned interface pointer.

virtual void ITableSuite::RedistributeColumns ( void )

pure virtual

Redistribute the width of columns across the space between the left of the first selected column and the right of the last selected column to give evenly sized columns.

Precondition: CanRedistributeColumns() == kTrue.

virtual void ITableSuite::RedistributeRows ( void )

pure virtual

Redistribute the height of rows across the space between the top of the first selected row and the bottom of the last selected row to give evenly sized rows.

Precondition: CanRedistributeRows() == kTrue.

virtual void ITableSuite::ResizeCellHeight ( const PMReal & height )

pure virtual

Change the height of selected cells.

Parameters

height.

Precondition: CanResizeCellHeight() == kTrue.

virtual void ITableSuite::ResizeCellWidth ( const PMReal & width )

pure virtual

Change the width of selected cells.

Parameters

width.

Precondition: CanResizeCellWidth() == kTrue.

virtual void ITableSuite::ResizeColumns ( const PMReal & width )

pure virtual

Change the width of columns in the underlying grid of the table.

Parameters

width.

Precondition: CanResizeColumns() == kTrue.

See Also: GridAddress

virtual void ITableSuite::ResizeRows ( const PMReal & height )

pure virtual

Change the height of rows in the underlying grid of the table.

Parameters

height.

Precondition: CanResizeRows() == kTrue.

See Also: GridAddress

virtual void ITableSuite::SplitCells ( ESplitDirection direction )

pure virtual

This method is obsolete. Please use SplitCells(). Split selected cell in the given direction.

Parameters

direction of split, vertical or horizontal.

Precondition: CanSplitCell(direction) == kTrue. Split selected cells in the given direction.

Parameters

direction of split, vertical or horizontal.

Precondition: CanSplitCells(direction) == kTrue.

virtual void ITableSuite::SwapCellStrokeFill ( void )

pure virtual

Swap the stroke and fill rendering attibutes for the selected cells.

Precondition: CanSwapCellStrokeFill() == kTrue.

virtual bool16 ITableSuite::TableContainsFooters ( void ) const

pure virtual

Returns true if table which the selection is in has any Footer rows.

Returns: bool16 true if the table contains footers

virtual bool16 ITableSuite::TableContainsHeaders ( void ) const

pure virtual

Returns true if table which the selection is in has any Header rows.

Returns: bool16 true if the table contains headers

virtual void ITableSuite::UnmergeCell ( void )

pure virtual

Unmerge selected cell.

Precondition: CanUnmergeCell() == kTrue.

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation