ITreeViewMgr.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 __ITreeViewMgr__
#define __ITreeViewMgr__

#include "IPMUnknown.h"
#include "widgetid.h"

//----------------------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------------------
class IControlView;
class NodeID;
class NodeID_rv;
//----------------------------------------------------------------------------------------
// ITreeViewMgr
//----------------------------------------------------------------------------------------

class INTERFACE_DECL ITreeViewMgr : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITREEVIEWMGR };
 
 virtual void ChangeRoot( bool16 widgetHeightIsConstant = kFalse ) = 0; 

 virtual void NodeAdded( const NodeID& nodeAdded ) = 0;
 
 virtual void NodesAdded( const K2Vector<NodeID>& nodesAdded ) = 0; 

 virtual void BeforeNodeDeleted( const NodeID& nodeDeleted ) = 0; 
 
 virtual void BeforeNodesDeleted( K2Vector<NodeID>& nodesDeleted ) = 0; 


 virtual void NodeMoved( const NodeID& nodeMoved, const NodeID& oldParent ) = 0; 

 //
 virtual void NodeChanged( const NodeID& nodeChanged, bool16 childrenChangedAlso = kFalse, int32 message = 0 ) = 0; 

 typedef enum { eScrollToTop, eScrollToMiddle, eScrollIntoView, eScrollToShowChildren } ScrollWhere;

 virtual void ScrollToNode( const NodeID& scrollToNode, ScrollWhere whereToScroll ) = 0; 

 virtual bool16 IsNodeExpanded( const NodeID& nodeInQuestion ) const = 0; 
 
 virtual bool16 IsNodeExpanded(IControlView* widget) const = 0; 
 virtual void ExpandNode( const NodeID& nodeToExpand, bool16 expandAllDescendants = kFalse ) = 0; 
 virtual void CollapseNode( const NodeID& nodeToCollapse, bool16 collapseAllDescendants = kFalse ) = 0; 

 virtual void HandleScroll( int32 amount, bool16 up ) = 0;

 virtual void HandleResize() = 0;

 virtual void ScrollUp() = 0;

 virtual void ScrollDown() = 0;

 virtual NodeID_rv Search( const PMString& partialNodeName ) const = 0;
 
 virtual NodeID_rv Search( const NodeID& nodeToSearch ) const = 0;
 
 virtual void ClearTree( bool16 clearExpandedNodeList = kFalse ) = 0;

 //
 virtual IControlView* QueryWidgetFromNode( const NodeID& node ) const = 0; 

 virtual void Purge(int32 level) = 0;

 virtual void RefreshSubTree(const NodeID& subTreeRoot, bool16 includeEntireHier = kTrue) = 0;

 // These methods are for the other TreeMgr interfaces and shouldn't be called by client code
 virtual void ArrangeWidgets() = 0;

 virtual PMRect GetViewableArea() = 0;

 virtual PMPoint GetSizeNeededWihtoutScrollbar() = 0;

 virtual void ScrollVerticalAbsoluteAmount(int32 amount, bool16 forceRedraw = kTrue) = 0;
}; 





#endif // __ITreeViewMgr__