IDrawOptions.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Stephens
// 
// $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.
// 
// 
// Description:
// The purpose of this interface is to provide a central location for the various
// display settings which have an effect on performance. These settings do NOT affect
// printed output and hence do not include settings such as multi vs single line
// composition.
// 
// There are 3 standard sets of settings (kFast, kNormal, kHighQuality) allowing
// the user to quickly switch between their own definition of these sets as defined
// by the settings within the set. The interface is extensible in that third parties
// can add their own sets identified by their own setID (which should be their pluginID
// plus a constant).
// 
//========================================================================================

#ifndef __IDrawOptions__
#define __IDrawOptions__

#include "IPMUnknown.h"

class DrawOptionsSet;
class IDrawOptions : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_IDRAWOPTIONS };
 
 enum
 {
 kUseDefault = kMaxUInt32,
 kFastGroup = 0, 
 kTypicalGroup,
 kHighQualityGroup,
 kNavigatorGroup,
 kFastScrollGroup,
 kSepPrvGroup,
 kFlatPrvGroup,
 kSnapshotUtilsPrvGroup
 };

 typedef enum
 {
 kRasterGrayOut = 0,
 kRasterProxy,
 kRasterHighRes
 } RasterDisplay;
 
 typedef enum
 {
 kVectorGrayOut = 0,
 kVectorProxy,
 kDisplayList
 } VectorDisplay;

 typedef enum
 {
 kXPOff = 0,
 kXPLow,
 kXPMedium,
 kXPHigh,
 kXPMaximum
 } Transparencies;


 virtual int32 GetCount(void) const = 0;

 virtual void SetSet(const DrawOptionsSet& set) = 0;

 virtual void RemoveSet(uint32 setID) = 0;

 virtual bool8 SetActiveSetID(uint32 setID) = 0; // returns kTrue if successful

 virtual uint32 GetActiveSetID(void) const = 0;

 virtual bool8 GetSetByID(uint32 setID, DrawOptionsSet* result) const = 0;

 virtual DrawOptionsSet GetSetByIndex(int32 setIndex) const = 0;
 
 virtual void SetIgnoreOverrides(bool8 ignore) = 0;
 
 virtual bool8 GetIgnoreOverrides(void) const = 0;

 virtual void SetSaveLocalOverrides(bool8 save) = 0;
 
 virtual bool8 GetSaveLocalOverrides() const = 0;

};

const IDrawOptions::RasterDisplay kDefaultFastRaster = IDrawOptions::kRasterGrayOut;
const IDrawOptions::VectorDisplay kDefaultFastVector = IDrawOptions::kVectorGrayOut;
const IDrawOptions::Transparencies kDefaultFastXP = IDrawOptions::kXPOff;
const bool16 kDefaultFastAntiAlias = kFalse;
const double kDefaultFastGreekBelow = 7.0;

const IDrawOptions::RasterDisplay kDefaultTypicalRaster = IDrawOptions::kRasterProxy;
const IDrawOptions::VectorDisplay kDefaultTypicalVector = IDrawOptions::kVectorProxy;
const IDrawOptions::Transparencies kDefaultTypicalXP = IDrawOptions::kXPMedium;
const bool16 kDefaultTypicalAntiAlias = kTrue;
const double kDefaultTypicalGreekBelow = 7.0;

const IDrawOptions::RasterDisplay kDefaultHighQualityRaster = IDrawOptions::kRasterHighRes;
const IDrawOptions::VectorDisplay kDefaultHighQualityVector = IDrawOptions::kDisplayList;
const IDrawOptions::Transparencies kDefaultHighQualityXP = IDrawOptions::kXPHigh;
const bool16 kDefaultHighQualityAntiAlias = kTrue;
const double kDefaultHighQualityGreekBelow = 7.0;

const IDrawOptions::RasterDisplay kDefaultNavigatorRaster = IDrawOptions::kRasterProxy;
const IDrawOptions::VectorDisplay kDefaultNavigatorVector = IDrawOptions::kVectorProxy;
const IDrawOptions::Transparencies kDefaultNavigatorXP = IDrawOptions::kXPOff;
const bool16 kDefaultNavigatorAntiAlias = kFalse;
const double kDefaultNavigatorGreekBelow = 7.0;

const IDrawOptions::RasterDisplay kDefaultFastScrollRaster = IDrawOptions::kRasterProxy;
const IDrawOptions::VectorDisplay kDefaultFastScrollVector = IDrawOptions::kVectorProxy;
const IDrawOptions::Transparencies kDefaultFastScrollXP = IDrawOptions::kXPOff;
const bool16 kDefaultFastScrollAntiAlias = kTrue;
const double kDefaultFastScrollGreekBelow = 7.0;

class DrawOptionsSet {
public:
 typedef base_type data_type; 
 
 DrawOptionsSet& operator = (const DrawOptionsSet& copy)
 {
 if ( this != &copy )
 {
 setID = copy.setID;
 raster = copy.raster;
 vector = copy.vector;
 xp = copy.xp;
 antiAlias = copy.antiAlias;
 greekBelow = copy.greekBelow;
 }
 
 return *this;
 }

 bool16 operator == (const DrawOptionsSet& other) const
 {
 return
 setID == other.setID
 && raster == other.raster
 && vector == other.vector
 && xp == other.xp
 && antiAlias == other.antiAlias
 && greekBelow == other.greekBelow;
 }

 uint32 setID;
 IDrawOptions::RasterDisplay raster;
 IDrawOptions::VectorDisplay vector;
 IDrawOptions::Transparencies xp;
 PMReal greekBelow;
 bool16 antiAlias;
};

#endif