IDocumentList Class Reference

#include <IDocumentList.h>

Inheritance diagram for IDocumentList:

Public Types
enum	UIFlags {   kAskMissing, kIgnoreMissing, kCancelMissing, kForceIgnoreMissing,   kDontCheck }

Public Member Functions
virtual int32	GetDocCount (bool16 bClosePlacedINDDFiles=kFalse) const =0
virtual IDocument *	GetNthDoc (int32 n)=0
virtual IDocument *	FindDoc (const IDFile &whatFile) const =0
virtual IDocument *	FindDocByDataBase (IDataBase *db) const =0
virtual IDocument *	FindDocFromPreviousVersion (const IDFile &whatFile)=0
virtual IDocument *	NewDoc (const ClassID &docClassID, IDataBase::ProtectionLevel protection, void *fileInfo=nil, IDocument::UndoSupport undoSupport=IDocument::kFullUndoSupport)=0
virtual IDocument *	OpenDoc (const IDFile &whatFile, IDataBase::ProtectionLevel protection, bool16 bOpenOriginal=true, UIFlags alertMissingPlugIns=kAskMissing, bool16 bUseLockFile=kTrue, IDocument::UndoSupport undoSupport=IDocument::kFullUndoSupport)=0
virtual IDocument *	OpenDocClone (IDataBase *db, const PMString &docName)=0
virtual IDocument *	RecoverDoc (const IDFile *pubFile, const IDFile *miniSaveFile, IDataBase::ProtectionLevel protection, void *fileInfo=nil, bool16 bIsFauxUserFile=kFalse, IDocument::UndoSupport undoSupport=IDocument::kFullUndoSupport)=0
virtual void	CloseDoc (IDocument *doc)=0
virtual void	CloseDocClone (IDocument *doc)=0
virtual void	CloseAll ()=0
virtual void	PurgeMemory (int32 level)=0
virtual IDocument *	FindDoc (const std::string &assetRef) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

IID_IDOCUMENTLIST interface store a list of open documents.

Member Enumeration Documentation

enum IDocumentList::UIFlags

UI flag, used for handling missing plug-in conditions

Enumerator
kIgnoreMissing	ask the user how to handle missing plug-ins
kCancelMissing	ignore any missing plug-ins
kForceIgnoreMissing	cancel open if there are default or critical plug-ins missing
kDontCheck	force ignore of missing plug-ins for this and all subsequent opens of this doc

Member Function Documentation

virtual void IDocumentList::CloseAll ( )

pure virtual

Close all open documents

Parameters

none

virtual void IDocumentList::CloseDoc ( IDocument *  doc )

pure virtual

Close the document

Note

Third Party Developers should use a command (such as kCloseDocCmdBoss) instead. IDocumentCommands contains command generator methods for convenience.

See Also

IDocumentCommands.h

Parameters

doc	Document to close

virtual void IDocumentList::CloseDocClone ( IDocument *  doc )

pure virtual

Close document clone

Parameters

doc	Document to close

virtual IDocument* IDocumentList::FindDoc ( const IDFile &  whatFile ) const

pure virtual

Find the document with the document file. Search to see if one (whatFile) is already open. If so, return it

Parameters

whatFile

IDFile.

Returns

IDocument the open documents

virtual IDocument* IDocumentList::FindDoc ( const std::string &  assetRef ) const

pure virtual

 Find the document with the asset Ref

         Search  to see if one (whatFile) is already open. If so, return it

Parameters

assetRef

Cloud asset URI

virtual IDocument* IDocumentList::FindDocByDataBase ( IDataBase *  db ) const

pure virtual

Find the document with the database. Search to see if one (db) is already open. If so, return it

Parameters

db	IDataBase.

Returns

IDocument the open documents

virtual IDocument* IDocumentList::FindDocFromPreviousVersion ( const IDFile &  whatFile )

pure virtual

Search the open documents to see if one is already open(document could be previous version). If so, return it.

Parameters

whatFile

IDFile

Returns

IDocument the open document

virtual int32 IDocumentList::GetDocCount ( bool16  bClosePlacedINDDFiles = kFalse ) const

pure virtual

