ISetDrawOptionOverrideCmdData.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.
// 
// 
// Purpose: This Data interface is used to set an object level override of the IDrawOptions
// on a pageitem.
// 
//========================================================================================

#ifndef __ISetDrawOptionOverrideCmdData__
#define __ISetDrawOptionOverrideCmdData__

#include "IDrawOptionOverrides.h"
#include "GenericID.h"

class DisplayOptionRange
{
public:
 DisplayOptionRange(): fnStart(0), fnCount(0), fnOption(0) {}
 DisplayOptionRange(const DisplayOptionRange& r): fnStart(r.fnStart), fnCount(r.fnCount), fnOption(r.fnOption) {}
public:
 uint32 fnOption;
 int32 fnStart;
 int32 fnCount;
};

class ISetDrawOptionOverrideCmdData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISETDRAWOPTIONOVERRIDECMDDATA };

 virtual void SetDisplayOption(uint32 displayOption) = 0; 

 virtual uint32 GetDisplayOption() const = 0; 

 virtual void ClearOptionRange() = 0;
 virtual void AppendOptionRange( const DisplayOptionRange& range ) = 0;
 virtual int32 GetOptionRangeCount() const = 0;
 virtual DisplayOptionRange GetNthDisplayOptionRange(int32 n) const = 0;

 virtual void SetOverrideLocation(IDrawOptionOverrides::OverrideLocation location) = 0;
 virtual IDrawOptionOverrides::OverrideLocation GetOverrideLocation() const = 0;
};

#endif // __ISetDrawOptionOverrideCmdData__