ITableNavigatorSuite.h

//========================================================================================
// 
// $File:$
// 
// Owner: Danielle Bessette
// 
// $Author:$
// 
// $DateTime:$
// 
// $Revision:$
// 
// $Change:$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ITableNavigatorSuite__
#define __ITableNavigatorSuite__

#include "IPMUnknown.h"
#include "IPMUnknown.h"
#include "TablesUIID.h"
#include "TableTypes.h"
#include "ITableSelectionSuite.h"

class ITableModel;

class ITableNavigatorSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITABLENAVIGATOR_SUITE }; 

 enum Direction { kInvalidDirection, kNext, kPrev, kUp, kDown, kLeft, kRight, kStartCol, kEndCol, kFirstFrameRow, kLastFrameRow, kStartRow, kEndRow };
 
 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;
};


#endif