#include <IXMLCreateElementCmdData.h>

Inheritance diagram for IXMLCreateElementCmdData:

Public Types
enum	{ kDefaultIID = IID_IXMLCREATEELEMENTCMDDATA }

Public Member Functions
virtual void	Set (const WideString &tagToApply, UIDRef storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex, const XMLReference &parentXMLRef=kInvalidXMLReference)=0

virtual void	Set (UID tagToApply, UIDRef storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex, const XMLReference &parentXMLRef=kInvalidXMLReference)=0

virtual void	Set (const WideString &tagToApply, UID contentItem, const XMLReference &parentXMLRef, int32 indexInParent)=0

virtual void	Set (UID tagToApply, UID contentItem, const XMLReference &parentXMLRef, int32 indexInParent)=0

virtual void	Set (const WideString &tagToApply, const UIDRef &table, GridID anchor, const GridSpan &span)=0

virtual void	Set (UID tagToApply, const UIDRef &table, GridID anchor, const GridSpan &span)=0

virtual void	Set (const WideString &tagToApply, const UIDRef &tableModelUIDRef, GridID cellGridID)=0

virtual void	Set (UID tagToApply, const UIDRef &tableModelUIDRef, GridID cellGridID)=0

virtual void	Set (const WideString &tagToApply, const XMLReference &parentXMLRef, int32 indexInParent)=0

virtual void	Set (UID tagToApply, const XMLReference &parentXMLRef, int32 indexInParent)=0

virtual void	Set (UID tagToApply, const UIDRef &storyUIDRef, UID contentItem, bool16 addToDocRefList)=0

virtual const XMLReference &	GetCreatedElement () const =0

virtual void	SetCreatedElement (const XMLReference &newItem)=0

virtual bool16	UsedTableSet () const =0

virtual bool16	UsedTextSet () const =0

virtual bool16	UsedTableCellSet () const =0

virtual bool16	UsedStructuralSet () const =0

virtual void	SetSetMethod (bool16 usedTextSet)=0

virtual UID	GetTag () const =0

virtual UIDRef	GetStoryUIDRef () const =0

virtual void	SetStoryUIDRef (const UIDRef &storyUIDRef)=0

virtual TextIndex	GetStartTextIndex () const =0

virtual TextIndex	GetEndTextIndex () const =0

virtual const UIDRef &	GetTable () const =0

virtual GridID	GetAnchor () const =0

virtual const GridSpan &	GetSpan () const =0

virtual void	SetTextRange (TextIndex startTextIndex, TextIndex endTextIndex)=0

virtual const XMLReference &	GetParent () const =0

virtual void	SetParent (const XMLReference &parentXMLRef)=0

virtual bool16	GetAddToDocRefList () const =0

virtual int32	GetIndexInParent () const =0

virtual void	SetIndexInParent (int32 indexInParent)=0

virtual UID	GetContentItem () const =0

virtual void	SetContentItem (UID contentItemUID)=0

virtual ClassID	GetBossID () const =0

virtual void	SetBossID (ClassID bossID)=0

virtual bool16	IsTextOnPathInline () const =0

virtual void	SetTextOnPathInline (bool16 isTOP)=0

virtual bool16	DoInlineCheck () const =0

virtual void	SetDoInlineCheck (bool16 doInlineCheck)=0

virtual bool16	DoForwardCalcXMLParent () const =0

virtual void	SetDoForwardCalcXMLParent (bool16 forwardCalcXMLParent)=0

virtual bool16	UseExistingMarkers () const =0

virtual void	SetUseExistingMarkers (const bool16 shouldUse)=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 elements to the logical structure tree; if you're writing client code, use IXMLElementCommands and you won't need this interface.

Similar to IHierarchyCmdData, but handles adding only one element at a time.

Member Function Documentation

virtual bool16 IXMLCreateElementCmdData::DoForwardCalcXMLParent ( ) const

pure virtual

For use by the command only. Return whether the cmd should use forward traverse version of CalcXMLParent. Default is kFalse

