IDocumentUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: hhorton
// 
// $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 _H_IDocumentUtils
#define _H_IDocumentUtils

#include "IPMUnknown.h"
#include "ShuksanID.h"
#include "Utils.h"

class IDocFileHandler;
class IDocument;
class PMString;
class Sysfile;


class IDocumentUtils : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IDOCUMENTUTILS };
 
 enum WhatToClose {
 kCloseDocOnly = (1 << 0),
 kCloseLibrariesOnly = (1 << 1),
 kCloseBooksOnly = (1 << 2),
 kCloseBooksAndLibrariesOnly = (kCloseBooksOnly | kCloseLibrariesOnly),
 kCloseDocAndBooks = (kCloseDocOnly | kCloseBooksOnly),
 kCloseDocAndLibraries = (kCloseDocOnly | kCloseLibrariesOnly),
 kCloseAll = (kCloseDocOnly | kCloseBooksOnly | kCloseLibrariesOnly)
 };

 enum {
 kCropProxyImages = (1 << 0),
 kResampleProxiesOfScaledImages= (1 << 1),
 kDeleteUnusedMasterPages = (1 << 2),
 kDeleteUnusedSwatches = (1 << 3),
 kDeleteUnusedXMLTags = (1 << 4),
 kDeleteUnusedLayers = (1 << 5),
 kOptimizeEverything = 0xFFFF
 };

 enum PromptForSave { kDontSaveAll, kAsk, kSaveAll, kSaveAllDontAsk } ;

 virtual bool16 CheckOnClose(IDocument *doc, bool16 allowCancel = kTrue) = 0;

 virtual ErrorCode DoSaveAs(IDocument *doc) = 0;

 virtual ErrorCode DoSave(IDocument *doc) = 0;

 virtual ErrorCode DoSaveACopy(IDocument *doc) = 0;

 virtual bool16 IsAnyDocModified(void) = 0;

 virtual bool16 SaveAll(void) = 0;

 virtual bool16 SaveAllModified(bool16 abortOnErr = kFalse, bool16 reportErrs = kFalse, bool16 saveUntitled = kFalse) = 0;

 virtual bool16 CloseAll(bool16 allowCancel = kTrue, bool16 prompt = kTrue, WhatToClose closeWhat = kCloseDocOnly) = 0;

 virtual ErrorCode ProcessCloseAllAndQuit( bool16 allowCancel = kTrue, PromptForSave prompt = kAsk ) = 0 ;

 virtual ErrorCode ScheduleCloseAllAndQuit( bool16 allowCancel = kTrue, PromptForSave prompt = kAsk, ICommand::Priority priority = ICommand::kLowPriority ) = 0 ;

 virtual IDocFileHandler *QueryDocFileHandler(const UIDRef &doc) = 0;
 
#ifdef DEBUG

 virtual ErrorCode CheckAfterOpen(const IDFile& file, IDataBase *db) = 0;

 virtual ErrorCode CheckBeforeClose(IDataBase *db) = 0;

 virtual bool8 CheckForLeaks(IDataBase *db) = 0;


#endif
 virtual IDataBase::DBResultCode DocDBCallback(int32 stepsDone, int32 stepCount) = 0;

 virtual bool OptimizeForSize(IDocument *doc, uint32 options) = 0;

 virtual void LogAndSetDBError(ErrorCode errCode, IDataBase* db) = 0;

 virtual void LogAndSetDBError(ErrorCode errCode, const IDFile *file, IDataBase* db) = 0;
 
 virtual void GetTQMissingFontsOnDoc(IDocument* doc, std::vector<std::string> &fontAvailableOnTQ) = 0;

 virtual ErrorCode ValidateDocumentStructures(IDataBase* db, ClassID validateClassID = 0) = 0;
};

#endif /* _H_IDocumentUtils */