ITreeViewController Class Reference

#include <ITreeViewController.h>

Inheritance diagram for ITreeViewController:

Public Types
enum	{ kDefaultIID = IID_ITREEVIEWCONTROLLER }
enum	SelectCode {   eSuccess, eNoSelectionAllowed, eSingleItemAlreadySelected, eSingleParentOnly,   eDiscontiguousNotAllowed, eCantSelectHiddenRootNode }

Public Member Functions
virtual void	ProcessSelectionRules (IEvent *event, UID node, bool16 notifyOfChange=kTrue)=0
virtual void	DeselectAll (bool16 notifyOfChange=kTrue, bool16 changeHilite=kTrue)=0
virtual SelectCode	Select (const NodeID &itemToSelect, bool16 notifyOfChange=kTrue, bool16 changeHilite=kTrue)=0
virtual void	Deselect (const NodeID &itemToDeselect, bool16 notifyOfChange=kTrue, bool16 changeHilite=kTrue)=0
virtual bool16	IsSelected (const NodeID &item) const =0
virtual void	GetSelectedItems (NodeIDList &selectedItems) const =0
virtual void	GetSelectedItemsDisplayOrder (NodeIDList &selectedItems) const =0
virtual bool16	AllowsSelection () const =0
virtual NodeID	GetMasterItem () 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

Interface to manipulate and process tree-view selections. Overridden only under exceptional conditions, e.g. within the XML structure view.

Member Function Documentation

virtual bool16 ITreeViewController::AllowsSelection ( ) const

pure virtual

Does this tree allow nodes to be selected.

Returns

kTrue if this tree allows nodes to be selected, kFalse if no nodes are selectable

Implemented in CTreeViewController.

virtual void ITreeViewController::Deselect ( const NodeID &  itemToDeselect, bool16  notifyOfChange = kTrue, bool16  changeHilite = kTrue  )

pure virtual

Deselect the element specified by the given node.

Parameters

itemToDeselect
notifyOfChange	kTrue if the change in state should be broadcast to registered observers, kFalse otherwise
changeHilite	kTrue if the hilite state should reflect the change

Implemented in CTreeViewController.

virtual void ITreeViewController::DeselectAll ( bool16  notifyOfChange = kTrue, bool16  changeHilite = kTrue  )

pure virtual

Deselect all elements.

Parameters

notifyOfChange	kTrue if the change in state should be broadcast to registered observers, kFalse otherwise
changeHilite	kTrue if the hilite state should reflect the change

Implemented in CTreeViewController.

virtual NodeID ITreeViewController::GetMasterItem ( ) const

pure virtual

Returns the NodeID of the first item selected.

Returns

NodeID of the first item selected.

Implemented in CTreeViewController.

virtual void ITreeViewController::GetSelectedItems ( NodeIDList &  selectedItems ) const

pure virtual

Determine the items selected within the tree control.

Parameters

selectedItems

OUT parameter, is a sorted array arranged in NodeID order

Implemented in CTreeViewController.

virtual void ITreeViewController::GetSelectedItemsDisplayOrder ( NodeIDList &  selectedItems ) const

pure virtual

Determine the items selected within the tree control.

Parameters

selectedItems

OUT parameter, is a sorted array arranged in display order.

Implemented in CTreeViewController.

virtual bool16 ITreeViewController::IsSelected ( const NodeID &  item ) const

pure virtual

Determine if given node is selected

Returns

kTrue if the item specified is selected, kFalse otherwise

Implemented in CTreeViewController.

virtual void ITreeViewController::ProcessSelectionRules ( IEvent *  event, UID  node, bool16  notifyOfChange = kTrue  )

pure virtual

Handles a click on the given node to determine how it affects the selection.

Parameters

event	encapsulates event generated by end-user
node	refers to node clicked

Implemented in CTreeViewController.

virtual SelectCode ITreeViewController::Select ( const NodeID &  itemToSelect, bool16  notifyOfChange = kTrue, bool16  changeHilite = kTrue  )

pure virtual

Select the element at the given position in the list.

Parameters

itemToSelect
notifyOfChange	kTrue if the change in state should be broadcast to registered observers, kFalse otherwise
changeHilite	kTrue if the hilite state should reflect the change

Returns

result of the selection

Implemented in CTreeViewController.