ITextVariable.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.
// 
// 
// The ITextVariable interface allows installable text variables.
// 
//========================================================================================

#ifndef __ITEXTVARIABLE__
#define __ITEXTVARIABLE__

#include "IPMUnknown.h"
#include "TextID.h"
#include "RequestContext.h"
#include "TextVariableInfo.h"

class PMString;
class IDataBase;

class ITextVariable : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTVARIABLE };

 enum ScopeStyles
 {
 kSection = 0,
 kDocument
 };

 enum UseStyles
 {
 kFirstInPage = 0,
 kLastInPage,
 };

 virtual const WideString& GetName() const =0;

 virtual void SetName(const WideString &s) =0;

 virtual const WideString& GetContents() = 0;

 virtual void SetContents(const WideString &s) = 0;

 virtual const ClassID GetBaseTypeID() const = 0;

 virtual void SetBaseTypeID(ClassID id) = 0;

 virtual const ClassID GetFormatterID() = 0;

 virtual void SetFormatterID(ClassID id)= 0;

 virtual const UID GetUID() const = 0;

 virtual void SetUID(UID uid) =0;

 virtual const WideString& GetTextBefore() = 0;

 virtual void SetTextBefore(const WideString &s) = 0;

 virtual const WideString& GetTextAfter() = 0;

 virtual void SetTextAfter(const WideString &s) = 0;

 virtual ScopeStyles GetScope() const = 0;

 virtual void SetScope(ScopeStyles scope) = 0;

 virtual UseStyles GetUse() const = 0;

 virtual void SetUse(UseStyles use) = 0;

 /* Get Delete End Punctuation
 */
 virtual bool16 GetDeleteEndPunctuation() const = 0;

 /* Set Delete End Punctuation
 */
 virtual void SetDeleteEndPunctuation(bool16 b) = 0;

 virtual bool16 GetIncludeExtension() const = 0;

 virtual void SetIncludePath(bool16 b) = 0;

 virtual bool16 GetIncludePath() const = 0;

 virtual void SetIncludeExtension(bool16 b) = 0;

 virtual bool16 GetEmperorDate() const = 0;

 virtual void SetEmperorDate(bool16 b) = 0;

 virtual int32 GetFlags() const = 0;

 virtual void SetFlags(int32 flags) = 0;

 virtual void VariableToString(const UIDRef& target, WideString& s, bool16 uniformApproximateWidth = kFalse) = 0;

 virtual void GetVariableTypeName(WideString &typeName) const = 0;

 virtual ScriptID GetTextVariableTypeScriptID( const ScriptInfo::RequestContext& context ) const = 0;

 virtual ScriptID GetTextVariableOptionsScriptID( const ScriptInfo::RequestContext& context ) const = 0;

 virtual ServiceID GetFormatterServiceProviderID() const = 0;

 virtual bool16 IsEquivalent(const ITextVariable *other) const = 0;

 virtual bool16 IsPrivate() const = 0;

 virtual void Get(AddVariableInfo& info) const = 0;

 virtual void Set(const AddVariableInfo& info) = 0;

};

#endif // __ITEXTVARIABLE__