InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IXMLTableParsingContext Class Referenceabstract

#include <IXMLTableParsingContext.h>

Inheritance diagram for IXMLTableParsingContext:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXMLTABLEPARSINGCONTEXT }
 

Public Member Functions

virtual void Set (IXMLTableParsingContext *tableContext)=0
 
virtual void Reset ()=0
 
virtual UIDRef GetTableRef () const =0
 
virtual void SetTableRef (const UIDRef &tableRef)=0
 
virtual RowRange GetTotalRows () const =0
 
virtual void SetTotalRows (int32 start, int32 count)=0
 
virtual RowRange GetHeaderRows () const =0
 
virtual void SetHeaderRows (int32 start, int32 count)=0
 
virtual RowRange GetFooterRows () const =0
 
virtual void SetFooterRows (int32 start, int32 count)=0
 
virtual GridCoord GetNumOfCols () const =0
 
virtual void SetNumOfCols (GridCoord numOfCols)=0
 
virtual GridCoord GetMaxNumOfCols () const =0
 
virtual void SetMaxNumOfCols (GridCoord maxNumOfCols)=0
 
virtual bool16 InTable () const =0
 
virtual void SetInTable (bool16 inTable)=0
 
virtual bool16 InHeader () const =0
 
virtual void SetInHeader (bool16 inHeader)=0
 
virtual bool16 InBody () const =0
 
virtual void SetInBody (bool16 inBody)=0
 
virtual bool16 InFooter () const =0
 
virtual void SetInFooter (bool16 inFooter)=0
 
virtual bool16 InRow () const =0
 
virtual void SetInRow (bool16 inRow)=0
 
virtual bool16 InCell () const =0
 
virtual void SetInCell (bool16 inCell)=0
 
virtual TextIndex GetInsertPos () const =0
 
virtual void SetInsertPos (TextIndex insertPos)=0
 
virtual bool16 InTableCell () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface for tracking table specific parsing context information when importing XML content.

This interface is an addin to the kXMLParserLocatorBoss.

Member Function Documentation

virtual RowRange IXMLTableParsingContext::GetFooterRows () const
pure virtual

Returns the number of footer rows that we have parsed so far.

virtual RowRange IXMLTableParsingContext::GetHeaderRows () const
pure virtual

Returns the range of header rows that we have parsed so far.

virtual TextIndex IXMLTableParsingContext::GetInsertPos () const
pure virtual

Returns the insertion position that was current before any table parsing occurred.

virtual GridCoord IXMLTableParsingContext::GetMaxNumOfCols () const
pure virtual

Returns the maximum number of columns that have been added to any row.

virtual GridCoord IXMLTableParsingContext::GetNumOfCols () const
pure virtual

Returns the number of columns that we have parsed so far.

virtual UIDRef IXMLTableParsingContext::GetTableRef () const
pure virtual

Returns the newly created table

virtual RowRange IXMLTableParsingContext::GetTotalRows () const
pure virtual

Returns the range of total rows that we have parsed so far.

virtual bool16 IXMLTableParsingContext::InBody () const
pure virtual

Returns kTrue if we are between tbody tags.

virtual bool16 IXMLTableParsingContext::InCell () const
pure virtual

Returns kTrue if we are between column tags.

virtual bool16 IXMLTableParsingContext::InFooter () const
pure virtual

Returns kTrue if we are between tfoot tags.

virtual bool16 IXMLTableParsingContext::InHeader () const
pure virtual

Returns kTrue if we are between thead tags.

virtual bool16 IXMLTableParsingContext::InRow () const
pure virtual

Returns kTrue if we are between row tags.

virtual bool16 IXMLTableParsingContext::InTable () const
pure virtual

Returns kTrue if we are between table tags.

virtual bool16 IXMLTableParsingContext::InTableCell () const
pure virtual

Returns kTrue if InTable, InRow, and InCell are true. This is a more strigent test of table location.

virtual void IXMLTableParsingContext::Reset ()
pure virtual

Reset the table context to its intial state.

virtual void IXMLTableParsingContext::Set (IXMLTableParsingContexttableContext)
pure virtual

Specify the context information by copying another context.

Parameters
tableContextThe table context to be copied.
virtual void IXMLTableParsingContext::SetFooterRows (int32 start,
int32 count 
)
pure virtual
Set the number of footer rows that have been parsed.

Parameters
startThe starting row number (zero based)
countThe count of rows from the start
virtual void IXMLTableParsingContext::SetHeaderRows (int32 start,
int32 count 
)
pure virtual
Set the number of header rows that have been parsed.

Parameters
startThe starting row number (zero based)
countThe count of rows from the start
virtual void IXMLTableParsingContext::SetInBody (bool16 inBody)
pure virtual
Specify whether we are between tbody tags or not.

Parameters
inBodykTrue if we are between tbody tags.
virtual void IXMLTableParsingContext::SetInCell (bool16 inCell)
pure virtual
Specify whether we are between column tags or not.

Parameters
inCellkTrue if we are between column tags.
virtual void IXMLTableParsingContext::SetInFooter (bool16 inFooter)
pure virtual
Specify whether we are between tfoot tags or not.

Parameters
inFooterkTrue if we are between tfoot tags.
virtual void IXMLTableParsingContext::SetInHeader (bool16 inHeader)
pure virtual
Specify whether we are between thead tags or not.

Parameters
inHeaderkTrue if we are between thead tags.
virtual void IXMLTableParsingContext::SetInRow (bool16 inRow)
pure virtual
Specify whether we are between row tags or not.

Parameters
inRowkTrue if we are between row tags.
virtual void IXMLTableParsingContext::SetInsertPos (TextIndex insertPos)
pure virtual
Specify the insertion position at the beginning of table parsing.

Parameters
insertPosThe insertion position.
virtual void IXMLTableParsingContext::SetInTable (bool16 inTable)
pure virtual
Specify whether we are between table tags or not.

Parameters
inTablekTrue if we are between table tags.
virtual void IXMLTableParsingContext::SetMaxNumOfCols (GridCoord maxNumOfCols)
pure virtual
Set the maximum number of columns that have been added to any row in the table.

Parameters
maxNumOfColsThe maximum number of columns.
virtual void IXMLTableParsingContext::SetNumOfCols (GridCoord numOfCols)
pure virtual
Set the number of columns that have been parsed.

Parameters
numOfColsThe number of columns that have been parsed.
virtual void IXMLTableParsingContext::SetTableRef (const UIDReftableRef)
pure virtual
Set the reference to the newly created table.

Parameters
tableRefA reference to a table object.
virtual void IXMLTableParsingContext::SetTotalRows (int32 start,
int32 count 
)
pure virtual
Set the number of total rows that have been parsed.

Parameters
startThe starting row number (zero based)
countThe count of rows from the start