ITableSelectionSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Joe Shankar
// 
// $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 __ITableSelectionSuite__
#define __ITableSelectionSuite__

#include "ITableTarget.h"
#include "TablesUIID.h"
#include "TableTypes.h"

class ITableModel;


class ITableSelectionSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITABLESELECTION_SUITE }; 
 enum SelectAction { kReplace, kAddTo, kExtend };

//----- Setters -----
 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;

//----- Getters -----
 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;

 
//----- Scrolling -----
 virtual void ScrollViewToSelection(const ITableModel *model, const GridArea newSelection) = 0;

 virtual void ScrollViewToSelection(const GridArea newSelection) = 0;

 virtual void CenterViewToSelection() = 0;

//------ For Internal Use ONLY --------

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

 virtual ITableModel* QuerySelectedTableModel(void) const = 0;
};


#endif //__ITableSelectionSuite__