InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITableNavigatorSuite Class Referenceabstract
Inheritance diagram for ITableNavigatorSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITABLENAVIGATOR_SUITE }
 
enum  Direction {
  kInvalidDirection, kNext, kPrev, kUp,
  kDown, kLeft, kRight, kStartCol,
  kEndCol, kFirstFrameRow, kLastFrameRow, kStartRow,
  kEndRow
}
 

Public Member Functions

virtual void MoveSelection (Direction direction, ITableSelectionSuite::SelectAction selectionAction)=0
 
virtual Direction GetLastDirection ()=0
 
virtual void SetLastDirection (Direction direction)=0
 
virtual GridAddress GetAnchor () const =0
 
virtual void SetAnchor (const GridAddress anchor)=0
 
virtual TextIndex GetAnchorTextIndex () const =0
 
virtual void SetAnchorTextIndex (const TextIndex anchorIndex)=0
 
virtual Direction GetInitalDirection () const =0
 
virtual void SetInitalDirection (Direction direction)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Enumeration Documentation

Used for navigating around the table

Member Function Documentation

virtual GridAddress ITableNavigatorSuite::GetAnchor () const
pure virtual

Get/Set the anchor of the selection, this is used when navigating to determine where to go next

virtual TextIndex ITableNavigatorSuite::GetAnchorTextIndex () const
pure virtual

Get/Set the anchor text index of the selection, this is used when navigating with a text selection around a cell to determine where to go next.

virtual Direction ITableNavigatorSuite::GetInitalDirection () const
pure virtual

Get/Set the direction we were moving when the anchor was set NOTE: direction is Reset when we set the anchor cell

virtual Direction ITableNavigatorSuite::GetLastDirection ()
pure virtual

Get/Set the last direction in the table we moved in. NOTE: direction is Reset on selection changed

virtual void ITableNavigatorSuite::MoveSelection (Direction direction,
ITableSelectionSuite::SelectAction selectionAction 
)
pure virtual

Determine what the new table selection would be if you selected given the passed in criteria. NOTE: This can only be called if there is an existing selection NOTE: this doesn't change any state

Parameters
Direction
SelectAction