#include <ITableSelectionSuite.h>

Inheritance diagram for ITableSelectionSuite:

Public Types
enum	{ kDefaultIID = IID_ITABLESELECTION_SUITE }

enum	SelectAction { kReplace, kAddTo, kExtend }

Public Member Functions
virtual void	Select (const ITableModel *table, const GridArea &cells, const SelectAction selectionAction, const bool16 autoScroll)=0

virtual void	Select (IPMUnknown *targetingBoss, const SelectAction selectionAction, const bool16 autoScroll)=0

virtual void	SelectAll (void)=0

virtual void	SelectAll (const ITableModel *model)=0

virtual void	DeselectAll (void)=0

virtual void	SelectRows (const int32 startRowNum, const int32 rowsToSelect, const ITableModel *model, const bool16 useTopRowAsAnchor, const bool16 autoScroll)=0

virtual void	SelectRows (const int32 startRowNum, const int32 rowsToSelect, const bool16 useTopRowAsAnchor, const bool16 autoScroll)=0

virtual void	SelectColumns (const int32 startColNum, const int32 colsToSelect, const ITableModel *model, const bool16 useLeftColumnAsAnchor, const bool16 autoScroll)=0

virtual void	SelectColumns (const int32 startColNum, const int32 colsToSelect, const bool16 useLeftColumnAsAnchor, const bool16 autoScroll)=0

virtual void	SelectBodyColumns (const int32 startColNum, const int32 colsToSelect, const ITableModel *model, const bool16 useLeftColumnAsAnchor, const bool16 autoScroll)=0

virtual void	SelectAllBodyRows (const ITableModel *tableModel, const bool16 autoScroll=kTrue)=0

virtual void	SelectAllHeaderRows (const ITableModel *tableModel, const bool16 autoScroll=kTrue)=0

virtual void	SelectAllFooterRows (const ITableModel *tableModel, const bool16 autoScroll=kTrue)=0

virtual void	SetSavedIndex (TextIndex index)=0

virtual GridArea	GetSelection () const =0

virtual GridSpan	GetTableSpan () const =0

virtual TextIndex	GetSavedIndex () const =0

virtual GridAddress	GetAnchor () const =0

virtual GridArea	GetNewTableSelection (const ITableModel *tableModel, const GridArea newSelection, const GridAddress anchorAddr, const SelectAction selectionAction=kReplace)=0

virtual void	ScrollViewToSelection (const ITableModel *model, const GridArea newSelection)=0

virtual void	ScrollViewToSelection (const GridArea newSelection)=0

virtual void	CenterViewToSelection ()=0

virtual bool16	CanShiftExtendSelection (const ITableModel *trackerFramesTableModel) const =0

virtual ITableModel *	QuerySelectedTableModel (void) 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

Interface to manipulate the table selection.

Member Enumeration Documentation

enum ITableSelectionSuite::SelectAction

kReplace recents the anchor pt to the top left of the new area and sets the selection to the new area.

kAddTo gives the behavior that the anchorPt is the center of the selection and all selections are made around it.

kExtend ignores the anchor pt and adds to the selection – sets the anchor pt to the top left or the extended selection.

Member Function Documentation

virtual bool16 ITableSelectionSuite::CanShiftExtendSelection ( const ITableModel * trackerFramesTableModel ) const

pure virtual

USED ONLY BY THE TRACKER CODE Figures out if we are in the same table mode and can there for extend the selection

virtual void ITableSelectionSuite::CenterViewToSelection ( )

pure virtual

Sets the current selection to be in the centre of view.

For instance a sequence of method calls on this interface to GetSelection() and ScrollViewToSelection() with resulting GridArea would have same net effect as this method.

virtual void ITableSelectionSuite::DeselectAll ( void )

pure virtual

Method to unselect entire table targeted by selection

virtual GridAddress ITableSelectionSuite::GetAnchor ( ) const

pure virtual

Accessor for the top-left of the area selected.

Returns: the location represented by a GridAddress

virtual GridArea ITableSelectionSuite::GetNewTableSelection	(	const ITableModel *	tableModel,
		const GridArea	newSelection,
		const GridAddress	anchorAddr,
		const SelectAction	selectionAction = `kReplace`
	)

pure virtual

Determine what the new table selection would be if you selected given the passed in criteria. NOTE: this doesn't change any state, if you are calling it you have to know that kExtend and kReplace change the anchor to the top left of the selection returned

Parameters

tableModel	model of selection
newSelection	the new selection
anchorAddr	anchor of the selection
selectionAction	what selection action are we doing
GridArea	the new selection

virtual TextIndex ITableSelectionSuite::GetSavedIndex ( ) const

pure virtual

Accessor for the saved TextIndex.

Returns: the saved index

virtual GridArea ITableSelectionSuite::GetSelection ( ) const

pure virtual

Accessor for the area selected in table that is target of the selection.

For instance, there is a text selection in the table, would expect this to be area to span one cell for InDesign 2.0. If there are cells selected, this can span more than one cell.

Returns: return the dimension of the area selected in the table targeted by the selection

virtual GridSpan ITableSelectionSuite::GetTableSpan ( ) const

pure virtual

Accessor for the extent of table selected. If none selected GridSpan(0, 0) would be returned.

Returns: a GridSpan object representing the span of table selected.

virtual ITableModel* ITableSelectionSuite::QuerySelectedTableModel ( void ) const

pure virtual

USED ONLY BY THE TABLES CODE return the table model of current selection

