ITextVariableSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: rkamicar
// 
// $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:
// 
//========================================================================================

#ifndef _ITextVariableSuite_
#define _ITextVariableSuite_

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

class ModelRange;
class UIDRef;
class IOwnedItem;
class AddVariableInfo;
class VariableTypeInfo;
class ChangeVariableInstanceInfo;
class ChangeVariableInfo;
class IDFile;
#include "ITextVariable.h"

class ITextVariableSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTVARIABLE_ISUITE };

 virtual bool16 CanInsertTextVariable(void) const = 0;

 virtual bool16 CanManageTextVariables(void) const = 0;

 virtual ErrorCode ManageVariables() = 0;

 virtual ErrorCode GetVariableTypeInfo(ClassID variableClassID, VariableTypeInfo* typeInfo) const = 0;

 virtual ErrorCode AddVariable(const AddVariableInfo& newInfo) const = 0;

 virtual ErrorCode RemoveVariable(const WideString& varName) const = 0;

 virtual ErrorCode InsertVariable(const WideString& varName, UIDRef* newVarInstance) const = 0;

 virtual ErrorCode ChangeVariable(const WideString& varName, const ChangeVariableInfo& chgInfo) const = 0;

 virtual ErrorCode FindLocationsUsed(const WideString* varName, const ModelRange* searchRange, bool16 hiddenStories, K2Vector<ModelRange>& results) const = 0;

 virtual ErrorCode ChangeVariableInstance(IOwnedItem* ownedItem, const ChangeVariableInstanceInfo& chgInfo) const = 0;

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

#endif // _ITextVariableSuite_