fd_Field Class Reference

#include <fd_Field.h>

List of all members.

Public Types
enum	FieldType {   FD_None, FD_Test, FD_MartinTest, FD_Time,   FD_PageNumber, FD_PageCount, FD_ListLabel, FD_FileName,   FD_Date, FD_Date_MMDDYY, FD_Date_DDMMYY, FD_Date_MDY,   FD_Date_MthDY, FD_Date_DFL, FD_Date_NTDFL, FD_Date_Wkday,   FD_Date_DOY, FD_Time_MilTime, FD_Time_AMPM, FD_Time_Zone,   FD_Time_Epoch, FD_Table_sum_rows, FD_Table_sum_cols, FD_DateTime_Custom,   FD_Doc_WordCount, FD_Doc_CharCount, FD_Doc_LineCount, FD_Doc_ParaCount,   FD_Doc_NbspCount, FD_App_Version, FD_App_ID, FD_App_Options,   FD_App_Target, FD_App_CompileTime, FD_App_CompileDate, FD_Endnote_Ref,   FD_Endnote_Anchor, FD_Footnote_Ref, FD_Footnote_Anchor, FD_PageReference,   FD_MailMerge, FD_Meta_Title, FD_Meta_Creator, FD_Meta_Subject,   FD_Meta_Publisher, FD_Meta_Date, FD_Meta_Date_Last_Changed, FD_Meta_Type,   FD_Meta_Language, FD_Meta_Rights, FD_Meta_Keywords, FD_Meta_Contributor,   FD_Meta_Coverage, FD_Meta_Description, __last_field_dont_use__ }
Public Member Functions
	fd_Field (pf_Frag_Object &fO, pt_PieceTable *pt, FieldType fieldType, const gchar *pParam)
virtual	~fd_Field (void)
bool	update (void)
void	setBlock (fl_BlockLayout *pBlock)
fl_BlockLayout *	getBlock (void) const
FieldType	getFieldType (void) const
gchar *	getValue (void) const
void	setValue (const gchar *szValue)
const gchar *	getParameter (void) const
Protected Member Functions
bool	_deleteSpan (void)
void	_throwChangeRec (PT_DocPosition docPos)
Protected Attributes
fl_BlockLayout *	m_pBlock
Private Attributes
pf_Frag_Object &	m_fragObject
pt_PieceTable *	m_pPieceTable
UT_uint32	m_updateCount
FieldType	m_iFieldType
gchar *	m_szValue
gchar *	m_pParameter

---

Detailed Description

Note:

This class will eventually have subclasses to implement the different types of fields.

---

Member Enumeration Documentation

enum fd_Field::FieldType

Enumerator:

FD_None
FD_Test
FD_MartinTest
FD_Time
FD_PageNumber
FD_PageCount
FD_ListLabel
FD_FileName
FD_Date
FD_Date_MMDDYY
FD_Date_DDMMYY
FD_Date_MDY
FD_Date_MthDY
FD_Date_DFL
FD_Date_NTDFL
FD_Date_Wkday
FD_Date_DOY
FD_Time_MilTime
FD_Time_AMPM
FD_Time_Zone
FD_Time_Epoch
FD_Table_sum_rows
FD_Table_sum_cols
FD_DateTime_Custom
FD_Doc_WordCount
FD_Doc_CharCount
FD_Doc_LineCount
FD_Doc_ParaCount
FD_Doc_NbspCount
FD_App_Version
FD_App_ID
FD_App_Options
FD_App_Target
FD_App_CompileTime
FD_App_CompileDate
FD_Endnote_Ref
FD_Endnote_Anchor
FD_Footnote_Ref
FD_Footnote_Anchor
FD_PageReference
FD_MailMerge
FD_Meta_Title
FD_Meta_Creator
FD_Meta_Subject
FD_Meta_Publisher
FD_Meta_Date
FD_Meta_Date_Last_Changed
FD_Meta_Type
FD_Meta_Language
FD_Meta_Rights
FD_Meta_Keywords
FD_Meta_Contributor
FD_Meta_Coverage
FD_Meta_Description
__last_field_dont_use__

---

Constructor & Destructor Documentation

fd_Field::fd_Field	(	pf_Frag_Object &	fO,
		pt_PieceTable *	pt,
		FieldType	fieldType,
		const gchar *	pParam
	)

References m_pBlock, m_pParameter, and m_szValue.

fd_Field::~fd_Field

(

void

)

[virtual]

References FREEP, m_pParameter, and m_szValue.

---

Member Function Documentation

bool fd_Field::_deleteSpan

(

void

)

[protected]

References pt_PieceTable::deleteFieldFrag(), pf_Frag::getField(), pf_Frag::getNext(), pf_Frag::getType(), m_fragObject, m_pPieceTable, and pf_Frag::PFT_Text.

Referenced by update().

