ICellContent.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: Provides access to cell content in an opaque wrapper.
// 
//========================================================================================

#ifndef __ICellContent__
#define __ICellContent__

#include "IPMUnknown.h"
#include "TablesID.h"
#include "TableTypes.h"
#include "PMPoint.h"
#include "PMRect.h"
#include "ParcelKey.h"
#include "OwnedItemDataList.h"


//-----------------------------------
// Forward References
//
class TableMementoPiece;
class PMMatrix;
class TableLayout;


// ===================================================================================
// class ICellContent 
// ===================================================================================
class ICellContent : public IPMUnknown {

//-----------------------------------
// API
//
public:
 // ----- Constants -----
 enum {kDefaultIID = IID_ICELLCONTENT};
 enum GrowableDirection { kNone = 0, kLeft = 0x01, kTop = 0x02,
 kRight = 0x04, kBottom = 0x08 };

 // ----- API -----
 virtual void SetTableModel(const UIDRef& tableModelRef) = 0;
 virtual UIDRef GetTableModel() const = 0;
 virtual void SetGridID(const GridID& gridID) = 0;
 virtual GridID GetGridID() const = 0;
 virtual void SetGridAddress(const GridAddress& gridAddress) = 0;
 virtual GridAddress GetGridAddress() const = 0;

 virtual PMRect GetCellPathBounds(ParcelKey key) const = 0;
 virtual UID GetParcelFrameUID(ParcelKey key) const = 0;
 virtual PMMatrix GetParcelToFrameMatrix(ParcelKey key) const = 0;
 virtual bool16 GetParcelAcceptingInvals(ParcelKey key) const = 0;
 virtual void AddParcelPendingInval(ParcelKey key,
 const PMRect& invalRect) = 0;
 virtual void NotifyLayoutParcelDamageChanged(ParcelKey key,
 bool16 isDamaged) = 0;

 virtual void NotifyLayoutParcelPosDependentContentSet(ParcelKey key) = 0;

 virtual void NotifyLayoutParcelInkBoundsChanged(ParcelKey key) = 0;

 virtual CellType GetCellType() const = 0;

 virtual void NotifyRowTypeChanging(bool16 repeat,
 int32 lRowCount) = 0;

 virtual void InvalCellContent(ParcelKey key) = 0;

 virtual void ResetCompositionState() = 0;

 virtual int32 GetParcelCount() const = 0;

 virtual int32 GetParcelIndex(ParcelKey key) const = 0;

 virtual ParcelKey GetNthParcelKey(int32 n) const = 0;

 virtual ParcelKey CreateParcelAt(int32 index) = 0;

 virtual void RemoveParcel(int32 index) = 0;

 virtual void SetParcelGeometry(ParcelKey key,
 const PMRect& cellPathBounds,
 const PMRect& parcelBounds,
 const PMRect& maxGrowBounds,
 GrowableDirection growDir,
 bool16 contentAttributeChanged) = 0;

 virtual void SetParcelGrowDir(ParcelKey key, 
 GrowableDirection growDir) = 0;

 virtual void SetParcelHeight(ParcelKey key, PMReal height) = 0;

 virtual void NotifyContentAttributeChanged(ParcelKey key) = 0;

 virtual void NotifyParcelMoved(ParcelKey key) = 0;

 virtual bool16 GetParcelNeedsComposition(ParcelKey key) const = 0;

 virtual void RecomposeThruParcel(ParcelKey key) = 0;

 virtual PMRect GetParcelContentInkBounds(ParcelKey key) const = 0;

 virtual bool16 GetParcelHasPositionDependentContent(ParcelKey key) const = 0;

 virtual PMReal GetParcelTopHungComposedBottom(ParcelKey key) const = 0;
 virtual PMReal GetParcelBottomHungComposedTop(ParcelKey key) const = 0;
 virtual PMReal GetParcelComposedGrowableHeight(ParcelKey parcelKey) const = 0;

 virtual void CollectParcelOwnedItems(ParcelKey key,
 OwnedItemDataList* rList) const = 0;

 virtual void ConvertFromAnna(TableLayout* layout) = 0;

 virtual bool16 IsEmpty() const = 0;

 virtual PMRect GetParcelPaintedBBox(ParcelKey key) const = 0;

};

#endif // __ICellContent__