#include <IXMLCreateTableElementCmdData.h>

Inheritance diagram for IXMLCreateTableElementCmdData:

Public Types
enum	{ kDefaultIID = IID_IXMLCREATETABLEELEMENTCMDDATA }

Public Member Functions
virtual void	Set (const TableTagData &tableTagData, const UIDRef &storyUIDRef, TextIndex textIndex)=0

virtual void	Set (const TableTagData &tableTagData, const UIDRef &tableModelUIDRef)=0

virtual const XMLReference &	GetCreatedTableElement () const =0

virtual void	SetCreatedTableElement (const XMLReference &newItem)=0

virtual const TableTagData &	GetTableTagData () const =0

virtual const UIDRef &	GetTableModelUIDRef (void) const =0

virtual bool16	TagTableModelOnly (void) const =0

virtual void	SetTagTableModelOnly (bool16 tagTableModelOnly)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Data interface for adding table/table cell elements to the logical structure tree; if you're writing client code, use IXMLElementCommands and you won't need this interface.

Member Function Documentation

virtual const XMLReference& IXMLCreateTableElementCmdData::GetCreatedTableElement ( ) const

pure virtual

Accessor for the table element created, once command executed

Returns: the table element that was added (call this after the command is processed without error)

virtual const UIDRef& IXMLCreateTableElementCmdData::GetTableModelUIDRef ( void ) const

pure virtual

For use by the command only

Returns: UIDRef of table model to tag

virtual const TableTagData& IXMLCreateTableElementCmdData::GetTableTagData ( ) const

pure virtual

Used to get the table tag data for the command

Returns: the class that describes the tags to use when tagging this table

virtual void IXMLCreateTableElementCmdData::Set	(	const TableTagData &	tableTagData,
		const UIDRef &	storyUIDRef,
		TextIndex	textIndex
	)

pure virtual

Set the data through a text index, naming the tag to apply

Parameters

tableTagData	Information about the tags to use when tagging the table
storyUIDRef	UIDRef of the story containing the text index
textIndex	TextIndex of an insertion point in any cell of the table

virtual void IXMLCreateTableElementCmdData::Set	(	const TableTagData &	tableTagData,
		const UIDRef &	tableModelUIDRef
	)

pure virtual

Set the data through specifying a table model, naming the tag to apply

Parameters

tableTagData	Information about the tags to use when tagging the table
tableModelUIDRef	UIDRef of the table model to tag

virtual void IXMLCreateTableElementCmdData::SetCreatedTableElement ( const XMLReference & newItem )

pure virtual

For use by the command only; don't invoke from client code

Parameters

newItem [INTERNAL] don't set this from client code

virtual void IXMLCreateTableElementCmdData::SetTagTableModelOnly ( bool16 tagTableModelOnly )

pure virtual

For internal use only Set whether to tag the table model only (not the cells) NOTE: this will leave the table model in an inconsistent state. Do not use unless you really know what you are doing

Parameters

tagTableModelOnly whether to tag just the table model and not the cells

virtual bool16 IXMLCreateTableElementCmdData::TagTableModelOnly ( void ) const

pure virtual

For use by the command only

See Also: SetTagTableModelOnly()

Returns: whether to tag just the table model

Public Types

Public Member Functions

Detailed Description

Member Function Documentation