IObjStylesAttrHandler.h

//========================================================================================
// 
// $File$
// 
// Owner: Danielle Darling
// 
// $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: Handlers the processing of an object style target thru to the model
// 
// Adobe Patent or Adobe Patent Pending Invention Included Within this File
// 
//========================================================================================


#ifndef __IObjStylesAttrHander__
#define __IObjStylesAttrHander__

#include "IPMUnknown.h"
#include "ShuksanID.h"
#include "GenericID.h"
#include "IObjectAttributeList.h" // for ObjectStyleTarget
#include "KeyValuePair.h"
#include "ISelectionExtension.h" // for ProtocolCollection

//
// Adobe patent application tracking #B098, 
// entitled Design a flexible and extensible way to implement object style, 
// inventors: Danielle Darling, Yeming Liu 
//

typedef KeyValuePair<PMString, PMString> ObjStyleAttrNameValuePair;
typedef K2Vector<ObjStyleAttrNameValuePair> ObjStyleAttrNameValueList;
typedef K2Vector<KeyValuePair<ClassID, ObjStyleAttrNameValueList > > ObjStyleCategoryAttrMap;
typedef K2Vector<KeyValuePair<ClassID, PMString > > ObjStyleCategoryNameMap;

class IObjStylesAttrHandler : public IPMUnknown
 {
 
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IOBJSTYLESATTRHANDLER };

 enum HowToUseCategories { kApplyAllCategories, kApplyOnlyCheckedCategoriesFromSource, kApplyOnlyUncheckedCategoriesInTarget };

 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:
 virtual void GetFillStyleTargetFromSelectionTarget(const IPMUnknown *modelTarget, IPMUnknown* styleTarget, const IWorkspace *ws) const = 0;
 virtual void SetStyleAttrsInDefaultSelection(const IPMUnknown* styleTarget, const IWorkspace *ws, K2Vector<ClassID>& categoriesToOverride) = 0;

 virtual void SetStyleAttrsInUIDList(const UIDList& list, const IPMUnknown* styleTarget, const IWorkspace *ws, K2Vector<ClassID>& categoriesToOverride)= 0;

 virtual void GetDefaultGraphicFrameStyleAttrs(IPMUnknown* targetBoss, const IWorkspace *ws, const bool16 isRootStyle = kFalse) const = 0;
 virtual void GetDefaultTextFrameStyleAttrs(IPMUnknown* targetBoss, const IWorkspace *ws) const = 0;

 virtual void GetDefaultFrameGridStyleAttrs(IPMUnknown* targetBoss, const IWorkspace *ws) const = 0;
 
 virtual void SetAttrsInTarget(IPMUnknown* fillTargetBoss, const IPMUnknown* applyTargetBoss, const IPMUnknown* oldTargetBoss, bool16 clearOverrides) = 0;

 virtual void GetAttrsFromObjectStyle(const UIDRef& objectStyleUIDRef, IPMUnknown* targetBoss, const HowToUseCategories howToUseCat = kApplyAllCategories) = 0;

 virtual void SetAttrsIntoObjectStyle(const UIDRef& objectStyleUIDRef, const IPMUnknown* targetBoss, const HowToUseCategories howToUseCat = kApplyAllCategories) = 0;

 virtual void CopyAttrsBetweenObjectStyles(const IWorkspace* sourceWS, const UID& sourceObjectStyle, 
 const IWorkspace* targetWS, const UID& targetObjectStyle) = 0;
 virtual void MergeAttrsIntoObjectStyle(const IPMUnknown* sourceObjectStyle, const IWorkspace* targetWS, 
 const UID& targetObjectStyle) = 0;
 
 virtual bool16 IsStyleOverridenBySelection(const IPMUnknown* modelTargetBoss, const IWorkspace*ws, const IPMUnknown* style, const K2Vector<ClassID> *categories = nil) const = 0;

 virtual bool16 SelectionContainsMixedOverrides(const IPMUnknown *modelTarget, const IWorkspace* ws, const K2Vector<ClassID> *categories) const = 0;

 virtual void FillTargetWithAllSupportedAttrCategories(IPMUnknown* targetBoss) = 0;

 virtual K2Vector<ClassID> GetAcceptedCategories() const = 0;

 virtual ObjStyleCategoryAttrMap GetOverrideList(const IPMUnknown* modelTargetBoss, const IWorkspace *ws, const IPMUnknown* target, 
 const K2Vector<ClassID> *categories, ObjStyleCategoryNameMap& categoryNameMap) const = 0;

 virtual ObjStyleCategoryAttrMap GetAcceptedAttributeList(const IPMUnknown* target, const IWorkspace *ws, ObjStyleCategoryNameMap& categoryNameMap) const = 0;

 virtual ProtocolCollection GetNotificationProtocolList() const = 0;

 virtual void DoAttrConversion(IDataBase* targetDB, IPMUnknown* iTargetStyleAttributes,
 const IWorkspace *targetWS, IDataBase* sourceDB) = 0;

 virtual void RemoveStyleAttributes(const UIDRef& styleUIDRef) = 0;

 virtual K2Vector<ClassID> GetCategoriesThatAffectTextFrameDefaults() const = 0;
 
 virtual K2Vector<ClassID> GetCategoriesThatAffectGraphicFrameDefaults() const = 0;

 virtual void GetCategoryByAttribute(const ClassID& attributeID, ClassID& categoryClass) const = 0;

 virtual void SetStyleAttrsInUIDListPostAddToHierarchy(const UIDList& list, const IPMUnknown* styleTarget, const IWorkspace *ws, K2Vector<ClassID>& categoriesToOverride)= 0;

 };

#endif // __IObjStylesAttrHandler__