ITableCommands.h

//========================================================================================
// 
// $File$
// 
// Owner: Mat Marcus
// 
// $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 __ITableCommands__
#define __ITableCommands__

#include "TablesID.h"
#include "TableTypes.h"
#include "ICellStrokeAttrData.h"
#include "ITableModel.h"

class AttributeBossList;
class TableMementoPiece; // $$$ should not be in the API
class WideString;
class ICommand;

class ITableCommands : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITABLECOMMANDS };




 virtual ErrorCode InsertRows(const RowRange& rows, const Tables::ERelativePosition pos, const PMReal& height, const Tables::EContinuation continuation = Tables::eStructureAllAttrs) = 0;

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

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

 virtual ErrorCode InsertColumns(const ColRange& cols, const Tables::ERelativePosition pos, const PMReal& width, const Tables::EContinuation continuation = Tables::eStructureAllAttrs) = 0;
 
 virtual ErrorCode DeleteRows (const RowRange& rows) = 0;

 virtual ErrorCode DeleteRowsButNotAnchors(const RowRange& rows) = 0;

 virtual ErrorCode DeleteColumns(const ColRange& cols) = 0;

 virtual ErrorCode MergeCells (const GridArea& cells) = 0;

 virtual ErrorCode UnmergeCell (const GridAddress& anchor) = 0;

// virtual ErrorCode SplitCell(const GridAddress& anchor, const ITableModel::ESplitDirection splitDirection) = 0;

 virtual ErrorCode SplitCells (const GridArea& cells, const ITableModel::ESplitDirection splitDirection) = 0;

 /* Method to change table direction from LeftToRight to RightToLeft
 @param directionRTL direction to change to
 @return kSuccess command executed successfully
 */
 virtual ErrorCode ChangeTableDirection(Tables::EDirection directionRTL) = 0;

 


 virtual ErrorCode ResizeRows (const RowRange& rows, const PMReal& newHeight) = 0;

 virtual ErrorCode ResizeCols (const ColRange& cols, const PMReal& newWidth) = 0;

 virtual ErrorCode ApplyRowOverrides(const RowRange& rows, const AttributeBossList* attrs) = 0;

 virtual ErrorCode ApplyColOverrides(const ColRange& cols, const AttributeBossList* attrs) = 0; 

 virtual ErrorCode ApplyCellStrokes(const GridArea& area, const ICellStrokeAttrData::Data& data) = 0;

 virtual ErrorCode ClearCellStrokes(const GridArea& area, const ICellStrokeAttrData::Data& data) = 0;
 
 virtual ErrorCode ClearCellStrokesUISafe(const GridArea& area, const ICellStrokeAttrData::Data& data) = 0;

 virtual ErrorCode SwapCellStrokeFill(const GridArea& cells) = 0;

 virtual ErrorCode ApplyCellOverrides(const GridArea& cells, const AttributeBossList* attrs) = 0;
 
 virtual ErrorCode ClearCellOverrides(const GridArea& cells, const AttributeBossList* attrs) = 0;
 
 virtual ErrorCode ApplyTableOverrides(const AttributeBossList* attrs) = 0;
 
 virtual ErrorCode SetTableStyle(const UIDRef& styleRef) = 0;

 virtual ErrorCode ClearBorderOverrides(Tables::ECellEdge edge, const AttributeBossList* attrs) = 0;

 virtual ErrorCode ClearCellOverridesUISafe(const GridArea& cells, const AttributeBossList* attrs) = 0;


 // Attributes -- returns a command to be processed


 virtual ICommand* QueryApplyCellStrokesCmd(const GridArea& area, const ICellStrokeAttrData::Data& data) = 0;
 virtual ICommand* QueryClearCellStrokesCmd(const GridArea& area, const ICellStrokeAttrData::Data& data) = 0;
 virtual ICommand* QueryClearCellStrokesUISafeCmd(const GridArea& area, const ICellStrokeAttrData::Data& data) = 0;
 virtual ICommand* QueryApplyCellOverridesCmd(const GridArea& cells, const AttributeBossList* attrs) = 0; 



 virtual ErrorCode SetCellText(const WideString& cellText, const GridAddress& anchor) = 0; 
 
 virtual ErrorCode ClearContent(const GridArea& cells) = 0;




 virtual ErrorCode RegisterStrand(const UIDRef& strandRef) = 0;

 virtual ErrorCode RegisterContentMgr(CellType contentMgrType, const UIDRef& contenMgr) = 0;

 


 virtual ErrorCode CreateRowSegment(const PMReal& distanceFromEdge, const ColRange& segmentRange) = 0;
 
 virtual ErrorCode CreateColSegment(const PMReal& distanceFromEdge, const RowRange& segmentRange) = 0; 
 



 virtual ErrorCode ConvertToHeaderRows(const RowRange& rows) = 0;

 virtual ErrorCode ConvertToFooterRows(const RowRange& rows) = 0;

 virtual ErrorCode ConvertToBodyRows(const RowRange& rows) = 0;
 




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

 virtual ICommand* QueryDeleteTableCmd(const UIDRef& tableRef) = 0;

 virtual ErrorCode ConvertCellsType(const GridArea& cells, CellType destType, bool16 tryToPreserveData = kFalse) = 0;

 virtual ErrorCode PastePageItem(const GridAddress &anchor, UIDRef pageItemUID, bool16 preventCopy = kFalse) = 0;
};

#endif // __ITableCommands__