#include <IXMLNodeTarget.h>

Inheritance diagram for IXMLNodeTarget:

Public Types
enum	{ kDefaultIID = IID_IXMLNODETARGET }

enum	XMLNodeFilterType { kRemoveDescendents }

Public Member Functions
virtual int32	Location (const XMLAttributeReference &) const =0

virtual int32	Location (const XMLReference &) const =0

virtual int32	CommentLocation (const XMLReference &) const =0

virtual int32	PILocation (const XMLReference &) const =0

virtual int32	AllLocation (const XMLReference &) const =0

virtual void	AddAttribute (const XMLAttributeReference &newItem)=0

virtual void	RemoveAttribute (const XMLAttributeReference &itemToRemove)=0

virtual void	AddElement (const XMLReference &newItem)=0

virtual void	RemoveElement (const XMLReference &itemToRemove)=0

virtual void	AddComment (const XMLReference &newItem)=0

virtual void	RemoveComment (const XMLReference &itemToRemove)=0

virtual void	AddPI (const XMLReference &newItem)=0

virtual void	RemovePI (const XMLReference &itemToRemove)=0

virtual void	AddNonAttribute (const XMLReference &newItem)=0

virtual void	RemoveNonAttribute (const XMLReference &itemToRemove)=0

virtual void	Clear (void)=0

virtual void	ClearNonAttributes (void)=0

virtual void	ClearElements ()=0

virtual void	ClearComments (void)=0

virtual void	ClearPIs (void)=0

virtual void	ClearAttributes ()=0

virtual const K2Vector < XMLAttributeReference > &	GetAttributeNodeList () const =0

virtual void	SetAttributeNodeList (const K2Vector< XMLAttributeReference > &)=0

virtual void	SetAttributeNodeList (const XMLAttributeReference &)=0

virtual int32	GetAttributeCount () const =0

virtual const XMLAttributeReference &	GetNthAttribute (int32 index) const =0

virtual const K2Vector < XMLReference > &	GetElementNodeList () const =0

virtual void	GetFilteredElementNodeList (XMLNodeFilterType, K2Vector< XMLReference > &sortedList) const =0

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

virtual void	SetElementNodeList (const XMLReference &)=0

virtual int32	GetElementCount () const =0

virtual const XMLReference &	GetNthElement (int32 index) const =0

virtual const K2Vector < XMLReference > &	GetCommentNodeList () const =0

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

virtual void	SetCommentNodeList (const XMLReference &)=0

virtual int32	GetCommentCount () const =0

virtual const XMLReference &	GetNthComment (int32 index) const =0

virtual const K2Vector < XMLReference > &	GetPINodeList () const =0

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

virtual void	SetPINodeList (const XMLReference &)=0

virtual int32	GetPICount () const =0

virtual const XMLReference &	GetNthPI (int32 index) const =0

virtual const K2Vector < XMLReference > &	GetAllNodeList () const =0

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

virtual void	SetAllNodeList (const XMLReference &)=0

virtual void	GetFilteredAllNodeList (IXMLNodeTarget::XMLNodeFilterType, K2Vector< XMLReference > &sortedList) const =0

virtual int32	GetAllCount () const =0

virtual const XMLReference &	GetNthNode (int32 index) const =0

virtual IDataBase *	GetDataBase () const =0

virtual bool16	HasContent (void) const =0

virtual void	Initialize (IDataBase *db)=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

Represents the nodes in the structure that are the 'target' of operations performed on an active selection in the structure view. Would be used from a suite implementation.

If you are writing your own suite implementation and you add in your suite to the ASB and the CSB kXMLStructureSelectionBoss, then in your CSB implementation code you'd query for the IXMLNodeTarget interface on 'this' to get at the nodes in the structure tree to manipulate from your implementation on the CSB.

Member Enumeration Documentation

enum IXMLNodeTarget::XMLNodeFilterType

List filter enumeration

Member Function Documentation

virtual void IXMLNodeTarget::AddAttribute ( const XMLAttributeReference & newItem )

pure virtual

Add an attribute to the selection target attribute list.

Parameters

newItem specifies attribute to add

virtual void IXMLNodeTarget::AddComment ( const XMLReference & newItem )

pure virtual

Add a comment to the selection target comment list

Parameters

newItem specifies item to add

virtual void IXMLNodeTarget::AddElement ( const XMLReference & newItem )

pure virtual

Add an element to the selection target element list.

Parameters

newItem specifies item to add

virtual void IXMLNodeTarget::AddNonAttribute ( const XMLReference & newItem )

pure virtual

Add a non-attribute to the selection target all list

Parameters