virtual void ITableSelectionSuite::ScrollViewToSelection	(	const ITableModel *	model,
		const GridArea	newSelection
	)

pure virtual

Scrolls the view to the given selection. Passes in a table model so that you can scroll the view even if the selection is not set like in the case of tracking.

Parameters

model	specifies table to work with
newSelection	specifies an area within this table to scroll into view

Precondition: model not nil; newSelection not kZeroGridArea

virtual void ITableSelectionSuite::ScrollViewToSelection ( const GridArea newSelection )

pure virtual

Same as above, but it doesn't take an ITableModel This is the first step to deprecating the above function

Parameters

newSelection specifies an area within this table to scroll into view

virtual void ITableSelectionSuite::Select	(	const ITableModel *	table,
		const GridArea &	cells,
		const SelectAction	selectionAction,
		const bool16	autoScroll
	)

pure virtual

Sets the table selection according to the selection action and the scrolls the view

Parameters

tableModel	model of selection
cells	the new selection
selectionAction	what selection action are we doing
autoScroll	scroll selection

virtual void ITableSelectionSuite::Select	(	IPMUnknown *	targetingBoss,
		const SelectAction	selectionAction,
		const bool16	autoScroll
	)

pure virtual

Sets the table selection according to the selection action and the scrolls the view

virtual void ITableSelectionSuite::SelectAll ( void )

pure virtual

Method to select an entire table.

virtual void ITableSelectionSuite::SelectAll ( const ITableModel * model )

pure virtual

Method to select an entire table.

Precondition: table model is not nil

Parameters

model table model

virtual void ITableSelectionSuite::SelectAllBodyRows	(	const ITableModel *	tableModel,
		const bool16	autoScroll = `kTrue`
	)

pure virtual

Selects all of the body rows in the table

Parameters

tableModel	model of selection
autoScroll	scroll selection

virtual void ITableSelectionSuite::SelectAllFooterRows	(	const ITableModel *	tableModel,
		const bool16	autoScroll = `kTrue`
	)

pure virtual

Selects all of the footer rows in the table

Parameters

tableModel	model of selection
autoScroll	scroll selection

virtual void ITableSelectionSuite::SelectAllHeaderRows	(	const ITableModel *	tableModel,
		const bool16	autoScroll = `kTrue`
	)

pure virtual

Selects all of the header rows in the table

Parameters

tableModel	model of selection
autoScroll	scroll selection

virtual void ITableSelectionSuite::SelectBodyColumns	(	const int32	startColNum,
		const int32	colsToSelect,
		const ITableModel *	model,
		const bool16	useLeftColumnAsAnchor,
		const bool16	autoScroll
	)

pure virtual

Selects all the cells which intersect with the given column and the body area of the table

Parameters

startColNum	the first column in selection
colsToSelect	the number of columns in the selection
model	the model of the selection
useLeftColumnAsAnchor	use the left most column as the anchor
autoScroll	scroll to selection

virtual void ITableSelectionSuite::SelectColumns	(	const int32	startColNum,
		const int32	colsToSelect,
		const ITableModel *	model,
		const bool16	useLeftColumnAsAnchor,
		const bool16	autoScroll
	)

pure virtual

Sets a new selection at the given column. Shrinks the selection so it is equal to how it appears to the user.

For example if the last row is merged and the second column is selected it will shrink the selection to not include the last cell in that column.

Precondition: table model is not nil; the column range specified by the ColRange(startColNum,colssToSelect) is valid, i.e. within table

Parameters

startColNum	begin selection from this column
colsToSelect	count of columns to select
model	refers to table model in which to select (One version of this function tables a model and the other uses the existing on in the selection)
useLeftColumnAsAnchor	when kTrue sets the anchor to the top cell in the left column, and when false sets the anchor to the top cell in the right column
autoScroll	kTrue if view should scroll

virtual void ITableSelectionSuite::SelectColumns	(	const int32	startColNum,
		const int32	colsToSelect,
		const bool16	useLeftColumnAsAnchor,
		const bool16	autoScroll
	)

pure virtual

Differs from the above function because this one doesn't take a model as a parameter and it uses the exisiting on in the selection

See Also: SelectColumns

virtual void ITableSelectionSuite::SelectRows	(	const int32	startRowNum,
		const int32	rowsToSelect,
		const ITableModel *	model,
		const bool16	useTopRowAsAnchor,
		const bool16	autoScroll
	)

pure virtual

Sets a new selection at the given row. Shrinks the selection so it is equal to how it appears to the user.

Precondition: table model is not nil; the row range specified by the RowRange(startRowNum,rowsToSelect) is valid, i.e. within table

Parameters

startRowNum	begin selection from this row
rowsToSelect	specifies count of rows to select
model	refers to table model in which to select (One version of this function tables a model and the other uses the existing on in the selection)
useTopRowAsAnchor	when kTrue sets the anchor to the left cell in the top row, and when false sets the anchor to the left cell in the bottom row
autoScroll	kTrue if view should scroll

virtual void ITableSelectionSuite::SelectRows	(	const int32	startRowNum,
		const int32	rowsToSelect,
		const bool16	useTopRowAsAnchor,
		const bool16	autoScroll
	)

pure virtual

Differs from the above function because this one doesn't take a model as a parameter and it uses the exisiting on in the selection

See Also: SelectRows

virtual void ITableSelectionSuite::SetSavedIndex ( TextIndex index )

pure virtual

Used when moving around in the table

Parameters

index specifies text index to cache

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation