ICellAdornment.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.
// 
//========================================================================================

#ifndef __ICellAdornment__
#define __ICellAdornment__

#include "IPMUnknown.h"
#include "TablesID.h"
#include "TableTypes.h"


//-----------------------------------
// Forward References
//
class IGraphicsPort;
class ITableFrame;
class PMMatrix;
class ICallback;


// ===================================================================================
// class ICellAdornment 
// ===================================================================================
class ICellAdornment : public IPMUnknown {

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

 typedef enum { kPassBeforeCell = -1, kPassAfterCell = 1 } DrawPass;
 typedef K2Vector<DrawPass> DrawPassList;

 // ----- API -----
 virtual void Draw(IGraphicsPort* port, int32 shapeFlags, DrawPass pass, 
 const ITableFrame* frame, const K2Vector<GridAddress>& cells) const = 0;
 

 virtual void Hilite(IGraphicsPort* port, const ITableFrame* frame, const K2Vector<GridAddress>& cells) const = 0;
 
 virtual void GetPassInfo(DrawPassList& passes) const = 0;
 
 virtual void IterateCellAdornmentDrawOrder(const ITableFrame* frame,
 const K2Vector<GridAddress>& cells, 
 const PMMatrix *xform,
 ICallback *callbackInfo,
 int32 iShapeFlags = 0) = 0;
 
};

DECLARE_BASE_TYPE(ICellAdornment::DrawPass);

#endif // __ICellAdornment__