IObjectStylesUtils.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.
// 
//========================================================================================

#ifndef __IOBJECTSTYLEUTILS__
#define __IOBJECTSTYLEUTILS__

#include "IPMUnknown.h"
#include "GenericID.h"
#include "PMString.h"
#include "AttributeBossList.h"
#include "IObjectAttributeList.h" // for ObjectStyleTarget
#include "IStyleNameTable.h"
#include "ISelectionExtension.h" // for ProtocolCollection
#include "IObjStylesAttrHandler.h"
#include "LazyNotificationData.h"
#include "IObjStylesAttrHandler.h"
#include "IAnchoredObjectData.h"
#include "Utils.h"

//-----------------------------------
// Forward References
//
class ICommand;

// ===================================================================================
// class IObjectStylesUtils 
// ===================================================================================
class IObjectStylesUtils : public IPMUnknown
{

//-----------------------------------
// API
//
public:
 // ----- Constants -----
 enum {kDefaultIID = IID_IOBJECTSTYLESUTILS};

 virtual void FillStyleTargetFromSelection(const IPMUnknown* modelTargetBoss, IPMUnknown *targetBoss, IWorkspace *ws, bool16 fillInCategories = kTrue) const = 0;

 virtual void SetStyleTargetOnDefaultSelection(const IPMUnknown* targetBoss, IWorkspace *ws, K2Vector<ClassID>& categoriesToOverride) = 0;

 virtual void SetStyleTargetOnUIDList(const UIDList& list, const IPMUnknown* targetBoss, IWorkspace *ws, K2Vector<ClassID>& categoriesToOverride) = 0;
 
 virtual void GetTargetFromObjectStyle(const UIDRef& objectStyleUIDRef, IPMUnknown* target, UID fillInUncheckedCategoriesWithThisUID = kInvalidUID) = 0;
 virtual void SetTargetIntoObjectStyle(const UIDRef& objectStyleUIDRef, const IPMUnknown* target, const IObjStylesAttrHandler::HowToUseCategories howToUseCat = IObjStylesAttrHandler::kApplyOnlyCheckedCategoriesFromSource) = 0;

 virtual void CopyTargetBetweenObjectStyles(IWorkspace *sourceWS, const UID& sourceObjectStyle, 
 IWorkspace *targetWS, const UID& targetObjectStyle) = 0;
 virtual void MergeAttrsIntoObjectStyle(const IPMUnknown* sourceObjectStyle, IWorkspace *targetWS, const UID& targetObjectStyle) = 0;

 virtual void FillInDefaultGraphicStyle(IWorkspace *ws, IPMUnknown* target, bool16 isRootStyle = kFalse) = 0;
 virtual void FillInDefaultTextStyle(IWorkspace *ws, IPMUnknown* target) = 0;

 virtual void FillInDefaultFrameGridStyle(IWorkspace *ws, IPMUnknown* target) = 0;

 virtual PMString GetUniqueDuplicateName(IWorkspace* ws, const PMString& baseName) = 0;

 virtual ICommand* CreateSetDefaultStyleCmd(IWorkspace *ws, const PMString& newDefaultStyleName, bool16 applyAttrs, const IPMUnknown *target, bool16 clearOverrides = kFalse) = 0;
 virtual ICommand* CreateSetDefaultStyleCmd(IWorkspace *ws, const PMString& newDefaultStyleName, bool16 applyAttrs, const IPMUnknown *target, K2Vector<ClassID>& categoriesToOverride) = 0;

 virtual ICommand* CreateSetDefaultTextStyleCmd(IWorkspace *ws, const PMString& newDefaultStyleName, bool16 applyAttrs, const IPMUnknown *target, bool16 clearOverrides = kFalse, bool16 bDefaultFrameGridCmd = kFalse) = 0;

 virtual ICommand* CreateSetDefaultTextStyleCmd(IWorkspace *ws, const PMString& newDefaultStyleName, bool16 applyAttrs, const IPMUnknown *target, K2Vector<ClassID>& categoriesToOverride, bool16 bDefaultFrameGridCmd = kFalse) = 0;

 virtual ICommand* CreateSetDefaultFrameGridStyleCmd(IWorkspace *ws, const PMString& newDefaultStyleName, bool16 applyAttrs, const IPMUnknown *target, bool16 clearOverrides = kFalse, bool16 bDefaultFrameGridCmd = kTrue) = 0;

 virtual ICommand* CreateSetDefaultFrameGridStyleCmd(IWorkspace *ws, const PMString& newDefaultStyleName, bool16 applyAttrs, const IPMUnknown *target, K2Vector<ClassID>& categoriesToOverride, bool16 bDefaultFrameGridCmd = kTrue) = 0;

 virtual bool16 IsStyleOverridenBySelection(const IPMUnknown* modelTargetBoss, const IWorkspace*ws, const IPMUnknown* style, const K2Vector<ClassID> *categories = nil) = 0;

 virtual ObjStyleCategoryAttrMap GetSelectionOverridesToStyle(const IPMUnknown* modelTargetBoss, const IWorkspace*ws, const UID styleUID, ObjStyleCategoryNameMap& categoryNameMap, const K2Vector<ClassID> *categories = nil) = 0;

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

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

 virtual void FillStyleTargetWithAllSupportedCategories(IPMUnknown *targetBoss) const = 0;

 virtual void FillStyleTargetCategoriesFromStyle(const UIDRef& styleUIDRef, IPMUnknown *targetBoss) = 0;

 virtual bool16 CanItemsBreakLinkFromObjectStyles(IWorkspace* ws, const UIDList& itemList) = 0;

 virtual bool16 CanBaseStyleOnStyle(IWorkspace* ws, UID style1, UID style2) const = 0;

 virtual IWorkspace* QueryWorkspaceFromDataBase(IDataBase* db) const = 0;

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

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

 virtual ProtocolCollection GetNotificationProtocolListForObjectStyles(IWorkspace* ws) const = 0;

 virtual void NotifyObjectStyleInfoChanged(const UIDList* itemList, ICommand *cmd, ClassID cmdClassID, const LazyNotificationData* data = nil) const = 0;

 virtual void NotifyObjectStyleNameTableChanged(const UIDList* itemList, ICommand *cmd, ClassID cmdClassID = kInvalidClass, const LazyNotificationData* data = nil) const = 0;

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

 virtual bool16 IsReservedObjectStyleName(const PMString& styleName) const = 0;

 virtual void GetFormattedString(const PMReal& value, const bool16& bHorizontal, const IWorkspace* ws, PMString& outString) = 0;

 virtual void FixTextStylesInDefaultObjectStyles(IWorkspace *ws) = 0;

 virtual bool16 IsItemWithCategoryAppliedByObjectStyle(const UIDRef& item, const ClassID& categoryClass, UIDRef& objectStyleUIDRef) const = 0;

 virtual IObjStylesAttrHandler* QueryObjectStyleHandler(const ClassID& handlerClass) const = 0;

 virtual bool16 DoesItemHaveSameTextAttrsWithObjectStyle(const UIDRef& item, const ClassID& category) const = 0;

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

};

#endif // define