ITableUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Jesse Jones (jejones)
// 
// $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.
// 
// 
// Purpose: Table related utility functions.
// 
//========================================================================================

#ifndef __ITABLEUTILS__
#define __ITABLEUTILS__

#include "IPMUnknown.h"
#include "TablesID.h"
#include "UIDRef.h"
#include "ScriptData.h"
#include "TableTypes.h"
#include "PMTextUtils.h"
#include "K2Vector.h"
#include "PMPoint.h"
#include "TextChar.h"

//-----------------------------------
// Forward References
//
class ITableFrame;
class ITableModel;
class ITextModel;
class ITableTarget;
class PMReal;
class ITextStoryThreadDict;
class ICellContent;
class IPlaceBehavior;


// ===================================================================================
// class ITableUtils
// ===================================================================================
class ITableUtils : public IPMUnknown {

//-----------------------------------
// API
//
public:
 // ----- Constants -----
 enum {kDefaultIID = IID_ITABLEUTILS};

 class CellChunk
 {
 public:
 typedef base_type data_type;

 CellChunk(GridArea chunk, UIDRef tableFrame) : chunkArea(chunk), tableFrameContainingChunck(tableFrame) {}
 GridArea chunkArea;
 UIDRef tableFrameContainingChunck;
 };

 // ----- Table Creation -----
 virtual UIDRef ConvertTextToTable(ITextModel* textModel, const Text::StoryRange& textRange, const PMString colSeparator="\t", const PMString rowSeparator="\r", const int32 userNumCols=1, const UID& tableStyleUID = kInvalidUID) const = 0;
 virtual UIDRef ConvertTextToTable(ITextModel* textModel, const Text::StoryRange& textRange, const K2Vector<PMString>& colSeparators, 
 const K2Vector<PMString>& rowSeparators, const int32 userNumCols=1,
 const UID& tableStyleUID = kInvalidUID) const = 0;
 // $$$ Use a specifier here: should not require a selection.
 // $$$ This is probably true for most of these functions.

 enum ESetTextSelection { eNoSelection, eSetSelectionInFirstCell };

 virtual void InsertTable(ITextModel* textModel,
 TextIndex index, int32 len,
 int32 numRows, int32 numCols,
 const PMReal& rowHeight,
 const PMReal& colWidth,
 CellType cellType,
 const ESetTextSelection setSelection,
 const UID& tableStyle = kInvalidUID) const = 0;

 virtual void InsertTable(ITextModel* textModel,
 TextIndex index, int32 len,
 int32 numRows, int32 numCols,
 int32 numHeaderRows, int32 numFooterRows,
 const PMReal& rowHeight,
 const PMReal& colWidth,
 CellType cellType,
 const ESetTextSelection setSelection,
 const UID& tableStyle = kInvalidUID,
 Tables::EDirection direction = Tables::eLTR) const = 0;

 // ----- Misc -----
 virtual UIDRef GetTableModel(ITextModel* text, TextIndex index) const = 0;

 virtual UID GetRootTableStyle(IDataBase* db) const = 0;

 virtual K2Vector<CellChunk> * GetCellChunks(const GridArea selection, const ITableModel* tableModel) const = 0;

 // ----- Misc shared by UI and scripting -----
 virtual void CalculateDefaultCellBounds(const ITextModel* textModel,
 TextIndex insertLocation,
 int32 numRows, int32 numCols,
 PMReal& rowHeight, PMReal& colWidth) const = 0;

 // ----- Misc shared by UI and Model -----
 virtual Tables::ESelectionSides CalculateSides(const ITableTarget* tableTarget) const = 0;

 // ----- Scripting -----
 virtual ErrorCode CreateCellScriptObject( const RequestContext& context, const GridArea& area, const ITableModel* tableModel, ScriptList* objectList ) = 0 ;
 virtual ErrorCode CreateCellScriptObject( const RequestContext& context, const GridArea& area, const ITableModel* tableModel, ScriptList* objectList, IScript* parent ) = 0 ;
 virtual ErrorCode CreateRowScriptObject( const RequestContext& context, GridCoord row, const ITableModel* tableModel, ScriptList* objectList, IScript* parent ) = 0 ;
 virtual ErrorCode CreateColumnScriptObject( const RequestContext& context, GridCoord col, const ITableModel* tableModel, ScriptList* objectList, IScript* parent ) = 0 ;
 virtual ErrorCode CreateTableScriptObject( const RequestContext& context, const ITableModel* tableModel, ScriptList* objectList ) = 0;
 virtual IScript* CreateTableScriptObject( const RequestContext& context, const ITableModel* tableModel) = 0;

