ITextStylesFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Sanjay Kumar
// 
// $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 __ITEXTSTYLESFACADE__
#define __ITEXTSTYLESFACADE__

#include "IPMUnknown.h"
#include "TextID.h"

#include "IStyleRemapData.h"
#include "IStyleGroupHierarchy.h"
#include "keyboarddefs.h"
//-----------------------------------
// Forward References
//
class AttributeBossList;
class IWorkspace;
class IStyleInfo;

// ===================================================================================
// class ITextStylesFacade
// ===================================================================================
namespace Facade
{
 class ITextStylesFacade : public IPMUnknown
 {

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

 virtual ErrorCode CreateNewParagraphStyle( const AttributeBossList* attributeBossList,
 IWorkspace* ws,
 const PMString& newStyleName,
 UID basedOnUID,
 UID parent,
 UID* newStyleUID ) = 0;

 virtual ErrorCode CreateNewParagraphStyle( const AttributeBossList* attributeBossList,
 IWorkspace* ws,
 const PMString& newStyleName,
 UID basedOnUID,
 UID nextStyle,
 bool16 useDefaultsAttributes,
 bool16 isImported,
 const VirtualKey virtualKey,
 const int16 modifier,
 UID parent,
 UID* newStyleUID = nil,
 const int32 position = -1 ) = 0;

 virtual ErrorCode CreateNewCharacterStyle( const AttributeBossList* attributeBossList,
 IWorkspace* ws,
 const PMString& newStyleName,
 UID basedOnUID,
 UID parent,
 UID* newStyleUID ) = 0;

 virtual ErrorCode CreateNewCharacterStyle( const AttributeBossList* attributeBossList,
 IWorkspace* ws,
 const PMString& newStyleName,
 UID basedOnUID,
 bool16 useDefaultsAttributes,
 bool16 isImported,
 const VirtualKey virtualKey ,
 const int16 modifier ,
 UID parent ,
 UID* newStyleUID = nil,
 const int32 position = -1 ) = 0;

 virtual ErrorCode CreateNewParagraphStyleGroup(IWorkspace* ws,
 const PMString newStyleGroupName,
 UID parent,
 UID* newStyleGroupUID = nil,
 const int32 position = -1
 ) = 0;
 virtual ErrorCode CreateNewCharacterStyleGroup(IWorkspace* ws,
 const PMString newStyleGroupName,
 UID parent,
 UID* newStyleGroupUID = nil,
 const int32 position = -1
 ) = 0;

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

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

 virtual ErrorCode DeleteParagraphStyle( IWorkspace* ws,
 UID styleToDelete,
 UID styleToReplaceWith = kInvalidUID,
 bool16 preserveFormatting = kTrue) = 0;

 virtual ErrorCode DeleteCharacterStyle( IWorkspace* ws,
 UID styleToDelete,
 UID styleToReplaceWith = kInvalidUID,
 bool16 preserveFormatting = kTrue) = 0;

 virtual ErrorCode DeleteParagraphStyleGroups( IWorkspace* ws,
 const K2Vector<UID>& styleGroups,
 const RemappingList& remaplist) = 0;

 virtual ErrorCode DeleteCharacterStyleGroups( IWorkspace* ws,
 const K2Vector<UID>& styleGroups,
 const RemappingList& remaplist) = 0;

 virtual ErrorCode MoveTextStyles( IWorkspace* ws,
 const K2Vector<UID>& styles,
 UID newParent,
 const int32 position,
 const RemappingList& remapList,
 const IStyleRemapData::ConflictFlagEnum conflictFlag) = 0;

 virtual ErrorCode MoveTextStyleGroups( IWorkspace* ws,
 const K2Vector<UID>& styleGroups,
 UID newParent,
 const int32 position,
 const RemappingList& remapList,
 const IStyleRemapData::ConflictFlagEnum conflictFlag) = 0;

 virtual ErrorCode EditTextStyle(const AttributeBossList* newAtributeBossList,
 const IStyleInfo* newStyleInfo,
 const IWorkspace* ws,
 UID styleToEdit,
 const bool16 bNotify = kTrue) = 0;

 virtual ErrorCode SortParagraphStyles( IWorkspace *ws,
 IStyleGroupHierarchy::SortFlag sortFlag = IStyleGroupHierarchy::kSortAscendingHierarchy ) = 0;

 virtual ErrorCode SortCharacterStyles( IWorkspace *ws,
 IStyleGroupHierarchy::SortFlag sortFlag = IStyleGroupHierarchy::kSortAscendingHierarchy ) = 0;


 virtual ErrorCode ChangeDefaultParagraphStyle( IWorkspace* ws,
 UID newDefaultStyleUID) = 0;

 virtual ErrorCode ChangeDefaultCharacterStyle( IWorkspace* ws,
 UID newDefaultStyleUID) = 0;

 virtual ErrorCode DuplicateTextStyles( IWorkspace* ws,
 const K2Vector<UID>& stylesToDuplicate) = 0;

 virtual ErrorCode DuplicateTextStyleGroups( IWorkspace* ws,
 const K2Vector<UID>& styleGroupsToDuplicate) = 0;

 };
}
#endif // define __ITEXTSTYLESFACADE__