IXMLNodeSelectionSuite Class Reference

#include <IXMLNodeSelectionSuite.h>

Inheritance diagram for IXMLNodeSelectionSuite:

Public Types
enum	{ kDefaultIID = IID_IXMLNODESELECTIONSUITE }

Public Member Functions
virtual void	SelectAttribute (const XMLAttributeReference &newItem, Selection::Action selectionMode)=0
virtual void	SelectAttribute (const K2Vector< XMLAttributeReference > *newItems, Selection::Action selectionMode)=0
virtual void	DeselectAttribute (const K2Vector< XMLAttributeReference > *itemsToDeselect)=0
virtual void	SelectElement (const XMLReference &newItem, Selection::Action selectionMode)=0
virtual void	SelectElement (const K2Vector< XMLReference > *newItems, Selection::Action selectionMode)=0
virtual void	DeselectElement (const K2Vector< XMLReference > *itemsToDeselect)=0
virtual void	Select (IPMUnknown *targetBoss, Selection::Action selectionMode)=0
virtual void	DeselectAll (bool8 notifyofSelectionChange=true)=0
virtual void	SelectAll (void)=0
virtual bool16	IsElementSelected (const XMLReference &itemNode)=0
virtual bool16	IsAttributeSelected (const XMLAttributeReference &itemNode)=0
virtual bool16	IsEmpty (void) const =0
virtual bool16	IsMixedSelection () const =0
virtual bool16	IsNonAttributeSelected () const =0
virtual bool16	IsNonAttributeSelected (const XMLReference &itemNode) const =0
virtual bool16	IsElementOnlySelection () const =0
virtual bool16	IsSingleElementSelection () const =0
virtual bool16	IsCommentOnlySelection () const =0
virtual bool16	IsSingleCommentSelection () const =0
virtual bool16	IsPIOnlySelection () const =0
virtual bool16	IsSinglePISelection () const =0
virtual bool16	IsAttributeOnlySelection () const =0
virtual bool16	IsSingleAttributeSelection () const =0
virtual bool16	AreAnyTextSnippetsSelected () const =0
virtual bool16	IsDocElementSelected () const =0
virtual bool16	IsRootElementSelected () const =0
virtual bool16	IsDOCTYPEElementSelected () 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

Methods to support selection on the structure view

Member Function Documentation

virtual bool16 IXMLNodeSelectionSuite::AreAnyTextSnippetsSelected ( ) const

pure virtual

Determine if there are text snippets in the selection

Returns

kTrue if there are text snippets in the selection, kFalse if there are none

virtual void IXMLNodeSelectionSuite::DeselectAll ( bool8  notifyofSelectionChange = true )

pure virtual

Deselect everything in the selection.

Parameters

notifyofSelectionChange

indicates whether to notify observers that the selection changed

virtual void IXMLNodeSelectionSuite::DeselectAttribute ( const K2Vector< XMLAttributeReference > *  itemsToDeselect )

pure virtual

Deselect the specified attributes.

Parameters

itemsToDeselect

list of attributes to de-select

virtual void IXMLNodeSelectionSuite::DeselectElement ( const K2Vector< XMLReference > *  itemsToDeselect )

pure virtual

Deselect the specified elements.

Parameters

itemsToDeselect

list of elements to be deslected

virtual bool16 IXMLNodeSelectionSuite::IsAttributeOnlySelection ( ) const

pure virtual

Determine whether the selection only contains attributesI

Returns

kTrue if all items in selection are attributes, kFalse if there are elements or text snippets

virtual bool16 IXMLNodeSelectionSuite::IsAttributeSelected ( const XMLAttributeReference &  itemNode )

pure virtual

Is the specified attribute part of this selection?

Parameters

itemNode

- The node to check for in the selection

Returns

bool16 kTrue if attribute selected, kFalse otherwise

virtual bool16 IXMLNodeSelectionSuite::IsCommentOnlySelection ( ) const

pure virtual

Determine whether the selection only contains comments

Returns

kTrue if all items in selection are comments. kFalse if there are anything else

virtual bool16 IXMLNodeSelectionSuite::IsDocElementSelected ( ) const

pure virtual

Determine whether the Document element is selected

Returns

kTrue if the Doc element is one of the selected items, kFalse otherwise

virtual bool16 IXMLNodeSelectionSuite::IsDOCTYPEElementSelected ( ) const

pure virtual

Determine whether the DOCTYPE element is selected

Returns

kTrue if the DOCTYPE element is one of the selected items, kFalse otherwise

