#include <IXMLDeleteElementCmdData.h>

Inheritance diagram for IXMLDeleteElementCmdData:

Public Types
enum	{ kDefaultIID = IID_IXMLDELETEELEMENTCMDDATA }

Public Member Functions
virtual void	Set (const XMLReference &deleteElementXMLRef, bool16 deleteChildren, bool16 deleteInSameStoryOnly=kFalse, bool16 reconnectChildren=kFalse)=0

virtual void	SetDTDProperties (bool16 ignoreDTD=kFalse)=0

virtual void	SetTableProperties (bool16 deleteTableWithCell=kTrue)=0

virtual const XMLReference &	GetDeleteElement (void) const =0

virtual const K2Vector < XMLReference > &	GetElementsToBeDeleted (void) const =0

virtual bool16	DeleteChildren (void) const =0

virtual bool16	DeleteInSameStoryOnly (void) const =0

virtual bool16	ReconnectChildren (void) const =0

virtual bool16	IgnoreDTD (void) const =0

virtual bool16	DeleteTableWithCell (void) const =0

virtual void	SetNumOfMarkersDeleted (int32 numOfMarkersDeleted)=0

virtual int32	GetNumOfMarkersDeleted (void) const =0

virtual void	SetElementsToBeDeleted (const K2Vector< XMLReference > &elementsList)=0

virtual void	SetDeleteMarkers (bool16 deleteMarkers)=0

virtual bool16	GetDeleteMarkers (void) const =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 deleting elements from the logical structure tree; from client code, use IXMLElementCommands rather than low-level commands.

Member Function Documentation

virtual bool16 IXMLDeleteElementCmdData::DeleteChildren ( void ) const

pure virtual

Accessor for property, specifying whether to delete the children as well

Returns: bool16 kTrue if children should be deleted too, kFalse otherwise

virtual bool16 IXMLDeleteElementCmdData::DeleteInSameStoryOnly ( void ) const

pure virtual

Accessor for property, specifying whether to only delete the children that are also in the same story

Returns: bool16 kTrue if children in same story only should be deleted, kFalse for converse

virtual bool16 IXMLDeleteElementCmdData::DeleteTableWithCell ( void ) const

pure virtual

Accessor for property, specifying whether deleting a table cell will cause the entire table to be deleted as well

Returns: whether the table should be deleted if a table cell is deleted

virtual const XMLReference& IXMLDeleteElementCmdData::GetDeleteElement ( void ) const

pure virtual

Accessor for the item to be deleted

Returns: XMLReference to item be deleted when command processed

virtual bool16 IXMLDeleteElementCmdData::GetDeleteMarkers ( void ) const

pure virtual

Get whether to delete element markers INTERNAL USE ONLY

Returns: whether to delete element markers

virtual const K2Vector<XMLReference>& IXMLDeleteElementCmdData::GetElementsToBeDeleted ( void ) const

pure virtual

Accessor for the list of elements that will actually get deleted. This is best called during pre-notification of the command, after the calculations have been done on which elements will actually get deleted

Returns: K2Vector<XMLReference> vector of elements that will actually get deleted

virtual int32 IXMLDeleteElementCmdData::GetNumOfMarkersDeleted ( void ) const

pure virtual

Accessor for the number of markers that were deleted by the command

Returns: int32 giving number of markers deleted

virtual bool16 IXMLDeleteElementCmdData::IgnoreDTD ( void ) const

pure virtual

Accessor for property, specifying whether to ignore the DTD when deleting the specified element

Returns: bool16 kTrue if DTD should be ignored; kFalse if DTD validity should be preserved

virtual bool16 IXMLDeleteElementCmdData::ReconnectChildren ( void ) const

pure virtual

Accessor for property, specifying whether to reconnect the children to deleted element's parent

Returns: bool16 kTrue if children should be reconnected to deleted element's parent, kFalse if the converse

virtual void IXMLDeleteElementCmdData::Set	(	const XMLReference &	deleteElementXMLRef,
		bool16	deleteChildren,
		bool16	deleteInSameStoryOnly = `kFalse`,
		bool16	reconnectChildren = `kFalse`
	)

pure virtual

Set up data on this interface

Parameters

deleteElementXMLRef	XML element reference to delete
deleteChildren	whether to recursively delete the children as well
deleteInSameStoryOnly	if deleteChildren, whether to delete only the children that are also in the same story
reconnectChildren	whether to reconnect the children to deleted element's parent (deleteChildren must be kFalse)

virtual void IXMLDeleteElementCmdData::SetDeleteMarkers ( bool16 deleteMarkers )

pure virtual

Set whether to delete the element markers. If the markers are not deleted, then TextIndexID is still deleted, but the marker itself remains in the text model INTERNAL USE ONLY

Parameters

deleteMarkers whether to delete the markers

virtual void IXMLDeleteElementCmdData::SetDTDProperties ( bool16 ignoreDTD = kFalse )

pure virtual

Set up additional, DTD related data for this interface

Parameters

ignoreDTD if kTrue, if the deleting element is associated with a DTD, ignore validation and just delete the element. By default, if an element is associated with a DTD, the validity is taken into consideration when an element is deleted

virtual void IXMLDeleteElementCmdData::SetElementsToBeDeleted ( const K2Vector< XMLReference > & elementsList )

pure virtual

Set the list of elements that will actually get deleted

Parameters

elementsList list of elements that will actually get deleted

virtual void IXMLDeleteElementCmdData::SetNumOfMarkersDeleted ( int32 numOfMarkersDeleted )

pure virtual

Set the number of text markers to be deleted in the process of deleting this element and possibily its children. Useful for adjusting text ranges after a delete. This is set by the command as it deletes elements

Parameters

numOfMarkersDeleted [INTERNAL] set by the command, not from client code

virtual void IXMLDeleteElementCmdData::SetTableProperties ( bool16 deleteTableWithCell = kTrue )

pure virtual

Setup additional table related command parameters

Parameters

deleteTableWithCell (default = kTrue) if kTrue, deleting a cell in the table will cause the entire table to be deleted. If kFalse, only the cell(s) given will be deleted

Public Types

Public Member Functions

Detailed Description

Member Function Documentation