ITreeViewController.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Joss
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ITreeViewController__
#define __ITreeViewController__

#include "IPMUnknown.h"
#include "IControlView.h"
#include "UIDList.h"
#include "IEvent.h"
#include "NodeID.h" // for NodeIDList

class ITreeViewController : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITREEVIEWCONTROLLER };
 typedef enum { eSuccess, eNoSelectionAllowed, eSingleItemAlreadySelected, eSingleParentOnly, eDiscontiguousNotAllowed, eCantSelectHiddenRootNode } SelectCode;
 // ----- Item selection -----

 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;

};

#endif