newItem specifies item to add

virtual void IXMLNodeTarget::AddPI ( const XMLReference & newItem )

pure virtual

Add a processing instruction to the selection target PI list

Parameters

newItem specifies item to add

virtual int32 IXMLNodeTarget::AllLocation ( const XMLReference & ) const

pure virtual

Is the specific item in the non-attribute target list?

Returns: Index (>= 0 if in list); negative number (< 0) if not in list

virtual void IXMLNodeTarget::Clear ( void )

pure virtual

Remove all elements and attributes from the selection target lists.

virtual void IXMLNodeTarget::ClearAttributes ( )

pure virtual

Remove all attributes from the selection target list

virtual void IXMLNodeTarget::ClearComments ( void )

pure virtual

Remove all comments from the selection target list

virtual void IXMLNodeTarget::ClearElements ( )

pure virtual

Remove all elements from the selection target list

virtual void IXMLNodeTarget::ClearNonAttributes ( void )

pure virtual

Remove all non-attributes from the selection target list

virtual void IXMLNodeTarget::ClearPIs ( void )

pure virtual

Remove all processing instructions from the selection target list

virtual int32 IXMLNodeTarget::CommentLocation ( const XMLReference & ) const

pure virtual

Is the specified item in the layout target list?

Returns: Index (>= 0 if in list); negative number (< 0) if not in list

virtual int32 IXMLNodeTarget::GetAllCount ( ) const

pure virtual

Accessor for count of non-attributes in selected list

Returns: int32 non-attribute count

virtual const K2Vector<XMLReference>& IXMLNodeTarget::GetAllNodeList ( ) const

pure virtual

Return a K2Vector of XMLReferences that reflects the current non-attribute selection

Returns: K2Vector<XMLReference> list of non-attributes in selection target list

virtual int32 IXMLNodeTarget::GetAttributeCount ( ) const

pure virtual

Returns: target attribute list size

virtual const K2Vector<XMLAttributeReference>& IXMLNodeTarget::GetAttributeNodeList ( ) const

pure virtual

Return a K2 Vector of XMLAttributeReferences that reflects the current attribute selection.

Returns: collection of attributes in the selection target list

virtual int32 IXMLNodeTarget::GetCommentCount ( ) const

pure virtual

Accessor for count of comments in selected list

Returns: int32 comment count

virtual const K2Vector<XMLReference>& IXMLNodeTarget::GetCommentNodeList ( ) const

pure virtual

Return a K2Vector of XMLReferences that reflects the current comment selection

Returns: K2Vector<XMLReference> list of comments in selection target list

virtual IDataBase* IXMLNodeTarget::GetDataBase ( ) const

pure virtual

Accessor for database associated with selection

Returns: database ptr (see the Initialize method)

virtual int32 IXMLNodeTarget::GetElementCount ( ) const

pure virtual

Accessor for count of elements in selected list

Returns: element count

virtual const K2Vector<XMLReference>& IXMLNodeTarget::GetElementNodeList ( ) const

pure virtual

Return a K2 Vector of XMLReferences that reflects the current element selection.

Returns: K2Vector of elements in selection target list

virtual void IXMLNodeTarget::GetFilteredAllNodeList	(	IXMLNodeTarget::XMLNodeFilterType	,
		K2Vector< XMLReference > &	sortedList
	)		const

pure virtual

Accessor for list of non-attributes selected, filtered

Parameters

sortedList [OUT] parameter containing the filtered list from the selection

virtual void IXMLNodeTarget::GetFilteredElementNodeList	(	XMLNodeFilterType	,
		K2Vector< XMLReference > &	sortedList
	)		const

pure virtual

Accessor for list of nodes selected, filtered

Parameters

sortedList [OUT] parameter containing the filtered list from the selection

virtual const XMLAttributeReference& IXMLNodeTarget::GetNthAttribute ( int32 index ) const

pure virtual

Accessor for attribute in list by index

Parameters

index specifies the location of interest in list

Returns: XMLAttributeReference for attribute at given index

virtual const XMLReference& IXMLNodeTarget::GetNthComment ( int32 index ) const

pure virtual

Accessor for comment by index

Parameters

index location of comment of interest

Returns: XMLReference to comment at given location

virtual const XMLReference& IXMLNodeTarget::GetNthElement ( int32 index ) const

pure virtual

Accessor for element by index

Parameters

index location of element of interest

Returns: XMLReference to element at given location

virtual const XMLReference& IXMLNodeTarget::GetNthNode ( int32 index ) const

pure virtual

Accessor for non-attribute by index

Parameters

index location of non-attribute of interest

