TextVariableInfo.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 _TextVariableInfo_
#define _TextVariableInfo_

class AddVariableInfo
{
private:
 void Init();

 friend class TextVariableImpl;

 WideString name;
 WideString contents;
 ClassID baseTypeID;
 ClassID formatterID;
 UID fuid;
 int32 flags;
 WideString textBefore;
 WideString textAfter;

 void ReadWrite(IPMStream *s, ImplementationID prop);

public:
 AddVariableInfo();

 bool16 operator== (const AddVariableInfo &other) const;
 bool16 operator!= (const AddVariableInfo &other) const;

 enum ScopeStyles
 {
 kSection = 0,
 kDocument
 };

 enum UseStyles
 {
 kFirstInPage = 0,
 kLastInPage,
 };

 const WideString& GetName() const {return name;}
 void SetName(const WideString &s) {name = s;}
 const WideString& GetContents() const {return contents;}
 void SetContents(const WideString &s) {contents = s;}
 const ClassID GetBaseTypeID() const {return baseTypeID;}
 void SetBaseTypeID(ClassID id) {baseTypeID = id;}
 const ClassID GetFormatterID() const {return formatterID;}
 void SetFormatterID(ClassID id) {formatterID = id;}
 const UID GetUID() const {return fuid;}
 void SetUID(UID uid) {fuid = uid;}
 int32 GetFlags() const {return flags;}
 void SetFlags(int32 b) {flags = b;}
 const WideString& GetTextBefore() const {return textBefore;}
 void SetTextBefore(const WideString &s) {textBefore = s;}
 const WideString& GetTextAfter() const {return textAfter;}
 void SetTextAfter(const WideString &s) {textAfter = s;}
 ScopeStyles GetScope() const;
 void SetScope(AddVariableInfo::ScopeStyles scope);
 UseStyles GetUse() const;
 void SetUse(AddVariableInfo::UseStyles use);
 /* Get Delete End Punctuation
 */
 bool16 GetDeleteEndPunctuation() const;
 /* Set Delete End Punctuation
 */
 void SetDeleteEndPunctuation(bool16 b);
 bool16 GetIncludeExtension() const;
 void SetIncludePath(bool16 b);
 bool16 GetIncludePath() const;
 void SetIncludeExtension(bool16 b);
 bool16 GetEmperorDate() const;
 void SetEmperorDate(bool16 b);

 typedef object_type data_type;
};

#endif // _TextVariableInfo_