CFxDocumentManager Class Reference

#include <FxDocumentManager.h>

Public Types
enum	NewFlags { eNewDefault = 0x0, eNewImperial = 0x1 }
enum	OpenFlags { eOpenDefault = 0x0, eOpenRecover = 0x1, eOpenReadOnly = 0x2 }

Public Member Functions
	CFxDocumentManager (void)
virtual	~CFxDocumentManager (void)
virtual CFxDocument *	NewDocument (const CFxString &templateName, uintptr_t newFlags=eNewDefault, const OdPassword &password=OdPassword(), const CFxString &documentName=CFxString())=0
virtual CFxDocument *	OpenDocument (const CFxString &fileName, OdCodePageId *pCodepage, uintptr_t openFlags=eOpenDefault, const OdPassword &password=OdPassword())=0
virtual void	CloseDocument (CFxDocument *pDatabase)=0
virtual CFxDocument *	GetActiveDocument ()=0
virtual void	SetActiveDocument (CFxDocument *pDatabase)=0
virtual void	SetActiveDocument (CFxDocumentWindow *pDocumnetWindow)=0
virtual unsigned short	GetDocumentCount () const =0
virtual CFxDocument *	GetDocumentByIndex (unsigned short iIndex)=0
virtual CFxDocument *	GetDocumentByFxNumber (unsigned short iFxNumber)=0
virtual CFxDocument *	GetDocumentByFileName (const CFxString &fileName)=0
virtual CFxDocument *	GetFxDocument (const OdDbDatabase *pDB) const =0
virtual void	AddReactor (CFxDocumentManagerReactor *pReactor)=0
virtual void	RemoveReactor (CFxDocumentManagerReactor *pReactor)=0
virtual CFxDocumentIteratorPtr	CreateDocumentIterator ()=0

Detailed Description

Description: Document manager. Library: DDKERNEL

Definition at line 44 of file FxDocumentManager.h.

Member Enumeration Documentation

NewFlags

enum CFxDocumentManager::NewFlags

Enumerator
eNewDefault
eNewImperial

Definition at line 50 of file FxDocumentManager.h.

OpenFlags

enum CFxDocumentManager::OpenFlags

Enumerator
eOpenDefault
eOpenRecover
eOpenReadOnly

Definition at line 67 of file FxDocumentManager.h.

Constructor & Destructor Documentation

CFxDocumentManager()

CFxDocumentManager::CFxDocumentManager

(

void

)

~CFxDocumentManager()

virtual CFxDocumentManager::~CFxDocumentManager ( void  )

virtual

Member Function Documentation

AddReactor()

virtual void CFxDocumentManager::AddReactor ( CFxDocumentManagerReactor *  pReactor )

pure virtual

Description: Adds a reactor item to document. Arguments:

Parameters

pReactor

Input

CloseDocument()

virtual void CFxDocumentManager::CloseDocument ( CFxDocument *  pDatabase )

pure virtual

Description: Closes document. Arguments:

Parameters

pDatabase

Input

CreateDocumentIterator()

virtual CFxDocumentIteratorPtr CFxDocumentManager::CreateDocumentIterator ( )

pure virtual

Description: Creates document iterator. Return Value:

GetActiveDocument()

virtual CFxDocument* CFxDocumentManager::GetActiveDocument ( )

pure virtual

Description: Returns active document. Return Value:

GetDocumentByFileName()

virtual CFxDocument* CFxDocumentManager::GetDocumentByFileName ( const CFxString &  fileName )

pure virtual

Description: Returns document by file name. Arguments:

Parameters

fileName

Input Return Value:

GetDocumentByFxNumber()

virtual CFxDocument* CFxDocumentManager::GetDocumentByFxNumber ( unsigned short  iFxNumber )

pure virtual

Description: Returns document using FxNumber. Arguments:

Parameters

iFxNumber

Input Return Value:

GetDocumentByIndex()

virtual CFxDocument* CFxDocumentManager::GetDocumentByIndex ( unsigned short  iIndex )

pure virtual

Description: Returns document using specific index. Arguments:

Parameters

iIndex

Input Return Value:

GetDocumentCount()

virtual unsigned short CFxDocumentManager::GetDocumentCount ( ) const

pure virtual

Description: Returns the number of documents. Return Value:

GetFxDocument()

virtual CFxDocument* CFxDocumentManager::GetFxDocument ( const OdDbDatabase *  pDB ) const

pure virtual

Description: Returns document included in database. Arguments:

Parameters

pDB	Input Return Value:

NewDocument()

virtual CFxDocument* CFxDocumentManager::NewDocument ( const CFxString &  templateName, uintptr_t  newFlags = eNewDefault, const OdPassword &  password = OdPassword(), const CFxString &  documentName = CFxString()  )

pure virtual

Description: Creates new document and attaches it to database. Arguments:

Parameters

templateName	Input
newFlags	Input
password	Input
documentName	Input Return Value:

OpenDocument()

virtual CFxDocument* CFxDocumentManager::OpenDocument ( const CFxString &  fileName, OdCodePageId *  pCodepage, uintptr_t  openFlags = eOpenDefault, const OdPassword &  password = OdPassword()  )

pure virtual

Description: Opens document and attaches it to database. Arguments:

Parameters

fileName	Input
pCodepage	Input
openFlags	Input
password	Input Return Value:

RemoveReactor()

virtual void CFxDocumentManager::RemoveReactor ( CFxDocumentManagerReactor *  pReactor )

pure virtual

Description: Removes a reactor item to document. Arguments:

Parameters

pReactor

Input

SetActiveDocument() [1/2]

virtual void CFxDocumentManager::SetActiveDocument ( CFxDocument *  pDatabase )

pure virtual

Description: Sets active document through database knowledge. Arguments:

Parameters

pDatabase

Input

SetActiveDocument() [2/2]

virtual void CFxDocumentManager::SetActiveDocument ( CFxDocumentWindow *  pDocumnetWindow )

pure virtual

Description: Sets active document through QWidget knowledge. Arguments:

Parameters

pDocumnetWindow

Input

---

The documentation for this class was generated from the following file:

• FxDocumentManager.h