IGraphicStateIsApplicable.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Martz
// 
// $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.
// 
// 
// Note: This interface is intended to be used on page items so that the page
// item (or its type) can determine which attribute types can be applied to
// it. For example, an image page item can only have a fill color and 
// overprint fill attribute.
// 
//========================================================================================

#ifndef _IGraphicStateIsApplicable_
#define _IGraphicStateIsApplicable_
//________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________
 #include "IPMUnknown.h"
 #include "GraphicStylesID.h"
//========================================================================================
//________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________

class IGraphicStateIsApplicable : public IPMUnknown
 {
 //____________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IGRAPHICSTYLE_IS_APPLICABLE };

 //____________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________
 public:
 //................................................................................
 // Prevent an internal attribute/rendering type from being applied to the page item
 //................................................................................

 virtual void PreventAttributeApplication (const ClassID& attrClassID) = 0;
 virtual void PreventFillRenderingApplication (const ClassID& newClassID) = 0;
 virtual void PreventStrokeRenderingApplication (const ClassID& newClassID) = 0;

 //................................................................................
 // Allow an internal attribute/rendering type to be applied to the page item.
 // Returns whether or not the attribute/rendering type class was removed from 
 // the list.
 //................................................................................

 virtual bool16 AllowAttributeApplication (const ClassID& attrClassID) = 0;
 virtual bool16 AllowFillRenderingApplication (const ClassID& newClassID) = 0;
 virtual bool16 AllowStrokeRenderingApplication (const ClassID& newClassID) = 0;

 virtual void ClearAttributeList (void) = 0;
 virtual void ClearFillRenderingList (void) = 0;
 virtual void ClearStrokeRenderingList (void) = 0;

 //................................................................................
 // Can the attribute/rendering type be applied to the page item?
 //................................................................................

 virtual bool16 IsAttributeApplicable (const ClassID& attrClassID) const = 0;
 virtual bool16 IsFillRenderingTypeApplicable (const ClassID& classID) const = 0;
 virtual bool16 IsStrokeRenderingTypeApplicable (const ClassID& classID) const = 0;
 
 //................................................................................
 // How many attribute/rendering type are prevented on the page item?
 //................................................................................

 virtual uint32 AttributeClassCount (void) const = 0;
 virtual uint32 FillRenderingTypeClassCount (void) const = 0;
 virtual uint32 StrokeRenderingTypeClassCount (void) const = 0;

 //................................................................................
 // Return the classID of the Nth item in the list.
 //................................................................................

 virtual ClassID GetAttributeClassID (uint32 index) const = 0;
 virtual ClassID GetFillRenderingTypeClassID (uint32 index) const = 0;
 virtual ClassID GetStrokeRenderingTypeClassID (uint32 index) const = 0;
 };

#endif // _IGraphicStateIsApplicable_