IPathSelectionSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Paul Sorrick
// 
// $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 __IPATHSELECTIONSUITE__
#define __IPATHSELECTIONSUITE__

#include "IPMUnknown.h"

#include "LayoutUIID.h"
#include "PathSelectionList.h"
#include "PMRect.h"

class IGraphicsContext ;

class IPathSelectionSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPATHSELECTION_SUITE } ;

 virtual void ActivatePathSelection( bool16 isPathSelection ) = 0 ;
 virtual bool16 IsPathSelectionActive() const = 0 ;

 virtual ErrorCode SelectPageItemPathPoint( const UIDRef& item, const PointSelector& handleID, bool16 drawit = kFalse ) = 0 ;
 virtual ErrorCode SelectPageItemPathPoints( const UIDRef& item, const PointSelectorList& pts, bool16 drawit = kFalse ) = 0 ;
 virtual ErrorCode SelectPathPoints( const PathSelectionList& list, bool16 drawit = kFalse ) = 0 ;
 virtual ErrorCode SelectEntirePageItem( const UIDList& itemList, bool16 drawit = kFalse ) = 0 ;

 virtual ErrorCode ReplacePathSelection( const PathSelectionList& add, bool16 drawit = kFalse ) = 0 ;
 virtual ErrorCode AlterPathSelection( const PathSelectionList& drop, const PathSelectionList& add, bool16 drawit = kFalse ) = 0 ;
 virtual ErrorCode Replace_( const UIDList& itemList, bool16 drawit = kFalse ) = 0 ;



 virtual ErrorCode DeselectPageItemPathPoint( const UIDRef& item, const PointSelector& handle, bool16 drawit = kFalse ) = 0 ; //Deselect
 virtual ErrorCode DeselectPageItemPathPoints( const UIDRef& item, const PointSelectorList& pts, bool16 drawit = kFalse ) = 0 ; //Deselect
 virtual ErrorCode DeselectPathPoints( const PathSelectionList& list, bool16 drawit = kFalse ) = 0 ; //Deselect
 virtual ErrorCode DeselectEntirePageItem( const UIDList& itemList, bool16 drawit = kFalse ) = 0 ; //Deselect
 virtual ErrorCode DeselectAllPaths( bool16 drawit = kFalse ) = 0 ; //DeselectAll




 virtual bool16 IsPathSelectionEmpty() const = 0 ; //IsEmpty
 virtual bool16 IsAnyPageItemPathPointSelected( const UIDRef& item ) const = 0 ; //IsSelected
 virtual bool16 IsPageItemPathPointSelected( const UIDRef& item, const PointSelector& handle ) const = 0 ; //IsSelected

 virtual int32 CountPathSelectedPageItems() const = 0 ; //Length
 virtual UIDList GetPathSelectedPageItems() const = 0 ; //GetItemList

 virtual int32 CountPathSelectors( const UIDRef& item ) const = 0 ; //Length
 virtual void GetSelectorList( const UIDRef& item, PointSelectorList& ptsOut ) const = 0 ; //GetComponentList

 virtual const PathSelectionList& GetPathSelection() const = 0 ; //GetSelection

 virtual bool16 IsEntirePageItemSelected( const UIDRef& item ) const = 0 ; //IsEntireObjectSelected
 virtual bool16 IsEntirePathSelected( const UIDRef& item, int32 pathIndex ) const = 0 ; //IsEntirePathSelected


 virtual bool16 IsSinglePoint( UIDRef* theItem = nil, PointSelector* thePoint = nil ) const = 0 ;
 virtual bool16 IsSingleSegment( UIDRef* theItem = nil, PointSelector* theSegment = nil ) const = 0 ;
 virtual bool16 IsTwoContiguousSegs( UIDRef* theItem = nil, PointSelector* thePoint = nil ) const = 0 ;
} ;

#endif // __IPATHSELECTION__