virtual bool16 IXMLNodeSelectionSuite::IsElementOnlySelection ( ) const

pure virtual

Determine whether the selection only contains elements

Returns

kTrue if all items in selection are elements, kFalse if there are anything else

virtual bool16 IXMLNodeSelectionSuite::IsElementSelected ( const XMLReference &  itemNode )

pure virtual

Is the specified element part of this selection?

Parameters

itemNode

- The node to check for in the selection

Returns

bool16 kTrue if element specified is selected, kFalse otherwise

virtual bool16 IXMLNodeSelectionSuite::IsEmpty ( void  ) const

pure virtual

Determine if the selection is empty.

Returns

bool16 kTrue if selection empty, kFalse otherwise

virtual bool16 IXMLNodeSelectionSuite::IsMixedSelection ( ) const

pure virtual

Determine whether the selection contains multiple XML types.

Returns

kTrue if the selection contains more than one of the following types of items( element, attribute, text snippet) , kFalse otherwise

virtual bool16 IXMLNodeSelectionSuite::IsNonAttributeSelected ( ) const

pure virtual

Determine whether a non-attribute object is selected.

Returns

kTrue if the selection contains non-attributes (this includes element, comment, pi)

virtual bool16 IXMLNodeSelectionSuite::IsNonAttributeSelected ( const XMLReference &  itemNode ) const

pure virtual

Determine if the selection contains the given non-attribute

Parameters

itemNode

- The node to check for in the selection

Returns

kTrue if the selection contains the non-attribute passed in

virtual bool16 IXMLNodeSelectionSuite::IsPIOnlySelection ( ) const

pure virtual

Determine whether the selection only contains PIs

Returns

kTrue if all items in selection are processing instructions. kFalse if there are anything else

virtual bool16 IXMLNodeSelectionSuite::IsRootElementSelected ( ) const

pure virtual

Determine whether the Root element is selected

Returns

kTrue if the Root element is one of the selected items, kFalse otherwise

virtual bool16 IXMLNodeSelectionSuite::IsSingleAttributeSelection ( ) const

pure virtual

Determine whether the selection only contains a single attribute

Returns

kTrue only if there is just 1 item selected and it is an attribute

virtual bool16 IXMLNodeSelectionSuite::IsSingleCommentSelection ( ) const

pure virtual

Determine whether the selection only contains a single comment

Returns

kTrue only if there is just 1 item selected and it's a comment. kFalse otherwise

virtual bool16 IXMLNodeSelectionSuite::IsSingleElementSelection ( ) const

pure virtual

Determine whether the selection only contains a single element

Returns

kTrue only if there is just 1 item selected and it is an element, kFalse otherwise

virtual bool16 IXMLNodeSelectionSuite::IsSinglePISelection ( ) const

pure virtual

Determine whether the selection only contains a single PI

Returns

kTrue only if there is just 1 item selected and it's a processing instruction. kFalse otherwise

virtual void IXMLNodeSelectionSuite::Select ( IPMUnknown *  targetBoss, Selection::Action  selectionMode  )

pure virtual

Select the specified items using the selectionMode.

Parameters

targetBoss	items to select (Must be on the same boss as IXMLNodeTarget)
selectionMode	specifies replace or add to existing selection

virtual void IXMLNodeSelectionSuite::SelectAll ( void  )

pure virtual

Select everything in the selection.

virtual void IXMLNodeSelectionSuite::SelectAttribute ( const XMLAttributeReference &  newItem, Selection::Action  selectionMode  )

pure virtual

Select the specified item using the selectionMode.

Parameters

newItem	item to be selected
selectionMode	specifies replace or add to existing selection

virtual void IXMLNodeSelectionSuite::SelectAttribute ( const K2Vector< XMLAttributeReference > *  newItems, Selection::Action  selectionMode  )

pure virtual

Select the specified items using the selectionMode.

Parameters

newItems	items to be selected
selectionMode	specifies replace or add to existing selection

virtual void IXMLNodeSelectionSuite::SelectElement ( const XMLReference &  newItem, Selection::Action  selectionMode  )

pure virtual

Select the specified item using the selectionMode.

Parameters

newItem	specifies element to select
selectionMode	specifies replace or add to existing selection

virtual void IXMLNodeSelectionSuite::SelectElement ( const K2Vector< XMLReference > *  newItems, Selection::Action  selectionMode  )

pure virtual

Select the specified items using the selectionMode.

Parameters

newItems	items to select
selectionMode	specifies replace or add to existing selection