ILayoutSelectionSuite.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.
// 
//========================================================================================

#ifndef _ILayoutSelectionSuite_
#define _ILayoutSelectionSuite_
//________________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________________
 #include "ShuksanID.h"
 #include "IPMUnknown.h"
 #include "ISelectionMessages.h"
//================================================================================================
//________________________________________________________________________________________________
// CLASS FORWARDS
//________________________________________________________________________________________________
 class IHierarchy;
 class IControlView;
 
//________________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________________
class ILayoutSelectionSuite : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_ILAYOUTSELECTION_ISUITE };

 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:
 // Methods for extending the selection

// virtual void SelectOne ( UID newItem, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll) = 0;

 virtual void SelectPageItems (const UIDList& newItems, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll) = 0;

 virtual void SelectInTarget (IPMUnknown* targetingBoss, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll) = 0;

 virtual void SelectInView (IControlView* controlView, const PMRect& rect, Selection::Action selectionMode, int32 selectionType, bool16 deselectSelected, Selection::LayoutScrollChoice doScroll) = 0;

 virtual void SelectAllPageItems (IHierarchy* spreadHierarchy, UID specificLayerUID, Selection::LayoutScrollChoice doScroll) = 0;

 virtual void SelectKeyObject(const UIDRef& keyObject) = 0;


 // Methods for shrinking the selection

 virtual void DeselectPageItems (const UIDList& itemsToDeselect) = 0;

 virtual void DeselectPageItemsNotSupporting (const PMIID& id) = 0;

 virtual void DeselectAllExceptThisPageItem (const UID&) = 0;

 virtual void DeselectAllPageItems (void) = 0;

 
 virtual bool16 IsLayoutSelectionEmpty (void) const = 0;

 virtual bool16 IsPageItemSelected (const UID&) const = 0;

 virtual void SelectPageItemsInternal (const UIDList& newItems, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll, bool16) = 0;

 };


class ILayoutSelectionSuiteMsgData
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum ActionType { kDeselectAll};
 
 virtual ActionType GetActionType (void) const = 0;

 virtual bool16 GetDrawIt (void) const = 0;
 };
 
#endif // _ILayoutSelectionSuite_