IObjectStylesFacade.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 __IOBJECTSTYLESFACADE__
#define __IOBJECTSTYLESFACADE__

#include "IPMUnknown.h"
#include "GenericID.h"
#include "PMString.h"
#include "AttributeBossList.h"
#include "IObjectAttributeList.h" // for ObjectStyleTarget
#include "IStyleNameTable.h"
#include "IObjectStyleInfo.h"
#include "StyleClashResolutionTypes.h"
#include "IStyleRemapData.h"
#include "keyboarddefs.h"

#include <map>

//-----------------------------------
// Forward References
//

// ===================================================================================
// class IObjectStylesUtils 
// ===================================================================================
namespace Facade
{
 class IObjectStylesFacade : public IPMUnknown
 {

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

 virtual ErrorCode CreateNewObjectStyle(IPMUnknown* objectStyleTarget, IWorkspace* ws, const PMString& newStyleName, 
 const UID basedOnUID, const bool16& bStyleNameTranslatable = kFalse, 
 const VirtualKey virtualKey = kVirtualNullKey, const int16 modifier = 0, 
 const UID parentUID = kInvalidUID, const int32 position = -1) = 0;


 virtual ErrorCode ApplyObjectStyleToUIDList(const UIDList& list, IWorkspace* ws, UID uidOfStyle, K2Vector<ClassID>& categoriesToOverride, bool16 applyEmptyCatWithRoot) = 0;
 virtual ErrorCode EditObjectStyle(IPMUnknown *objectStyleTarget, IObjectStyleInfo* iObjectStyleInfo, const IWorkspace* ws, 
 const PMString& originalStyleName, int32 numApplies = 0, const bool16 bNotify = kTrue) = 0;
 virtual ErrorCode ReplaceObjectStyles(IWorkspace* ws, const K2Vector<PMString>& stylesToBeReplaced, const PMString& sourceStyleName) = 0;

 virtual ErrorCode BreakLinkFromProvidedObjectStyles(IWorkspace* ws, const K2Vector<PMString>& styleNames) = 0;

 // Modified the style list, don't affect the selection.
 virtual ErrorCode DeleteObjectStyles(IWorkspace* ws, const K2Vector<PMString>& styleNames, const PMString& styleToReplaceWith, const bool16& bPerserveFormat = kFalse) = 0;
 virtual ErrorCode LoadObjectStyles(IWorkspace *ws, const bool16& overrideLocal, const IDFile& sourceFile,
 std::map<PMString,bool32> importMap,
 std::map<PMString,bool32> clashMap,
 std::map<PMString,StyleClashResolutionTypes::StyleClashResolutionStrategy> resolveMap,
 const StyleClashResolutionTypes::GlobalClashResolutionStrategy& globalClashResolutionStrategy) = 0;

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

 virtual ErrorCode ImportObjectStyles(IWorkspace *ws, const IDFile& sourceFile) = 0;

 virtual ErrorCode SortObjectStyles(IWorkspace *ws) = 0;
 
 virtual ErrorCode MoveObjectStyles( IWorkspace* ws, 
 const K2Vector<PMString>& selectedObjectStylesPaths, 
 const int32& dropBefore, 
 const UID newParent, 
 const RemappingList& remaplist,
 const IStyleRemapData::ConflictFlagEnum conflictFlag) = 0;

 virtual ErrorCode MoveObjectStyles( const UIDList& selectedObjectStyles, 
 const int32& dropBefore, 
 const UID newParent, 
 const RemappingList& remaplist,
 const IStyleRemapData::ConflictFlagEnum conflictFlag) = 0;
 virtual ErrorCode ChangeDefaultTextStyle(IWorkspace* ws, UID newDefaultStyleUID, bool16 bApplyAttrs = kFalse, bool16 bClearOverrides = kFalse) = 0;

 virtual ErrorCode ChangeDefaultFrameGridStyle(IWorkspace* ws, UID newDefaultStyleUID, bool16 bApplyAttrs = kFalse, bool16 bClearOverrides = kFalse) = 0;

 virtual ErrorCode RenameObjectStyle(IWorkspace* ws, const UID styleUID, const PMString& newName, const bool16 bNotify = kTrue) = 0;
 virtual ErrorCode DuplicateObjectStyles(IWorkspace* ws, const K2Vector<PMString>& styleNames, K2Vector<PMString>& namesCreated) = 0;
 virtual ErrorCode ChangeDefaultGraphicStyle(IWorkspace* ws, UID newDefaultStyleUID, bool16 bApplyAttrs = kFalse, bool16 bClearOverrides = kFalse) = 0; 

 virtual PMString GetDefaultGraphicStyle(IWorkspace* ws) = 0;

 virtual PMString GetDefaultTextStyle(IWorkspace* ws) = 0;

 virtual PMString GetDefaultFrameGridStyle(IWorkspace* ws) = 0;

 virtual ErrorCode CreateNewObjectStyleGroup(IWorkspace* ws, 
 const PMString newStyleGroupName, 
 const UID parent, 
 const int32 position) = 0;


 virtual ErrorCode RenameObjectStyleGroup(IWorkspace* ws, 
 const UID styleGroupUID, 
 const PMString& newName) = 0;

 virtual ErrorCode DuplicateObjectStyleGroups(const UIDList& styleGroups) = 0;

 virtual ErrorCode DeleteStyleGroups(const UIDList& styleGroups, const RemappingList& remaplist) = 0;


 virtual ErrorCode MoveStyleGroups( const UIDList& styleGroups,
 const UID newParent, 
 const int32 position, 
 const RemappingList& remaplist, 
 const IStyleRemapData::ConflictFlagEnum conflictFlag) = 0;
 
 virtual ErrorCode LoadObjectStyles
 (
 IWorkspace *ws,
 const bool16& overrideLocal,
 const std::string& sourceFile/*URI for cloud ID*/,
 std::map<PMString,bool32> importMap,
 std::map<PMString,bool32> clashMap,
 std::map<PMString,StyleClashResolutionTypes::StyleClashResolutionStrategy> resolveMap,
 const StyleClashResolutionTypes::GlobalClashResolutionStrategy& bLoadAllWithOverwrite
 )=0;
 virtual ErrorCode LoadObjectStyles(const std::string & assetData)=0;
 };
}
#endif // define