Get number of open documents. Headless documents are counted.

Parameters

bClosePlacedINDDFiles,:

If kTrue, closes any placed INDD files that may be opened, before counting the number of opened documents

Returns

int32 the number of documents in the list

See Also

ILayoutUIUtils.h, GetUIDocumentWindowCount

virtual IDocument* IDocumentList::GetNthDoc ( int32  n )

pure virtual

Get n'th document

Parameters

n	index of of the document (0-based)

Returns

IDocument the n'th document

virtual IDocument* IDocumentList::NewDoc ( const ClassID &  docClassID, IDataBase::ProtectionLevel  protection, void *  fileInfo = nil, IDocument::UndoSupport  undoSupport = IDocument::kFullUndoSupport  )

pure virtual

Create a new document. The new document is added to the document list. This method starts a transaction on the newly created database that has to be ended by the caller.

Note

Third Party Developers should use a command (such as kNewDocCmdBoss) instead. IDocumentCommands contains command generator methods for convenience.

See Also

IDocumentCommands.h

Parameters

docClassID	Document boss's class id
protection	DataBase's protection level, See IDataBase.h
fileInfo	(default=nil) for MAC, store file creator type and and pub type
undoSupport	(default=IDocument::kFullUndoSupport), indicates whether commands that change the document will appear on the undo menu

Returns

IDocument newly created document

virtual IDocument* IDocumentList::OpenDoc ( const IDFile &  whatFile, IDataBase::ProtectionLevel  protection, bool16  bOpenOriginal = true, UIFlags  alertMissingPlugIns = kAskMissing, bool16  bUseLockFile = kTrue, IDocument::UndoSupport  undoSupport = IDocument::kFullUndoSupport  )

pure virtual

Open a document; The new document is added to the document list; This method starts a transaction on the newly created database that has to be ended by the caller.

Note

Third Party Developers should use a command (such as kOpenDocCmdBoss) instead. IDocumentCommands contains command generator methods for convenience.

See Also

IDocumentCommands.h

Parameters

whatFile	IDFile to open
protection	DataBase's protection level, See IDataBase.h
bOpenOriginal	if kTrue(default), open original file otherwise, open a copy
alertMissingPlugIns	UIFlag, default = kAskMissing, alert if missing plugin is detected. kIgnoreMissing, Ignore missing plugin kCancelMissing, Cancel open when missing plugin kIgnoreMissing, Don't alert on missing plugin data from file kDontCheck, don't check missing plugins
bUseLockFile	default = kTrue, if use lock file
undoSupport	(default=IDocument::kFullUndoSupport), indicates whether commands that change the document will appear on the undo menu

Returns

IDocument opened document

virtual IDocument* IDocumentList::OpenDocClone ( IDataBase *  db, const PMString &  docName  )

pure virtual

Open a document clone; The new document is added to the document list;

Parameters

db	IDataBase
docName	name to use for the document

Returns

IDocument opened document

virtual void IDocumentList::PurgeMemory ( int32  level )

pure virtual

Purges unused memory in each of the documents

Parameters

level

levels from MemUtils.h

virtual IDocument* IDocumentList::RecoverDoc ( const IDFile *  pubFile, const IDFile *  miniSaveFile, IDataBase::ProtectionLevel  protection, void *  fileInfo = nil, bool16  bIsFauxUserFile = kFalse, IDocument::UndoSupport  undoSupport = IDocument::kFullUndoSupport  )

pure virtual

Recover and open a document identified by recoveryID This method starts a transaction on the newly created database that has to be ended by the caller.

Note

Third Party Developers should use a command (such as kRecoverDocumentCmdBoss) instead. IDocumentCommands contains command generator methods for convenience.

See Also

IDocumentCommands.h

Parameters

pubFile	IDFile to recover
miniSaveFile	IDFile stores mini save
protection	DataBase's protection level
fileInfo	(default=nil) for MAC, store file creator type and and pub type
bIsFauxUserFile(default=	kFlase), if is faux user file, (currently, incopy user file)
undoSupport	(default=IDocument::kFullUndoSupport), indicates whether commands that change the document will appear on the undo menu

Returns

IDocument recovered document