IObjectStylesSuite.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 __IOBJECTSTYLESSUITE__
#define __IOBJECTSTYLESSUITE__

#include "IPMUnknown.h"
#include "IObjectStyleInfo.h"
#include "IObjStylesAttrHandler.h"

#include "StyleClashResolutionTypes.h"
#include "GenericID.h"
#include <map>

class IStyleGroupHierarchy;
class ObjStyleDialogLockStateObj
{
public:
 ObjStyleDialogLockStateObj() {};
 virtual ~ObjStyleDialogLockStateObj() {};
}; // Used by CreateLocakStateObj
class IObjectStylesSuite : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IOBJECTSTYLESSUITE};

 virtual bool16 CanCreateNewObjectStyleFromSelection() const = 0;

 virtual ErrorCode CreateNewObjectStyleFromSelection(PMString styleName, PMString& createdStylePath, UID parentUID = kInvalidUID, int32 position = -1) = 0;
 
 virtual ErrorCode CreateNewObjectStyle(IObjectStyleInfo* iObjectStyleInfo, IPMUnknown* target, UID parentUID = kInvalidUID, int32 position = -1) = 0;

 virtual ErrorCode EditObjectStyle(IObjectStyleInfo* iObjectStyleInfo, IPMUnknown* target, const PMString& editStyleName, int32 numApplies = 0) = 0;

 virtual bool16 CanApplyObjectStyle() const = 0;

 virtual ErrorCode ApplyObjectStyle(const PMString name, const bool16 bApplyDefaultGraphicStyle, bool16 overrideExistingAttrs, bool16 applyEmptyCatWithRoot, bool16 affectAppliedItems = kFalse) = 0;

 virtual ErrorCode ClearObjectStyleOverrides() = 0;

 virtual bool16 CanClearUnCheckedOverridesWithNoneStyle() const = 0;
 
 virtual ErrorCode ClearOverridesNotDefinedByStyle() = 0;

 virtual bool16 CanModifyStyleList() const = 0;

 virtual bool16 CanModifyStyles(const K2Vector<PMString>& styleIndexs) const = 0;

 virtual bool16 CanDeleteStyles(const K2Vector<PMString>& styleIndexs) const = 0;

 virtual ErrorCode DeleteObjectStyles(const K2Vector<PMString>& styleIndexs, const PMString& styleToReplaceWith, const bool16& bPerserveFormat = kFalse) = 0;

 virtual ErrorCode SortObjectStyles() = 0;


 virtual ErrorCode LoadObjectStyles(const StyleClashResolutionTypes::GlobalClashResolutionStrategy& globalClashResolutionStrategy, const IDFile& sourceFile,
 const std::map<PMString,bool32>& importMap,
 const std::map<PMString,bool32>& clashMap,
 const std::map<PMString,StyleClashResolutionTypes::StyleClashResolutionStrategy>& resolveMap) = 0;

 virtual ErrorCode ExportObjectStyles(const IDFile& targetFile, const K2Vector<PMString>& objectStyles) = 0;

 virtual ErrorCode ImportObjectStyles(const IDFile& sourceFile) = 0;

 virtual ErrorCode RenameObjectStyle(const int32 styleIndex, const PMString& newName ) = 0;

 virtual ErrorCode ReplaceObjectStyles(const K2Vector<PMString>& styleNames, const PMString& replaceWith) = 0;

 virtual bool16 CanRedefineObjectStyle() const = 0;

 virtual bool16 CanClearOverrides() const = 0;


 virtual ErrorCode RedefineStyle() = 0;


 virtual ErrorCode ChangeDefaultTextStyle(const PMString& newStyleName) = 0;

 virtual PMString GetDefaultTextStyle() = 0;

 virtual ErrorCode ChangeDefaultGraphicStyle(const PMString& newStyleName) = 0;

 virtual PMString GetDefaultGraphicStyle() = 0;

 virtual ErrorCode ChangeDefaultFrameGridStyle(const PMString& newStyleName) = 0;

 virtual PMString GetDefaultFrameGridStyle() = 0;

 virtual ErrorCode DuplicateObjectStyles(const K2Vector<PMString>& styleNames, K2Vector<PMString>& styleNamesCreated) = 0;
 
 virtual bool16 CanMoveObjectStyles(const K2Vector<PMString>& styleNames, const int32 dropBefore = -1) = 0;

 virtual ErrorCode MoveObjectStyles(const K2Vector<PMString>& styleNames, const int32 dropBefore) = 0;


 virtual K2Vector<PMString> GetCurrentObjectStyles() const = 0;

 virtual PMString GetNameOfNthStyle(const int32 n) const = 0;

 virtual int32 GetStyleIndexFromName(const PMString& name) const = 0;

 virtual int32 GetNumObjectStyles() const = 0;

 virtual PMString GetUniqueDuplicateName(IStyleGroupHierarchy* hierParent, const PMString& baseName) const = 0;

 virtual void CreateStyleName(IStyleGroupHierarchy* hierParent, PMString * styleName) const = 0;
 

 virtual bool16 CanDoBreakLinkToObjectStyles() const = 0;

 virtual ErrorCode BreakLinkToObjectStyles() = 0;

 virtual ErrorCode BreakLinkFromProvidedObjectStyles(const K2Vector<PMString> styleList) = 0;

 virtual bool16 CanBaseStyleOnStyle(PMString& style1, PMString& style2) const = 0;

 virtual IPMUnknown* QueryStyleTargetFromStyle(const PMString& name) const = 0;

 virtual IPMUnknown* QueryStyleTargetFromSelection(const PMString& basedOnStyleName) const = 0;

 virtual bool16 SelectionOverridesObjStyle(UID objecStyleUID = kInvalidUID) const = 0;

 virtual bool16 DoesObjectStyleHaveOverride(const PMString& name) const = 0;

 virtual PMString GetStylesBasedOnStyleName(const PMString& name) const = 0;
 virtual VirtualKey GetStylesKeyboardShortcut(const PMString& name, int16* modifiers) const = 0;

 virtual const ObjStyleCategoryAttrMap GetCurrentOverridesAttributeMap() const = 0;

 virtual const ObjStyleCategoryNameMap GetCurrentOverridesNameMap() const = 0;

 virtual bool16 SelectionContainsFrameGridStyle() const = 0;

 virtual bool16 SelectionWithMixedOverrides() const = 0;

 virtual ObjStyleDialogLockStateObj* CreateLocakStateObj(const PMString& styleName) const = 0;
};

#endif