Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes

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__
}
typedef enum fd_Field::_FieldType FieldType

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_BlockLayoutgetBlock (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_BlockLayoutm_pBlock

Private Attributes

pf_Frag_Objectm_fragObject
pt_PieceTablem_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 Typedef Documentation


Member Enumeration Documentation

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]
void fd_Field::_throwChangeRec ( PT_DocPosition  docPos  )  [protected]
fl_BlockLayout * fd_Field::getBlock ( void   )  const

References m_pBlock.

fd_Field::FieldType fd_Field::getFieldType ( void   )  const
const gchar* fd_Field::getParameter ( void   )  const [inline]
gchar * fd_Field::getValue ( void   )  const
void fd_Field::setBlock ( fl_BlockLayout pBlock  ) 

References m_pBlock.

Referenced by fp_FieldRun::_lookupProperties().

void fd_Field::setValue ( const gchar *  szValue  ) 
bool fd_Field::update ( void   ) 

Member Data Documentation

Referenced by _deleteSpan(), and update().

Referenced by getFieldType(), and update().

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

gchar* fd_Field::m_pParameter [private]

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

gchar* fd_Field::m_szValue [private]

Referenced by update().


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