virtual bool16 IXMLCreateElementCmdData::DoInlineCheck ( ) const

pure virtual

For use by the command only. Return whether the cmd should hook up the item as an inline (if it is an inline). This is an override to handle the case where the item is an inline, but is being hooked up as a child of a TOP inline.

Returns: bool16 kTrue if inline check enabled, kFalse otherwise

virtual bool16 IXMLCreateElementCmdData::GetAddToDocRefList ( ) const

pure virtual

For use by the command only.

Returns: whether to add the new element to the IXMLReferenceListData on the document.

virtual GridID IXMLCreateElementCmdData::GetAnchor ( ) const

pure virtual

For use by the command only.

Returns: the first cell in the range to tag

virtual ClassID IXMLCreateElementCmdData::GetBossID ( ) const

pure virtual

For use by the command only.

Returns: boss ClassID for the new element

virtual UID IXMLCreateElementCmdData::GetContentItem ( ) const

pure virtual

For use by the command only.

Returns: UID of the item where the content will appear

virtual const XMLReference& IXMLCreateElementCmdData::GetCreatedElement ( ) const

pure virtual

Accessor for element created, once command executed.

Returns: the item that was added (call this after the command is processed)

virtual TextIndex IXMLCreateElementCmdData::GetEndTextIndex ( ) const

pure virtual

For use by the command only

Returns: TextIndex end of text range to be tagged

virtual int32 IXMLCreateElementCmdData::GetIndexInParent ( ) const

pure virtual

For use by the command only.

Returns: the index within the parent's list of children

virtual const XMLReference& IXMLCreateElementCmdData::GetParent ( ) const

pure virtual

For use by the command only.

Returns: the parent element for the new item

virtual const GridSpan& IXMLCreateElementCmdData::GetSpan ( ) const

pure virtual

For use by the command only

Returns: last cell of the range to be tagged

virtual TextIndex IXMLCreateElementCmdData::GetStartTextIndex ( ) const

pure virtual

For use by the command only.

Returns: the text range to tag

virtual UIDRef IXMLCreateElementCmdData::GetStoryUIDRef ( ) const

pure virtual

For use by the command only.

Returns: UIDRef of story stored on this interface

virtual const UIDRef& IXMLCreateElementCmdData::GetTable ( ) const

pure virtual

For use by the command only.

Returns: the first cell in the range to tag

virtual UID IXMLCreateElementCmdData::GetTag ( ) const

pure virtual

For use by the command only

Returns: the XML tag that will be applied to the new item.

virtual bool16 IXMLCreateElementCmdData::IsTextOnPathInline ( ) const

pure virtual

For use by the command only. Return whether this content is text on a path content

Returns: bool16 kTrue if is text on path

virtual void IXMLCreateElementCmdData::Set	(	const WideString &	tagToApply,
		UIDRef	storyUIDRef,
		TextIndex	startTextIndex,
		TextIndex	endTextIndex,
		const XMLReference &	parentXMLRef = `kInvalidXMLReference`
	)

pure virtual

Set the data through a text range, naming the tag.

Parameters

tagToApply	tag to apply to the element tag to apply to the element
storyUIDRef	UIDRef of the story containing the text UIDRef of the story containing the text
startTextIndex	TextIndex of the text to start tagging TextIndex of the text to start tagging
endTextIndex	TextIndex of the last character to tag TextIndex of the last character to tag
parentXMLRef	if the story isn't tagged (i.e. backing store), may pass in an ancestor reference for structure position calculations

virtual void IXMLCreateElementCmdData::Set	(	UID	tagToApply,
		UIDRef	storyUIDRef,
		TextIndex	startTextIndex,
		TextIndex	endTextIndex,
		const XMLReference &	parentXMLRef = `kInvalidXMLReference`
	)

pure virtual

Set the data through a text range, passing UID of tag to apply

Parameters

tagToApply	tag to apply to the element
storyUIDRef	UIDRef of the story containing the text
startTextIndex	TextIndex of the text to start tagging
endTextIndex	TextIndex of the last character to tag
parentXMLRef	if the story isn't tagged (i.e. backing store), may pass in an ancestor reference for structure position calculations

