IGraphicAttributeSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: SusanCL
// 
// $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 _IGraphicAttributeSuite_
#define _IGraphicAttributeSuite_
//========================================================================================
//________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________
 #include "IPMUnknown.h"
 #include "GraphicStylesID.h"
 #include "ShuksanID.h"
 #include "K2Vector.h"
 
 #include "IGraphicAttrMessage.h"
//========================================================================================
//________________________________________________________________________________________
// CLASS DECLARATIONS
//________________________________________________________________________________________
class ICommand;
class IGraphicStyleAttributeBossList;
class IGraphicStateRenderObjects;

class IGraphicAttributeSuite : public IPMUnknown
 {
 //____________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IGRAPHICATTRIBUTESUITE };

 //____________________________________________________________________________________
 // Attribute Utilities 
 //____________________________________________________________________________________
 public:
 virtual uint16 GetAttributeCount (ClassID attrClassID) = 0;

 virtual int16 GetAttributeValueCount (ClassID attrClassID, uint32 whichAttribute) = 0;
 
 virtual const IPMUnknown* QueryAttribute (uint32 whichAttribute, ClassID attrClassID, const PMIID& interfaceID = IID_IUNKNOWN) = 0;

 virtual IPMUnknown* CreateAttributeCopy (uint32 whichAttribute, ClassID attrClassID, const PMIID& = IID_IUNKNOWN) = 0;
 
 virtual ErrorCode AddAttribute (const IPMUnknown* iNewAttribute) = 0;

 virtual ErrorCode CopyIntoAttribute (uint32 whichAttribute, IPMUnknown* iNewAttribute) = 0;

 virtual ErrorCode RemoveAttribute (ClassID attrClassID) = 0;

 virtual ErrorCode RemoveAllAttributes (ClassID* pAttrClassList, uint16 count) = 0;

 virtual ErrorCode AddMultAttributes (IGraphicStyleAttributeBossList* iAttrList) = 0;

 virtual IGraphicStyleAttributeBossList* CreateAttributeListCopy (void) = 0;

 virtual ErrorCode SwapStrokeAndFill (void) = 0;
 //____________________________________________________________________________________
 // Render Object Utilities 
 //____________________________________________________________________________________
 public:

 // The following two methods update data in the graphic definition

 virtual ErrorCode ChangeStrokeRenderObject (ClassID renderingClass, UID renderingUID) = 0;

 virtual ErrorCode ChangeFillRenderObject (ClassID renderingClass, UID renderingUID) = 0;

 virtual UID GetFillRenderObjectUID (ClassID) = 0;

 virtual UID GetStrokeRenderObjectUID (ClassID) = 0;

 virtual bool16 IsFillRenderObjectIndeterminant (ClassID) = 0;

 virtual bool16 IsStrokeRenderObjectIndeterminant (ClassID) = 0;
 
 //____________________________________________________________________________________
 // Other Utilities 
 //____________________________________________________________________________________
 public:
 virtual ErrorCode ApplyRenderUIDToSelection (ClassID renderingClass, UID renderingUID, ClassID renderingAttrClass) = 0;

 virtual ClassID GetCurrentRenderObjectClass (void) = 0;

 virtual ClassID GetFillClass (void) = 0;

 virtual ClassID GetStrokeClass (void) = 0;

 virtual bool16 IsAttributeEnabled (ClassID attributeClass) = 0;
 
 virtual bool16 IsLineTypeEnabled (ClassID attributeClass) = 0;

 //____________________________________________________________________________________
 // Directly update graphic states rendering objects
 // CSB should not use.
 //____________________________________________________________________________________
 public:

 virtual void UpdateRenderObjectsToProxyState (void) = 0;
 
 //____________________________________________________________________________________
 // Get current disabled attribute class IDs and rendering types in the list.
 //____________________________________________________________________________________

 virtual void GetDisabledAttributesList (K2Vector<ClassID>* pDisabledAttrClassList) = 0;

 virtual void GetDisabledRenderingTypesList (K2Vector<ClassID>* pDisabledFillRenderClassList, K2Vector<ClassID>* pDisabledStrokeRenderClassList) = 0;
 };

#endif // _IGraphicAttributeSuite_