AddVariableInfo Class Reference

#include <TextVariableInfo.h>

Public Types
enum	ScopeStyles { kSection = 0, kDocument }
enum	UseStyles { kFirstInPage = 0, kLastInPage }
typedef object_type	data_type

Public Member Functions
bool16	operator== (const AddVariableInfo &other) const
bool16	operator!= (const AddVariableInfo &other) const
const WideString &	GetName () const
void	SetName (const WideString &s)
const WideString &	GetContents () const
void	SetContents (const WideString &s)
const ClassID	GetBaseTypeID () const
void	SetBaseTypeID (ClassID id)
const ClassID	GetFormatterID () const
void	SetFormatterID (ClassID id)
const UID	GetUID () const
void	SetUID (UID uid)
int32	GetFlags () const
void	SetFlags (int32 b)
const WideString &	GetTextBefore () const
void	SetTextBefore (const WideString &s)
const WideString &	GetTextAfter () const
void	SetTextAfter (const WideString &s)
ScopeStyles	GetScope () const
void	SetScope (AddVariableInfo::ScopeStyles scope)
UseStyles	GetUse () const
void	SetUse (AddVariableInfo::UseStyles use)
bool16	GetDeleteEndPunctuation () const
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)

Friends
class	TextVariableImpl

Detailed Description

Variable information for adding a new variable to the table of variables.

Member Enumeration Documentation

enum AddVariableInfo::ScopeStyles

Helper enum for the scope types of the TotalPagesVariable's flags

enum AddVariableInfo::UseStyles

Helper enum for the bit types of the Char/ParaVariable's flags

Member Function Documentation

const ClassID AddVariableInfo::GetBaseTypeID ( ) const

inline

Get class id of the base variable (e.g. Custom Text Variable, Date Variable, etc)

const WideString& AddVariableInfo::GetContents ( ) const

inline

Gets contents

Note

Often empty

bool16 AddVariableInfo::GetEmperorDate

(

)

const

Get Emperor Date

int32 AddVariableInfo::GetFlags ( ) const

inline

Get Flags (generally recommend using flag getters instead as this contains variable specific flags)

const ClassID AddVariableInfo::GetFormatterID ( ) const

inline

Get class that can format this variable

bool16 AddVariableInfo::GetIncludeExtension

(

)

const

Get Include path extension

bool16 AddVariableInfo::GetIncludePath

(

)

const

Get Include Path

ScopeStyles AddVariableInfo::GetScope

(

)

const

Get Scope

const WideString& AddVariableInfo::GetTextAfter ( ) const

inline

Get string to place after the calculated part of the variable.

const WideString& AddVariableInfo::GetTextBefore ( ) const

inline

Get string to place before the calculated part of the variable.

const UID AddVariableInfo::GetUID ( ) const

inline

Get uid of desired style (running header footer only)

UseStyles AddVariableInfo::GetUse

(

)

const

Get Use

bool16 AddVariableInfo::operator==

(

const AddVariableInfo &

other

)

const

equality

void AddVariableInfo::SetBaseTypeID ( ClassID  id )

inline

Set class id of the base variable (e.g. Custom Text Variable, Date Variable, etc)

void AddVariableInfo::SetContents ( const WideString &  s )

inline

Sets contents

void AddVariableInfo::SetEmperorDate

(

bool16

b

)

Set Emperor Date

void AddVariableInfo::SetFlags ( int32  b )

inline

Set Flags (generally recommend using flag setters instead)

void AddVariableInfo::SetFormatterID ( ClassID  id )

inline

Set formmater ID

void AddVariableInfo::SetIncludeExtension

(

bool16

b

)

Set Include Path

void AddVariableInfo::SetIncludePath

(

bool16

b

)

Set Include path extension

void AddVariableInfo::SetName ( const WideString &  s )

inline

Sets name

void AddVariableInfo::SetScope

(

AddVariableInfo::ScopeStyles

scope

)

Set Scope

void AddVariableInfo::SetTextAfter ( const WideString &  s )

inline

Set string to place after the calculated part of the variable.

void AddVariableInfo::SetTextBefore ( const WideString &  s )

inline

Set string to place before the calculated part of the variable.

void AddVariableInfo::SetUID ( UID  uid )

inline

Set uid of desired style (running header footer only)

void AddVariableInfo::SetUse

(

AddVariableInfo::UseStyles

use

)

Set Use