 virtual ErrorCode ProcessCreateTableStyle(const PMString& styleName, const AttributeBossList* styleAttributes, IDataBase* dbOfStyleNameTable, UID& outNewStyleUID) const = 0;

 virtual bool16 IsStyleNamePresent(const PMString& styleName, IDataBase* dbOfStyleNameTable) const = 0;

#ifdef DEBUG

 virtual bool16 AreTableAttributes(const AttributeBossList* attrs) const = 0;
#endif

 virtual PMPoint ConvertToLocalPoint(const ITableFrame *tableFrame, const PBPMPoint& pt) const = 0;

 virtual bool16 InsideTable(const ITextModel* textModel, TextIndex at) const = 0;

 virtual TextIndex TableToPrimaryTextIndex(const ITextModel* textModel, TextIndex withinTableTextIndex) const = 0;

 virtual RangeData TableToPrimaryTextRange(const ITextModel* textModel, RangeData tableRange) const = 0;

 virtual bool16 DictGetIsComposable(const ITextStoryThreadDict* dict,
 uint32 dictKey) const = 0;
 virtual ParcelKey DictGetParcelKeyOfControllingAnchor(const ITextStoryThreadDict* dict, uint32 dictKey, ParcelKey keyInChildThread) const = 0;

 virtual GridArea FixUpTableSelection(const GridArea selection, const ITableModel *model) const = 0;

 virtual bool16 CanInsertTableAt(const ITextModel* textModel,
 TextIndex at) const = 0;

 virtual ParcelKey GetHFProxyParcelKey(const ICellContent* cell,
 ParcelKey key) const = 0;

 virtual bool16 GetHFTextRangeContext(const ITextModel* textModel,
 TextIndex at,
 RangeData* pFrameBodyRange,
 RangeData* pTableBodyRange) const = 0;

 virtual IPlaceBehavior* QueryPageItemCellPlaceBehavior(const ITableModel* tableModel, 
 GridAddress cellAddress) = 0;

 virtual IPlaceBehavior* QueryPageItemCellPlaceBehavior(UIDRef tableModel, 
 GridAddress cellAddress) = 0;

 virtual bool16 IsTableCellContent(const UIDRef& item, UID& pageItemAdapter) const = 0;
 
 virtual bool16 IsTableCellContent(const UIDRef& item, UID* pageItemAdapter = nil) = 0;


 virtual void ValidateContent(UIDList& items) const = 0;

 virtual CellType GetCellContentType(UIDRef tableModel, GridAddress cellAddress) const = 0;

 virtual ICellContent* QueryCellContentfromPlacedItem(UIDRef placedItem) const = 0;

 virtual bool16 CanConvertToGraphicCell(UIDRef tableModel, const GridAddress &cellAddress) const = 0;

 virtual bool16 CanConvertInlineCellToImageCell(const ITableModel* table, const GridAddress& cell) const = 0;

 virtual bool16 HasAnyTextCell(ITableModel* tableModel, const GridArea& area) const = 0;

 virtual bool16 HasAnyGraphicCell(ITableModel* tableModel, const GridArea& area) const = 0;

 virtual bool16 CanPlaceInGraphicCell(UIDRef item, ErrorCode* err = NULL) const = 0;

 virtual ErrorCode ResizeTableFrame(ITableFrame *tableFrame, const PMReal& horizonProp, const PMReal& verticalProp) = 0;

 virtual ErrorCode ResizeTableFrame(ITableFrame *tableFrame, PMRect tableArea, const int32 numRowsInFrame,
 const int32 numColumnsInFrame, ColRange columnsInFrame, const PMReal& horizonProp, const PMReal& verticalProp) = 0;
 
 virtual void SetMinRowHeight(ITableModel* table, int32 row, int32 howMany, const PMReal& height) = 0;
};


#endif // __ITABLEUTILS__