virtual void IXMLCreateElementCmdData::Set	(	const WideString &	tagToApply,
		UID	contentItem,
		const XMLReference &	parentXMLRef,
		int32	indexInParent
	)

pure virtual

Set data through specifying UID of content item, e.g. frame, naming tag to use.

Parameters

tagToApply	tag to apply to the element
contentItem	content item in the layout view which will represent the content, or the frame UID
parentXMLRef	the parent element
indexInParent	the index within the parent's list of child elements

virtual void IXMLCreateElementCmdData::Set	(	UID	tagToApply,
		UID	contentItem,
		const XMLReference &	parentXMLRef,
		int32	indexInParent
	)

pure virtual

Set data through specifying UID of content item, e.g. frame, giving UID of tag (IXMLTag) to use.

Parameters

tagToApply	tag to apply to the element
contentItem	content item in the layout view which will represent the content, or the frame UID
parentXMLRef	the parent element
indexInParent	the index within the parent's list of child elements

virtual void IXMLCreateElementCmdData::Set	(	const WideString &	tagToApply,
		const UIDRef &	table,
		GridID	anchor,
		const GridSpan &	span
	)

pure virtual

Set data through specifying a range of cells, naming tag to use.

Parameters

tagToApply	tag to apply to the element
table	UIDRef of table model containing the cells
anchor	GridID of anchor cell in grid area
span	size of grid area to tag

virtual void IXMLCreateElementCmdData::Set	(	UID	tagToApply,
		const UIDRef &	table,
		GridID	anchor,
		const GridSpan &	span
	)

pure virtual

Set data through specifying a range of cells, giving UID of tag (IXMLTag) to use.

Parameters

tagToApply	tag to apply to the element
table	UIDRef of table model containing the cells
anchor	GridID of anchor cell in grid area
span	size of grid area to tag

virtual void IXMLCreateElementCmdData::Set	(	const WideString &	tagToApply,
		const UIDRef &	tableModelUIDRef,
		GridID	cellGridID
	)

pure virtual

Set data through specifying a cell, naming tag to use

Parameters

tagToApply	tag to apply to the element
tableModelUIDRef	UIDRef of table model containing the cell
cellGridID	GridID of cell to tag

virtual void IXMLCreateElementCmdData::Set	(	UID	tagToApply,
		const UIDRef &	tableModelUIDRef,
		GridID	cellGridID
	)

pure virtual

Set data through specifying a cell, giving UID of tag (IXMLTag) to use.

Parameters

tagToApply	tag to apply to the element
tableModelUIDRef	UIDRef of table model containing the cell
cellGridID	GridID of cell to tag

virtual void IXMLCreateElementCmdData::Set	(	const WideString &	tagToApply,
		const XMLReference &	parentXMLRef,
		int32	indexInParent
	)

pure virtual

Set data through specifying a parent and child index. Note that this will create a structural only, no content associated element NOTE: this is limited use only. Do not use unless absolutely necessary

Parameters

tagToApply	tag to apply to the element
parentXMLRef	XMLReference of the parent element
indexInParent	child index under parentXMLRef the new element should be

virtual void IXMLCreateElementCmdData::Set	(	UID	tagToApply,
		const XMLReference &	parentXMLRef,
		int32	indexInParent
	)

pure virtual

Set data through specifying a parent and child index. Note that this will create a structural only, no content associated element NOTE: this is limited use only. Do not use unless absolutely necessary

Parameters

tagToApply	tag to apply to the element
parentXMLRef	XMLReference of the parent element
indexInParent	child index under parentXMLRef the new element should be

virtual void IXMLCreateElementCmdData::Set	(	UID	tagToApply,
		const UIDRef &	storyUIDRef,
		UID	contentItem,
		bool16	addToDocRefList
	)

pure virtual

Set data through specifying a story and the content item. Since no parent element is specified, the created element is not added to XML structure. The caller is responsible for maintaining the new element. NOTE: this is limited use only. Do not use unless absolutely necessary