void fd_Field::_throwChangeRec

(

PT_DocPosition

docPos

)

[protected]

References pt_PieceTable::getDocument(), pf_Frag::getIndexAP(), pt_PieceTable::getStruxOfTypeFromPosition(), pf_Frag::getXID(), m_pPieceTable, PD_Document::notifyListeners(), PTX_Block, and PX_ChangeRecord::PXT_UpdateField.

Referenced by update().

fl_BlockLayout * fd_Field::getBlock

(

void

)

const

References m_pBlock.

fd_Field::FieldType fd_Field::getFieldType

(

void

)

const

References m_iFieldType.

Referenced by pf_Frag_Object::_isContentEqual(), PL_Psion_Listener::populate(), and IE_Exp_OpenXML_Listener::populate().

const gchar* fd_Field::getParameter

(

void

)

const [inline]

References gchar.

Referenced by fp_FieldMailMergeRun::calculateValue(), and fp_FieldDateTimeCustomRun::calculateValue().

gchar * fd_Field::getValue

(

void

)

const

References m_szValue.

Referenced by s_XSL_FO_Listener::_handleField(), s_WML_Listener::_handleField(), s_DocBook_Listener::_handleField(), ODe_AbiDocListener::_openField(), IE_Exp_HTML_Listener::_openField(), Text_Listener::populate(), IE_Exp_OpenXML_Listener::populate(), and s_LaTeX_Listener::populate().

void fd_Field::setBlock

(

fl_BlockLayout *

pBlock

)

References m_pBlock.

Referenced by fp_FieldRun::_lookupProperties().

void fd_Field::setValue

(

const gchar *

szValue

)

References FREEP, and m_szValue.

Referenced by fp_FieldMetaRun::calculateValue(), fp_FieldMailMergeRun::calculateValue(), fp_FieldPageCountRun::calculateValue(), fp_FieldPageReferenceRun::calculateValue(), fp_FieldPageNumberRun::calculateValue(), fp_FieldShortFileNameRun::calculateValue(), fp_FieldFileNameRun::calculateValue(), fp_FieldDateRun::calculateValue(), fp_FieldTimeRun::calculateValue(), fp_FieldBuildCompileTimeRun::calculateValue(), fp_FieldBuildCompileDateRun::calculateValue(), fp_FieldBuildTargetRun::calculateValue(), fp_FieldBuildOptionsRun::calculateValue(), fp_FieldBuildVersionRun::calculateValue(), fp_FieldBuildIdRun::calculateValue(), fp_FieldTimeZoneRun::calculateValue(), fp_FieldDateTimeCustomRun::calculateValue(), fp_FieldTimeEpochRun::calculateValue(), fp_FieldAMPMRun::calculateValue(), fp_FieldMilTimeRun::calculateValue(), fp_FieldDOYRun::calculateValue(), fp_FieldWkdayRun::calculateValue(), fp_FieldDefaultDateNoTimeRun::calculateValue(), fp_FieldDefaultDateRun::calculateValue(), fp_FieldMthDayYearRun::calculateValue(), fp_FieldMonthDayYearRun::calculateValue(), fp_FieldDDMMYYRun::calculateValue(), fp_FieldMMDDYYRun::calculateValue(), fp_FieldWordCountRun::calculateValue(), fp_FieldParaCountRun::calculateValue(), fp_FieldLineCountRun::calculateValue(), fp_FieldNonBlankCharCountRun::calculateValue(), and fp_FieldCharCountRun::calculateValue().

bool fd_Field::update

(

void

)

References _deleteSpan(), _throwChangeRec(), FD_MartinTest, FD_None, FD_Test, pt_PieceTable::getFragPosition(), pf_Frag::getLength(), pt_PieceTable::insertSpan(), m_fragObject, m_iFieldType, m_pPieceTable, m_updateCount, UT_UCS4_strcpy_char(), and UT_UCS4_strlen().

Referenced by FV_View::_insertField(), and PD_Document::updateFields().

---

Member Data Documentation

pf_Frag_Object& fd_Field::m_fragObject [private]

Referenced by _deleteSpan(), and update().

FieldType fd_Field::m_iFieldType [private]

Referenced by getFieldType(), and update().

fl_BlockLayout* fd_Field::m_pBlock [protected]

Referenced by fd_Field(), getBlock(), and setBlock().

gchar* fd_Field::m_pParameter [private]

Referenced by fd_Field(), and ~fd_Field().

pt_PieceTable* fd_Field::m_pPieceTable [private]

Referenced by _deleteSpan(), _throwChangeRec(), and update().

gchar* fd_Field::m_szValue [private]

Referenced by fd_Field(), getValue(), setValue(), and ~fd_Field().

UT_uint32 fd_Field::m_updateCount [private]

Referenced by update().

---

The documentation for this class was generated from the following files:

• fd_Field.h
• fd_Field.cpp