IContentDropperFacade.h

//======================================================================================== 
// 
// $File$ 
// 
// Owner: Ashish Duggal(aduggal)
// 
// $Author$ 
// 
// $DateTime$ 
// 
// $Revision$ 
// 
// $Change$ 
//
// ADOBE CONFIDENTIAL
// 
// Copyright 2011 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.
// 
// Description: 
// A high level API for dealing with content dropper.
// 
//======================================================================================== 

#ifndef __IContentDropperFacade__ 
#define __IContentDropperFacade__ 

// ----- Includes ----- 
#include "IPMUnknown.h"
#include "ContentDropperID.h"
#include "ContentDropperTypes.h"

// -----Forward Declarations------



namespace Facade 
{ 

 class IContentDropperFacade : public IPMUnknown
 { 
 public: 
 enum { kDefaultIID = IID_ICONTENTDROPPERFACADE }; 

 //Load into Conveyor APIs
 
 virtual ErrorCode LoadContentDropper(const UIDList& items,
 ContentDropperTypes::LinkPolicy linkPolicy = ContentDropperTypes::kUnknownPolicy) = 0; 
 

 virtual ErrorCode LoadContentDropperWithNeedfulSet(const UIDList* items,
 ContentDropperTypes::LinkPolicy linkPolicy = ContentDropperTypes::kUnknownPolicy) = 0;
 
 virtual ErrorCode LoadItemsFromPage(IDataBase* db, const UIDList& pageUIDList, bool16 makeOneCollection = kFalse) = 0;

 virtual ErrorCode LoadItemsFromSpreads(IDataBase* db, const UIDList& spreadUIDList , bool16 makeOneCollection ) = 0;

 //Place APIs
 virtual ErrorCode PlaceContent(const UIDList& itemsToPlace, const UIDRef& targetRef,
 ContentDropperTypes::LinkPolicy linkPolicy = ContentDropperTypes::kUnknownPolicy, bool16 mapStyles = kFalse) = 0;

 virtual ErrorCode PlaceContentFromConveyor(const UIDRef& targetRef,
 ContentDropperTypes::LinkPolicy linkPolicy = ContentDropperTypes::kUnknownPolicy, bool16 mapStyles = kFalse) = 0;
 
 //Manage Conveyor

 virtual ErrorCode ClearItemsFromConveyor(bool16 allItems = kFalse) = 0;
 
 virtual bool16 RotateItemsBy(const int32 byNoOfItems, const bool16 isForwardDirection = kTrue) = 0;

 virtual bool16 ExpandCollapseItemAtHead(bool16 expand = kTrue) = 0;

 virtual bool16 MoveHeadToFirstLastItem(bool16 moveToFirst = kTrue) = 0;

 virtual bool16 IsConveyorLoaded() = 0;
 
 virtual UIDList GetNthItems(uint32 n) = 0; 

 virtual UIDList GetPlaceHeadItems() = 0;
 
 virtual int32 GetNeedfulSetForItem(UID root, UIDList& needfulSet) = 0;

 virtual bool16 IsUniqueCollectionInDoc(const UIDList& uidListToAdd) const = 0;

 virtual ContentDropperTypes::eAfterDrop GetCDUIPrefsAfterPlaceOption() const = 0;

 virtual ErrorCode SetCDUIPrefsAfterPlaceOption(ContentDropperTypes::eAfterDrop option) = 0;

 virtual bool16 GetCDUIPrefsLinkOption() = 0;

 virtual void SetCDUIPrefsLinkOption(bool16 link = kTrue) = 0;

 virtual bool16 GetCDUIPrefsMapStyles() = 0;

 virtual void SetCDUIPrefsMapStyles(bool16 mapStyle = kTrue) = 0;

 virtual bool16 GetCDUIPrefsCollectAllThreadedFrames() = 0;

 virtual void SetCDUIPrefsCollectAllThreadedFrames(bool16 collectAllFrames = kTrue) = 0;
 }; 

} // namespace Facade

#endif // __IContentDropperFacade__