ISpreadSelectionSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: ???
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe Systems Incorporated and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe Systems Incorporated and its
// suppliers and may be covered by U.S. and Foreign Patents,
// patents in process, and are protected by trade secret or copyright law.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe Systems Incorporated.
// 
//========================================================================================

#ifndef _ISpreadSelectionSuite_
#define _ISpreadSelectionSuite_

#include "ILayoutObject.h"
#include "IPMUnknown.h"
#include "ISelectionMessages.h"

#include "LayoutUIID.h"
#include "ShuksanID.h"

class IHierarchy;
class ISpread;
class IControlView;
 

class ISpreadSelectionSuite : public IPMUnknown
{

public:
 enum { kDefaultIID = IID_ISPREADSELECTION_ISUITE };


public:

 virtual void SelectSpreadItems( const UIDList& newItems, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll) = 0;
// virtual void SelectDocumentPages( page numbers, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll) = 0;
// virtual void SelectSpreadPages( UIDRef spread, page indices, Selection::Action selectionMode, Selection::LayoutScrollChoice doScroll) = 0;
// virtual void SelectDocumentSpreads( spread numbers, 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 SelectAllPages( ISpread* spread, Selection::LayoutScrollChoice doScroll) = 0;
 virtual void SelectAllSpreads( Selection::LayoutScrollChoice doScroll) = 0;


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

 virtual UIDRef GetSelectedKeyObject() const = 0;

 virtual bool16 IsKeyObjectSelected( const UIDRef& uidRef) const = 0;

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


 virtual void DeselectAllExceptThisSpreadItem( const UID&) = 0;

 virtual void DeselectAllSpreadItems() = 0;


 virtual bool16 IsSpreadSelectionEmpty() const = 0;

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

 virtual bool32 CanShowObjectConstraints() const = 0;

 virtual UIDList GetSelectedItems() const = 0;
};


class ISpreadSelectionSuiteMsgData
{
public:
 enum ActionType { kDeselectAll};

 virtual ActionType GetActionType (void) const = 0;

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