IOutputPages.h

//========================================================================================
// 
// $File$
// 
// Owner: DBerggren
// 
// $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.
// 
// 
// an interface to be used off of export commands
// to output multiple pages from multiple open pubs -
// basically a UIDRef list for outputing pages
// from multiple open pubs (possibly from a book)
// 
//========================================================================================

#ifndef __IOutputPages__
#define __IOutputPages__

#include "IPMUnknown.h"
#include "DocFrameworkID.h"
#include "UIDRef.h"
#include "PMRect.h"
#include "PMString.h"
#include "UIDList.h"

class IDataBase;
class IPMStream;

class IOutputPages : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IOUTPUTPAGES };

 // -----------------------------
 // Start/End
 // -----------------------------
 virtual void Start() = 0;

 virtual void End() = 0;

 // -----------------------------
 // Master Database
 // -----------------------------
 virtual IDataBase* GetMasterDataBase(void) = 0;
 
 virtual void SetMasterDataBase(IDataBase* iDataBase) = 0;


 // -----------------------------
 // IsSpreads
 // -----------------------------
 virtual bool16 GetIsSpreads(void) const = 0;
 
 virtual void SetIsSpreads(const bool16 bIsSpreads) = 0;

 // -----------------------------
 // Which pages/spreads to output methods
 // -----------------------------
 virtual void InitializeFrom( const UIDList& listPages, bool16 bSpreads ) = 0;

 virtual void InsertOutputPageUIDRef(const UIDRef& uidRef) = 0;

 virtual void AppendOutputPageUIDRef(const UIDRef& uidRef) = 0;

 virtual void AppendOutputPageUIDRef2(const UIDRef& uidRef, const IDFile* sysFile, const PMRect& pageBounds) = 0;

 virtual void RemoveUIDRef(const int32 index) = 0;

 virtual void Clear(void) = 0;

 virtual int32 Location(const UIDRef& uidRef) const = 0;

 virtual int32 Number(void) const = 0;

 virtual UIDRef GetNthUIDRef(const int32 index, bool16 bValidateDataBase = kTrue) const = 0;
 
 virtual IDFile* GetNthSysFile(const int32 index) = 0;
 
 virtual void SetNthOutputPageBounds(const int32 index, const PMRect& pageBounds) = 0;
 
 virtual PMRect GetNthOutputPageBounds(const int32 index) const = 0;
 
 // -----------------------------
 // Page information methods
 // -----------------------------
 virtual bool16 GetContiguousPages(void) const = 0;
 
 virtual void SetContiguousPages(const bool16 bContiguousPages) = 0;

 virtual bool16 GetUniformSizePages(void) = 0;
 
 virtual void SetUniformSizePages(const bool16 bUniformSizePages) = 0;

 // -----------------------------
 // Document/Book name methods
 // -----------------------------
 virtual void GetName(PMString& name) const = 0;
 
 virtual void SetName(const PMString& name) = 0;

 // -----------------------------
 // Output stream methods
 // -----------------------------
 virtual IPMStream* GetOutputStream(void) const = 0;

 virtual void SetOutputStream(IPMStream *outputStream) = 0;

 // -----------------------------
 // Utility methods
 // -----------------------------
 virtual void Copy(IOutputPages* other) = 0;

 virtual void InitializeFrom( IOutputPages* pSrc, bool16 bConvertToSpreads ) = 0;

 virtual void SetOutputFile(IDFile& sysFile, bool16 validFile = kFalse) = 0;

 virtual IDFile GetOutputFile(bool16& isValidOutputFile) = 0;

 virtual void ReverseOrder() = 0;
};

#endif // __IOutputPages__