IWaxRun.h

//========================================================================================
// 
// $File$
// 
// Owner: zwilliam
// 
// $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 __IWaxRun__
#define __IWaxRun__

#include "IPMUnknown.h"
#include "ITextAdornment.h"
#include "IWaxCollection.h"
#include "TextID.h"

class PMMatrix;

const double kTextMiterLimit = 4.0;

class IWaxRun : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IWAXRUN };

 typedef enum {
 kRunKinsoku_PushIn = 0x01,
 kRunKinsoku_PushOut = 0x02,
 kRunKinsoku_Any = 0x03,

 kTOPRun = 0x20,
 kEndsInHyphen = 0x40,
 kVerticalWritingMode = 0x80
 } RunCharacteristics;

 virtual int32 GetCharCount() const = 0;

 virtual int32 GetWaxSpan() const = 0;

 virtual TextIndex TextOrigin() const = 0;

 virtual PMReal GetWidth(bool16 ignoreAllTrailing = kFalse) const = 0;

 virtual PMReal GetHeight() const = 0;

 virtual PMReal GetXPosition() const = 0;
 virtual void SetXPosition(const PMReal& xPos) = 0;

 virtual PMReal GetYPosition() const = 0;
 virtual void SetYPosition(const PMReal& yPos) = 0;

 virtual PMMatrix GetTransform() const = 0;
 virtual void SetTransform(const PMMatrix& xForm) = 0;

 virtual PMMatrix GetToParcelContentMatrix() const = 0;
 virtual PMMatrix GetToParcelMatrix() const = 0;
 virtual PMMatrix GetToFrameMatrix() const = 0;
 virtual PMMatrix GetToSpreadMatrix() const = 0;
 virtual PMMatrix GetToPasteboardMatrix() const = 0;

 virtual IWaxCollection* GetOwner() const = 0;
 // This should really take const params, and the runs hand out const returns for GetOwner, GetWaxLine..
 virtual void SetOwner(IWaxCollection* owner) = 0;

 virtual const IWaxLine* GetWaxLine() const = 0;

 virtual IDataBase* GetDataBase() const = 0;

 virtual bool16 IsVerticalWritingMode() const = 0;
 virtual void SetVerticalWritingMode(bool16 mode) = 0;

 virtual bool16 IsTOPRun() const = 0;
 virtual void SetTOPRun(bool16 is) = 0;

 virtual RunCharacteristics GetRunCharacteristics() const = 0;
 virtual void SetRunCharacteristics(RunCharacteristics bits) = 0;

 virtual bool16 SplitAt( int32 offsetInRun ) = 0 ;

 // ============================================
 // Adornments
 virtual void GetAdornments(int32 *num, const ClassID **iDs,
 const Text::DrawPriority **priority,
 const ITextAdornmentData ***data) const = 0;
 virtual void SetAdornments(int32 num, ClassID *iDs,
 Text::DrawPriority *priority,
 ITextAdornmentData **data) = 0;

 virtual bool16 FindAdornment(ClassID id, Text::DrawPriority *priority, ITextAdornmentData **data) const = 0;
 virtual void AddAdornment(ClassID id, Text::DrawPriority priority, ITextAdornmentData *data) = 0;

 virtual void RemoveAdornment(ClassID id) = 0;

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

#endif