IZOrderSelectionSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Martz
// 
// $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.
// 
// 
// Note:
// 
//========================================================================================

#ifndef _IZORDERSELECTIONSUITE_
#define _IZORDERSELECTIONSUITE_
//________________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________________
 #include "ShuksanID.h"
 #include "IPMUnknown.h"
 #include "PMRect.h"
 #include "PMTypes.h"
 #include "ISelectionMessages.h"
 #include "IActionManager.h" // For kInvalidMousePoint

class IControlView;

typedef enum { 
 kLeftDirection = 0, 
 kRightDirection = 1,
 kLeftDirectionx5 = 2,
 kRightDirectionx5 = 3,
 kExtremeLeftDirection = 4, 
 kExtremeRightDirection = 5 } 
 SelectDirection;

//________________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________________

class IZOrderSelectionSuite : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IZORDERSELECTIONSUITE };

 virtual bool16 CanSelectForward(IControlView* view, Selection::Action replaceOrAdd, const PMPoint& point, const PMRect& rect = kEmptyRect) const = 0;

 virtual bool16 CanSelectBackward(IControlView* view, Selection::Action replaceOrAdd, const PMPoint& point, const PMRect& rect = kEmptyRect) const = 0;

 virtual bool16 CanSelectFront(IControlView* view, Selection::Action replaceOrAdd, const PMPoint& point, const PMRect& rect = kEmptyRect) const = 0;

 virtual bool16 CanSelectBack(IControlView* view, Selection::Action replaceOrAdd, const PMPoint& point, const PMRect& rect = kEmptyRect) const = 0;

 virtual bool16 CanSelectParent(IControlView* view) const = 0;

 virtual bool16 CanSelectChild(IControlView* view) const = 0;

 virtual bool16 CanSelectSibling(IControlView* view, SelectDirection direction) const = 0;

 virtual ErrorCode SelectForward(IControlView* view, Selection::Action replaceOrAdd, const PMPoint& point, const PMRect& rect = kEmptyRect) const = 0;

 virtual ErrorCode SelectBackward(IControlView* view, Selection::Action replaceOrAdd, const PMPoint& point, const PMRect& rect = kEmptyRect) const = 0;

 virtual ErrorCode SelectFront(IControlView* view, Selection::Action replaceOrAdd, const PMPoint& point, const PMRect& rect = kEmptyRect) const = 0;

 virtual ErrorCode SelectBack(IControlView* view, Selection::Action replaceOrAdd, const PMPoint& point, const PMRect& rect = kEmptyRect) const = 0;

 virtual ErrorCode SelectParent(IControlView* view) const = 0;

 virtual ErrorCode SelectChild(IControlView* view) const = 0;

 virtual ErrorCode SelectSibling(IControlView* view, SelectDirection direction) const = 0;
 };

#endif // _IZORDERSELECTIONSUITE_