ITextVariableTable.h

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

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

class ITextVariable;
class WideString;
class VariableTypeInfo;
class AddVariableInfo;
class ChangeVariableInfo;

class ITextVariableTable : public IPMUnknown // ##rk: this can go to private..
{
public:
 enum { kDefaultIID = IID_ITEXTVARIABLETABLE };
 static const int32 kInvalidIndex = -1;

 virtual UID LookupVariableUID(const WideString& varName) = 0;

 virtual bool16 GetBaseTypeInfo(ClassID variableClassID, VariableTypeInfo* varInfo) const = 0;

 virtual int32 GetNumVariables() const = 0;

 virtual ITextVariable* QueryNthVariable(int32 n) const = 0;

 virtual ITextVariable* QueryVariable(const WideString& varName) const = 0;

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

 virtual bool16 AddVariable(UID newUID) = 0;

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

 virtual bool16 ChangeVariable(const WideString& varName, const ChangeVariableInfo& chgInfo) = 0;
 virtual bool16 GetNthVariableObsolete(int32 n, AddVariableInfo* varInfo) const = 0;
};

#endif // __ICalcTextVarTable__