IWaxCollection.h

//========================================================================================
// 
// $File$
// 
// Owner: Ric Kamicar
// 
// $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 __IWaxCollection__
#define __IWaxCollection__

#include "IPMUnknown.h"
#include "IWaxLine.h"
#include "TextID.h"

class IWaxRun;
class PMLineSeg;
class IWaxGlyphIterator;
class IWaxRunIterator;

class IWaxCollection : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IWAXCOLLECTION };

 virtual int32 Count() const = 0;

 virtual IWaxRun* QueryRun(int32 index) const = 0; // index to WaxRun
 virtual int32 GetRunIndex(const IWaxRun * run) const = 0; // WaxRun to index

 virtual TextIndex TextOrigin() const = 0;

 virtual void GetHeight(PMLineSeg* pHeight) const = 0;

 virtual IDataBase* GetDataBase() const = 0;

 virtual const IWaxLine* GetWaxLine() const = 0;
 virtual void SetWaxLine(const IWaxLine * waxLine) = 0;

 virtual void AddRun(IWaxRun* run) = 0;
 virtual void AddRunAt(IWaxRun* run, int32 at) = 0;

 virtual void RemoveAllRuns() = 0;

 virtual IWaxRun* QueryPreviousNeighbor(const IWaxRun* waxRun) const = 0; // Previous in collection or nil
 virtual IWaxRun* QueryNextNeighbor(const IWaxRun* waxRun) const = 0; // Next in collection or nil

 enum WaxCollectionOrientation {
 kWCOAdjacent,
 kWCOStacked
 } ;

 virtual enum WaxCollectionOrientation GetOrientation() const = 0;
 virtual void SetOrientation(enum IWaxCollection::WaxCollectionOrientation orientation) = 0;

 virtual IWaxGlyphIterator* QueryWaxGlyphIterator(bool16 includeCollection = kFalse) const = 0;

 virtual IWaxRunIterator* QueryWaxRunIterator(bool16 includeCollection = kFalse) const = 0;

 virtual PMMatrix GetTransform() const = 0;

 virtual PMMatrix GetToParcelMatrix() const = 0;

 virtual PMMatrix GetToFrameMatrix() const = 0;

 virtual PMMatrix GetToSpreadMatrix() const = 0;

 virtual PMMatrix GetToPasteboardMatrix() const = 0;

 //============================================
 virtual void ConstructionComplete() = 0;
};

#endif