IGraphicStateUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __IGraphicStateUtils__
#define __IGraphicStateUtils__

#include "GraphicsID.h"
#include "IPMUnknown.h"
#include "Utils.h"

//========================================================================================
//________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________
#include "IGraphicAttributeSuite.h"
#include "IGraphicAttrProxySuite.h"

//========================================================================================
//________________________________________________________________________________________
// CLASS FORWARDS
//________________________________________________________________________________________
 class IClassIDListData;
 class ICommand;
 class IDataBase;
 class IWorkspace;
 class IRenderObjectService;
 class IRenderingObject;
 class IGraphicStateAccessor;
 class ITextModel;
 class ITextFocus;
 class IPMUnknown;
 class ISelectionManager;

 class UIDList;
 class GraphicAttrMessage;
 class GraphicAttrCacheMessage;
 


class IGraphicStateUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGRAPHICSTATEUTILS };


 virtual ErrorCode ProcessGfxStateApplyAttribute (IPMUnknown* iNewAttribute, ISelectionManager* iSelectionMgr = nil) = 0;
 virtual ErrorCode ProcessGfxStateApplyAttribute (IPMUnknown* iNewAttribute, IGraphicAttributeSuite* iGraphicAttrSuite = nil) = 0;

 virtual ErrorCode ProcessGfxStateAddMultAttributes (IGraphicStyleAttributeBossList* iNewAttrList, IGraphicAttributeSuite* iGraphicAttrSuite = nil) = 0;
 virtual ErrorCode ProcessGfxStateRemoveAttributes (ClassID* pClassList, uint16 attributeCount, IGraphicAttributeSuite* iGraphicAttrSuite = nil) = 0;

 virtual ICommand* CreateAttributeCommand (const IPMUnknown *attribute, const UIDList *pTargetItemList, bool16 doPrePost, bool16 enableDoNotify) = 0;

 virtual ICommand* CreateGfxClearOverrideCommand (ClassID attributeClassID, const UIDList *targetItemList, bool16 enableDoNotify) = 0;

 virtual ICommand* CreateGfxApplyOverrideCommand (ClassID renderObjectClassID, UID renderUID, ClassID attributeClassID, const UIDList& targetItemList, bool16 doPrePost, bool16 enableDoNotify) = 0;

 virtual ICommand* CreateGfxSwapStrokeAndFillCommand (const UIDList& targetItemList) = 0;
 virtual ICommand* CreateTextSwapStrokeAndFillCommand (ITextModel* iTextModel, ITextFocus* iTextFocus) = 0;

 virtual void TransferAttributesModified (ICommand *iSourceCommand, IClassIDListData *iDestAttrModified) = 0;

 virtual void AppendAttributesModified (ClassID attributeModified, IClassIDListData *iDestAttrModified) = 0;

 virtual ErrorCode ProcessApplyTargetAttributesToPageItems (IGraphicStyleAttributeBossList* iNewAttrList, ClassID* pClassList, int32 attrCount, const UIDList& targetItemList, bool16 doPrePost = kTrue, bool16 enableDoNotify = kTrue) = 0;

 virtual ErrorCode ProcessSwapStrokeAndFillCmdSequence (IGraphicAttributeSuite* iGraphicAttrSuite = nil) = 0;

 virtual ErrorCode ProcessDefaultStrokeAndFillCmdSequence (IGraphicAttributeSuite* = nil) = 0;

 virtual ErrorCode ProcessToggleStrokeAndFillCmd (void) = 0;

 virtual ErrorCode ProcessUpdateDefinitionRenderDataCmdSequence
 (
 ClassID renderObjectClassID, 
 UID renderUID, 
 bool16 isFill,
 IGraphicAttributeSuite* iGfxAttrSuite = nil
 ) = 0;

 //________________________________________________________________________________________
 // Graphic State object accessors
 //________________________________________________________________________________________
 virtual IPMUnknown* QueryActiveGraphicState (const PMIID& requestedIID = IID_IUNKNOWN, IActiveContext* iActiveContext = nil) = 0;
 virtual IPMUnknown* QueryGraphicState (IDataBase* iDataBase, const PMIID& requestedIID = IID_IUNKNOWN) = 0;
 virtual IWorkspace* QueryDataBaseWorkspace (IDataBase* iDataBase) = 0;

 virtual UIDList* CreateFlattenedPageItemList (const UIDList* pItemList, const PMIID& interestedIID, bool16 onlyIncludeGfxStateSelection) = 0;
 
 //________________________________________________________________________________________
 // Is stroke or fill active in the toolbox proxy. These accessors are a shortcut
 // for querying the preference directly from the session workspace.
 //________________________________________________________________________________________
 virtual bool16 IsStrokeActive (void) = 0;
 virtual bool16 IsFillActive (void) = 0;
 
 virtual IGraphicAttributeSuite* QueryActiveGraphicAttrSuite (ISelectionManager* iSelectionMgr = nil) = 0;

 virtual void UpdateGfxStateRenderObjectsRenderData
 (
 ClassID renderObjectClassID,
 IGraphicAttributeSuite* iGfxAttrSuite,
 IGraphicStateRenderObjects* iGfxStateRenderObjects,
 bool16 doNotify
 ) = 0;

 virtual const K2Vector<ClassID>* GetInstalledRenderingTypes (void) = 0;

 //________________________________________________________________________________________
 // DESCR: Proxy utilities
 //________________________________________________________________________________________

 virtual bool16 CanSwapActiveProxyType(IGraphicAttrProxySuite::ActiveProxyType proxyType) = 0;
 virtual void SwapActiveProxyType(IGraphicAttrProxySuite::ActiveProxyType proxyType) = 0;
 virtual IGraphicAttrProxySuite::ActiveProxyType GetActiveProxyType() = 0;


 //________________________________________________________________________________________
 // DESCR: Graphic Attr message utilities
 //________________________________________________________________________________________
 virtual GraphicAttrMessage* CreateGraphicAttrMessage
 (
 const IGraphicAttrMessage::MessageType& messageID,
 const K2Vector<ClassID>& pClassList
 ) = 0;
 
 virtual GraphicAttrCacheMessage* CreateGraphicAttrCacheMessage
 (
 const PMIID& messageID,
 const IGraphicAttrMessage::MessageType& messageType,
 const K2Vector<ClassID>* attrClassList
 ) = 0;


 //________________________________________________________________________________________
 // Graphic State Rendering object accessors
 //________________________________________________________________________________________
 virtual IRenderObjectService* QueryRenderObjectService (ClassID renderClassID) = 0;
 virtual IRenderingObject* CreateTemporaryRenderObject (ClassID, const IRenderingObject* iSourceRenderObject = nil) = 0;


};


#endif // __IGraphicStateUtils__