Parameters

tagToApply	tag to apply to the element
storyUIDRef	UIDRef of the story containing the element
contentItem	content item in the layout view which will represent the content addToDocRefList If kTrue, the created element is added to the IXMLReferenceListData on the document.

virtual void IXMLCreateElementCmdData::SetBossID ( ClassID bossID )

pure virtual

For use by the command only.

Parameters

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

virtual void IXMLCreateElementCmdData::SetContentItem ( UID contentItemUID )

pure virtual

For use by the command only.

Parameters

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

virtual void IXMLCreateElementCmdData::SetCreatedElement ( 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 IXMLCreateElementCmdData::SetDoForwardCalcXMLParent ( bool16 forwardCalcXMLParent )

pure virtual

For use by the command only. CalcXMLParent is optimized for append cases, so it traverses in reverse order to find data faster. However, if this command is used to build XML structure in the reverse order, reverse traversal could slow things down, as data is now usually found at the end of the iterations. Use this method to tell the command to use forward traversal version of CalcXMLParent instead. Default is kFalse

virtual void IXMLCreateElementCmdData::SetDoInlineCheck ( bool16 doInlineCheck )

pure virtual

For use by the command only.

Parameters

doInlineCheck whether to check for inlines during create

virtual void IXMLCreateElementCmdData::SetIndexInParent ( int32 indexInParent )

pure virtual

For use by the command only.

Parameters

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

virtual void IXMLCreateElementCmdData::SetParent ( const XMLReference & parentXMLRef )

pure virtual

For use by the command only.

Parameters

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

virtual void IXMLCreateElementCmdData::SetSetMethod ( bool16 usedTextSet )

pure virtual

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

Parameters

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

virtual void IXMLCreateElementCmdData::SetStoryUIDRef ( const UIDRef & storyUIDRef )

pure virtual

For use by the command only.

Parameters

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

virtual void IXMLCreateElementCmdData::SetTextOnPathInline ( bool16 isTOP )

pure virtual

For use by the command only.

Parameters

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

virtual void IXMLCreateElementCmdData::SetTextRange	(	TextIndex	startTextIndex,
		TextIndex	endTextIndex
	)

pure virtual

For use by the command only

Parameters

startTextIndex	[INTERNAL] don't set this from client code, TextIndex of the text to start tagging
endTextIndex	[INTERNAL] don't set this from client code, TextIndex of the last character to tag

virtual void IXMLCreateElementCmdData::SetUseExistingMarkers ( const bool16 shouldUse )

pure virtual

Set whether or not to add the marker characters to the model or use the existing markers. The caller who sets this to kTrue guarantees that the special marker character exist in the text model at the text index location.

Parameters

shouldUse

virtual bool16 IXMLCreateElementCmdData::UsedStructuralSet ( ) const

pure virtual

For use by the command only. Do not invoke from client code Return which Set() was used

Returns: bool16 kTrue if structural Set() was used

virtual bool16 IXMLCreateElementCmdData::UsedTableCellSet ( ) const

pure virtual

For use by the command only. Do not invoke from client code Return which Set() was used

Returns: bool16 kTrue if table cell Set() was used

virtual bool16 IXMLCreateElementCmdData::UsedTableSet ( ) const

pure virtual

For use by the command only. Return which Set was used (whether a text-based 'Set' method or a content-item based 'Set' method)

Returns: bool16 kTrue if table grid area set was used

virtual bool16 IXMLCreateElementCmdData::UsedTextSet ( ) const

pure virtual

For use by the command only. Return which Set was used (whether a text-based 'Set' method or a content-item based 'Set' method)

Returns: bool16 kTrue if text-based set (default) used

virtual bool16 IXMLCreateElementCmdData::UseExistingMarkers ( ) const

pure virtual

Get whether or not to add the marker characters to the model or use the existing markers

Parameters

none

Returns: bool16 kTrue = the create command should use the existing markers (caller guarantees they are valid marker characters)

Public Types

Public Member Functions

Detailed Description

Member Function Documentation