Returns: XMLReference to non-attribute at given location

virtual const XMLReference& IXMLNodeTarget::GetNthPI ( int32 index ) const

pure virtual

Accessor for processing instruction by index

Parameters

index location of PI of interest

Returns: XMLReference to PI at given location

virtual int32 IXMLNodeTarget::GetPICount ( ) const

pure virtual

Accessor for count of processing instructions in selected list

Returns: int32 PI count

virtual const K2Vector<XMLReference>& IXMLNodeTarget::GetPINodeList ( ) const

pure virtual

Return a K2Vector of XMLReferences that reflects the current processing instruction selection

Returns: K2Vector<XMLReference> list of PIs in selection target list

virtual bool16 IXMLNodeTarget::HasContent ( void ) const

pure virtual

Accessor to determine if the target is populated or not

virtual void IXMLNodeTarget::Initialize ( IDataBase * db )

pure virtual

Initialize

Parameters

db	Database the target is associated with.

virtual int32 IXMLNodeTarget::Location ( const XMLAttributeReference & ) const

pure virtual

Set the database for the layout target (i.e. page items)Is the specified item in the layout target list.

Returns: Index (>= 0 if in list); negative number (< 0) if not in list.

virtual int32 IXMLNodeTarget::Location ( const XMLReference & ) const

pure virtual

Is the specified item in the layout target list?

Returns: Index (>= 0 if in list); negative number (< 0) if not in list.

virtual int32 IXMLNodeTarget::PILocation ( const XMLReference & ) const

pure virtual

Is the specified item in the layout target list?

Returns: Index (>=0 if in list); negative number (< 0) if not in list

virtual void IXMLNodeTarget::RemoveAttribute ( const XMLAttributeReference & itemToRemove )

pure virtual

Remove an attribute from the selection target attribute list.

Parameters

itemToRemove specifies attribute to remove from list

virtual void IXMLNodeTarget::RemoveComment ( const XMLReference & itemToRemove )

pure virtual

Remove a comment from the selection target comment list

Parameters

itemToRemove specifies comment to remove

virtual void IXMLNodeTarget::RemoveElement ( const XMLReference & itemToRemove )

pure virtual

Remove an element from the selection target element list.

Parameters

itemToRemove specifies element to remove

virtual void IXMLNodeTarget::RemoveNonAttribute ( const XMLReference & itemToRemove )

pure virtual

Remove a non-attribute from the selection target all list

Parameters

itemToRemove specifies item to remove

virtual void IXMLNodeTarget::RemovePI ( const XMLReference & itemToRemove )

pure virtual

Remove a processing instruction from the selection target PI list

Parameters

itemToRemove specifies PI to remove

virtual void IXMLNodeTarget::SetAllNodeList ( const K2Vector< XMLReference > & )

pure virtual

Set the target's non-attribute list. The type-specific lists will also get filled out according to the element type of each entry in the given list

Parameters

K2Vector<XMLReference>& list of non-attributes' XMLReferences

virtual void IXMLNodeTarget::SetAllNodeList ( const XMLReference & )

pure virtual

Set the target's non-attribute list. The type-specific lists will also get filled out according to the element type of each entry in the given list

Parameters

XMLReference non-attribute's XMLReferences

virtual void IXMLNodeTarget::SetAttributeNodeList ( const K2Vector< XMLAttributeReference > & )

pure virtual

Set target attribute list

virtual void IXMLNodeTarget::SetAttributeNodeList ( const XMLAttributeReference & )

pure virtual

Set the target's attribute UIDList.

Parameters

XMLAttributeReference

virtual void IXMLNodeTarget::SetCommentNodeList ( const K2Vector< XMLReference > & )

pure virtual

Set the target's comment list

Parameters

K2Vector<XMLReference>& list of comments' XMLReferences

virtual void IXMLNodeTarget::SetCommentNodeList ( const XMLReference & )

pure virtual

Set the target's comment list

Parameters

XMLReference comment's XMLReference

virtual void IXMLNodeTarget::SetElementNodeList ( const K2Vector< XMLReference > & )

pure virtual

Set the target's element list.

virtual void IXMLNodeTarget::SetElementNodeList ( const XMLReference & )

pure virtual

Set the target element UIDList.

virtual void IXMLNodeTarget::SetPINodeList ( const K2Vector< XMLReference > & )

pure virtual

Set the target's processing instruction list

Parameters

K2Vector<XMLReference>& list of PIs' XMLReferences

virtual void IXMLNodeTarget::SetPINodeList ( const XMLReference & )

pure virtual

Set the target's processing instruction list

Parameters

XMLReference PI's XMLReference

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation