IUnitOfMeasure.h

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

#include "IPMUnknown.h"
#include "MeasurementSystemID.h"
#include "RequestContext.h"

class PMString;
class RsrcSpec;

class IUnitOfMeasure : public IPMUnknown
{
public:
 virtual void GetName(PMString* pName) = 0;

 virtual PMReal UnitsToPoints(const PMReal& units) const = 0;
 virtual PMReal PointsToUnits(const PMReal& points) const = 0;

 virtual void Format(const PMReal& units, PMString& str, PMString *fractionalPortionString = nil) const = 0;
 virtual bool16 Parse(const PMString& str, PMReal& points, const bool16 alwaysUseEnglishAbbreviations = kFalse) = 0;

 virtual PMReal GetSmallIncrement() const = 0;
 virtual PMReal GetLargeIncrement() const = 0;

 virtual RsrcSpec GetRulerSpecRsrcSpec() const = 0;

 typedef enum {
 kUnitIsXMeasure = 0x0001,
 kUnitIsYMeasure = 0x0002,
 kUnitIsTextMeasure = 0x0004,
 kUnitIsTextSizeMeasure = 0x0008,
 kUnitIsPrintMeasure = 0x0010,
 kUnitIsLineMeasure = 0x0020
 } UnitFlags;
 virtual UnitFlags GetUnitFlags() const = 0;

 virtual ScriptID GetScriptID( const ScriptInfo::RequestContext& context ) const = 0;
};

#endif