Basic implementation of a template-based multiple document manager. More...

#include <CMultiDocumentManagerBase.h>

Inheritance diagram for idoc::CMultiDocumentManagerBase:

Classes
struct	SingleDocumentData
	Document data definition. More...

struct	ViewInfo

Public Types
enum	ModelId { MI_UNDO_MANAGER = 1 , MI_DOCUMENT }

Public Types inherited from idoc::IDocumentManager
enum	ChangeFlags { CF_DOCUMENT_RENAMED = 0x834d670 , CF_DOCUMENT_CREATED , CF_DOCUMENT_REMOVED , CF_DOCUMENT_COUNT_CHANGED , CF_VIEW_ACTIVATION_CHANGED }
	Possible changes in the manager data model. More...

enum	OperationFlags { OF_FILE_NEW = 0x0001 , OF_FILE_OPEN = 0x0002 , OF_FILE_SAVE = 0x0004 , OF_FILE_SAVE_AS = 0x0008 , OF_KNOWN_PATH = 0x0010 }
	Flags describing possible operations that can be performed by the document manager. More...

typedef QMap< QString, QByteArray >	FileToTypeMap
	Map from file path to document type ID's.

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Types inherited from idoc::IDocumentTypesInfo
enum	SupportedFeatures { SF_NEW_DOCUMENT = 0x0001 , SF_EDIT_DOCUMENT = 0x0010 , SF_DEFAULT = 0xffff }
	Enumeration for supported types of operations with documents. More...

typedef QVector< QByteArray >	Ids
	Type definition for document type ID collections.

Public Member Functions
	CMultiDocumentManagerBase ()
	Default constructor.

virtual idoc::IUndoManager *	GetUndoManagerForDocument (const istd::IChangeable *documentPtr) const override
	Return undo manager for document `documentPtr`.

virtual int	GetDocumentsCount () const override
	Get number of opened documents.

virtual istd::IChangeable &	GetDocumentFromIndex (int index, DocumentInfo *documentInfoPtr=NULL) const override
	Get document at specified index.

virtual int	GetViewsCount (int documentIndex) const override
	Get number of view for specified document.

virtual istd::IPolymorphic *	GetViewFromIndex (int documentIndex, int viewIndex) const override
	Get single view using its and document indices.

virtual istd::IPolymorphic *	GetActiveView () const override
	Return the active document.

virtual void	SetActiveView (istd::IPolymorphic *viewPtr) override
	Indicate that some view is active now.

virtual istd::IChangeable *	GetDocumentFromView (const istd::IPolymorphic &view, DocumentInfo *documentInfoPtr=NULL) const override
	Return the document assigned to view.

virtual istd::IPolymorphic *	AddViewToDocument (const istd::IChangeable &document, const QByteArray &viewTypeId=QByteArray()) override
	Add a new view to the document.

virtual QByteArray	GetDocumentTypeId (const istd::IChangeable &document) const override
	Get ID of document type managed by this object.

virtual bool	InsertNewDocument (const QByteArray &documentTypeId, bool createView=true, const QByteArray &viewTypeId="", istd::IChangeableSharedPtr newDocumentPtr=nullptr, bool beQuiet=false, bool ignoredPtr=NULL) override
	Creates a new document with the document ID `documentTypeId`.

virtual bool	OpenDocument (const QByteArray documentTypeIdPtr, const QString fileNamePtr=NULL, bool createView=true, const QByteArray &viewTypeId="", istd::IChangeableSharedPtr documentPtr=nullptr, FileToTypeMap loadedMapPtr=NULL, bool beQuiet=false, bool ignoredPtr=NULL, ibase::IProgressManager progressManagerPtr=NULL) override
	Opens document(s) from the file list.

virtual bool	SaveDocument (int documentIndex=-1, bool requestFileName=false, FileToTypeMap savedMapPtr=NULL, bool beQuiet=false, bool ignoredPtr=NULL, ibase::IProgressManager *progressManagerPtr=NULL) override
	Save document.

virtual bool	SaveDirtyDocuments (bool beQuiet=false, bool *ignoredPtr=NULL) override
	Ask user (optional) and save all dirty (changed) documents.

virtual bool	CloseDocument (int documentIndex=-1, bool beQuiet=false, bool *ignoredPtr=NULL) override
	Close document and all its views.

virtual bool	CloseView (istd::IPolymorphic viewPtr=NULL, bool beQuiet=false, bool ignoredPtr=NULL) override
	Close view.

Public Member Functions inherited from idoc::CTmplBasedDocumentManagerBase
	CTmplBasedDocumentManagerBase ()

virtual int	GetAllowedOperationFlags (const istd::IPolymorphic *viewPtr=NULL) const override
	Get flags of allowed operations.

virtual bool	IsFeatureSupported (int featureFlags, const QByteArray &documentTypeId) const override
	Return `true`, if the feature(s) is supported by this document template.

virtual Ids	GetDocumentTypeIds () const override
	Get list of supported document type IDs.

virtual QString	GetDocumentTypeName (const QByteArray &documentTypeId) const override
	Get human readable name of some document type ID.

virtual ifile::IFileTypeInfo *	GetDocumentFileTypeInfo (const QByteArray &documentTypeId) const override
	Get file type information object for some selected document type.

virtual Ids	GetDocumentTypeIdsForFile (const QString &filePath) const override
	Get list of supported document IDs that can handle the specified file.

virtual QString	GetDefaultDirectory (const QString &sugestedDir="", const QByteArray *documentTypeIdPtr=NULL) const override
	Return default directory for specified document type.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Types
typedef istd::IChangeableSharedPtr	DocumentPtr

typedef idoc::IUndoManagerSharedPtr	UndoManagerPtr

typedef idoc::IDocumentTemplate::ViewSharedPtr	ViewPtr

typedef QList< ViewInfo >	Views

typedef istd::TPointerVector< SingleDocumentData >	DocumentInfos

Protected Member Functions
virtual istd::IChangeableSharedPtr	OpenSingleDocument (const QString &filePath, bool createView, const QByteArray &viewTypeId, QByteArray &documentTypeId, bool beQuiet, bool ignoredPtr, ibase::IProgressManager progressManagerPtr)
	Open single document using its file path.

virtual void	CloseAllDocuments ()

SingleDocumentData &	GetSingleDocumentData (int index) const
	Get internal document data object.

SingleDocumentData *	GetActiveDocumentInfo () const
	Get document info assigned to active view.

SingleDocumentData *	GetDocumentInfoFromView (const istd::IPolymorphic &view) const
	Get document info assigned to specified view.

SingleDocumentData *	GetDocumentInfoFromPath (const QString &filePath) const
	Get document info assigned to specified file.

int	GetDocumentIndex (const SingleDocumentData &document) const
	Get position index of the given document in the document list.

virtual SingleDocumentData *	CreateUnregisteredDocument (const QByteArray &documentTypeId, bool createView, const QByteArray &viewTypeId, bool initialize, bool beQuiet, bool *ignoredPtr) const
	Create instance of specified document without attaching to this manager.

bool	RegisterDocument (SingleDocumentData *documentPtr)
	Register (attach) created document as new working document.

virtual void	OnViewRegistered (istd::IPolymorphic *viewPtr, const SingleDocumentData &documentData)=0
	Called after view is registered.

virtual void	OnViewRemoved (istd::IPolymorphic *viewPtr)=0
	Called before view is removed.

virtual QStringList	GetOpenFilePaths (const QByteArray *documentTypeIdPtr=NULL) const =0
	Gets open file names.

virtual QString	GetSaveFilePath (const QByteArray &documentTypeId, const istd::IChangeable *dataObjectPtr, const QString &currentFilePath) const =0
	Gets save file name.

virtual bool	QueryDocumentSave (const SingleDocumentData &info, bool *ignoredPtr)=0
	Query user if this document should be saved.

bool	SerializeOpenDocumentList (iser::IArchive &archive)
	Serializes open documents information.

virtual void	OnDocumentSaved ()
	Execute after document saved.

Protected Member Functions inherited from idoc::CTmplBasedDocumentManagerBase
virtual const idoc::IDocumentTemplate *	GetDocumentTemplate () const

void	SetDocumentTemplate (const idoc::IDocumentTemplate *documentTemplatePtr)

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Protected Attributes
DocumentInfos	m_documentInfos

istd::IPolymorphic *	m_activeViewPtr

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Detailed Description

Basic implementation of a template-based multiple document manager.

Definition at line 25 of file CMultiDocumentManagerBase.h.

Member Typedef Documentation

◆ DocumentInfos

typedef istd::TPointerVector<SingleDocumentData> idoc::CMultiDocumentManagerBase::DocumentInfos

protected

Definition at line 212 of file CMultiDocumentManagerBase.h.

◆ DocumentPtr

typedef istd::IChangeableSharedPtr idoc::CMultiDocumentManagerBase::DocumentPtr

protected

Definition at line 79 of file CMultiDocumentManagerBase.h.

◆ UndoManagerPtr

typedef idoc::IUndoManagerSharedPtr idoc::CMultiDocumentManagerBase::UndoManagerPtr

protected

Definition at line 80 of file CMultiDocumentManagerBase.h.

◆ ViewPtr

typedef idoc::IDocumentTemplate::ViewSharedPtr idoc::CMultiDocumentManagerBase::ViewPtr

protected

Definition at line 81 of file CMultiDocumentManagerBase.h.

◆ Views

typedef QList<ViewInfo> idoc::CMultiDocumentManagerBase::Views

protected

Definition at line 87 of file CMultiDocumentManagerBase.h.

Member Enumeration Documentation

◆ ModelId

enum idoc::CMultiDocumentManagerBase::ModelId

Enumerator
MI_UNDO_MANAGER
MI_DOCUMENT

Definition at line 28 of file CMultiDocumentManagerBase.h.

Constructor & Destructor Documentation

◆ CMultiDocumentManagerBase()

idoc::CMultiDocumentManagerBase::CMultiDocumentManagerBase ( )

Default constructor.

Member Function Documentation

◆ AddViewToDocument()

virtual istd::IPolymorphic * idoc::CMultiDocumentManagerBase::AddViewToDocument	(	const istd::IChangeable &	document,
		const QByteArray &	viewTypeId = `QByteArray()`
	)

overridevirtual

Add a new view to the document.

Parameters

document	document instance
viewTypeId	ID of view type, if it will be created.

Returns: Created view object

Implements idoc::IDocumentManager.

◆ CloseAllDocuments()

virtual void idoc::CMultiDocumentManagerBase::CloseAllDocuments ( )

protectedvirtual

Reimplemented in iqtdoc::CMultiDocumentWorkspaceGuiComp.

◆ CloseDocument()

virtual bool idoc::CMultiDocumentManagerBase::CloseDocument	(	int	documentIndex = `-1`,
		bool	beQuiet = `false`,
		bool *	ignoredPtr = `NULL`
	)

overridevirtual

Close document and all its views.

Parameters

documentIndex	optional index of document to close, if negative then current active document will be closed.
beQuiet	if true, no user interaction will be done. Typically user will be asked for saving document.
ignoredPtr	optional return flag indicating that closing was aborted by user.

Implements idoc::IDocumentManager.

◆ CloseView()

virtual bool idoc::CMultiDocumentManagerBase::CloseView	(	istd::IPolymorphic *	viewPtr = `NULL`,
		bool	beQuiet = `false`,
		bool *	ignoredPtr = `NULL`
	)

overridevirtual

Close view.

Parameters

viewPtr	pointer to view should be closed or `NULL` if current active view should be closed.
beQuiet	if true, no user interaction will be done. Typically user will be asked for saving document.
ignoredPtr	optional return flag indicating that closing was aborted by user.

Implements idoc::IDocumentManager.

◆ CreateUnregisteredDocument()

virtual SingleDocumentData * idoc::CMultiDocumentManagerBase::CreateUnregisteredDocument	(	const QByteArray &	documentTypeId,
		bool	createView,
		const QByteArray &	viewTypeId,
		bool	initialize,
		bool	beQuiet,
		bool *	ignoredPtr
	)		const

protectedvirtual

Create instance of specified document without attaching to this manager.

◆ GetActiveDocumentInfo()

SingleDocumentData * idoc::CMultiDocumentManagerBase::GetActiveDocumentInfo ( ) const

protected

Get document info assigned to active view.

◆ GetActiveView()

virtual istd::IPolymorphic * idoc::CMultiDocumentManagerBase::GetActiveView ( ) const

overridevirtual

Return the active document.

If no document is active, the function return a NULL

Implements idoc::IDocumentManager.

◆ GetDocumentFromIndex()

virtual istd::IChangeable & idoc::CMultiDocumentManagerBase::GetDocumentFromIndex	(	int	index,
		DocumentInfo *	documentInfoPtr = `NULL`
	)		const

overridevirtual

Get document at specified index.

Parameters

index	Zero-based index of document (0 to GetDocumentsCount()-1).
documentInfoPtr	Optional pointer to receive additional information about the document.

Returns: Reference to the document at the specified index.

Example: for (int i = 0; i < docMgr->GetDocumentsCount(); ++i) {

idoc::IDocumentManager::DocumentInfo info;

istd::IChangeable& doc = docMgr->GetDocumentFromIndex(i, &info);

qDebug() << "Document" << i << "path:" << info.filePath;

}

istd::IChangeable
Common interface for data model objects, which can be changed.
Definition IChangeable.h:28

idoc::IDocumentManager::DocumentInfo
Information about a document managed by the document manager.
Definition IDocumentManager.h:121

idoc::IDocumentManager::DocumentInfo::filePath
QString filePath
Full file path of the document, empty if not saved yet.
Definition IDocumentManager.h:122

Implements idoc::IDocumentManager.

◆ GetDocumentFromView()

virtual istd::IChangeable * idoc::CMultiDocumentManagerBase::GetDocumentFromView	(	const istd::IPolymorphic &	view,
		DocumentInfo *	documentInfoPtr = `NULL`
	)		const

overridevirtual

Return the document assigned to view.

Parameters

view	view object.
documentInfoPtr	optional return value describing some additional informations about document.

Returns: pointer to assigned document, or NULL if no document for this view exists.

Implements idoc::IDocumentManager.

◆ GetDocumentIndex()

int idoc::CMultiDocumentManagerBase::GetDocumentIndex ( const SingleDocumentData & document ) const

protected

Get position index of the given document in the document list.

◆ GetDocumentInfoFromPath()

SingleDocumentData * idoc::CMultiDocumentManagerBase::GetDocumentInfoFromPath ( const QString & filePath ) const

protected

Get document info assigned to specified file.

◆ GetDocumentInfoFromView()

SingleDocumentData * idoc::CMultiDocumentManagerBase::GetDocumentInfoFromView ( const istd::IPolymorphic & view ) const

protected

Get document info assigned to specified view.

◆ GetDocumentsCount()

virtual int idoc::CMultiDocumentManagerBase::GetDocumentsCount ( ) const

overridevirtual

Get number of opened documents.

Returns: The total count of currently open documents managed by this manager.

Implements idoc::IDocumentManager.

◆ GetDocumentTypeId()

virtual QByteArray idoc::CMultiDocumentManagerBase::GetDocumentTypeId ( const istd::IChangeable & document ) const

overridevirtual

Get ID of document type managed by this object.

Returns: ID of document type or empty string if no document is found.

Implements idoc::IDocumentManager.

◆ GetOpenFilePaths()

virtual QStringList idoc::CMultiDocumentManagerBase::GetOpenFilePaths ( const QByteArray * documentTypeIdPtr = NULL ) const

protectedpure virtual

Gets open file names.

Implemented in iqtdoc::CMultiDocumentWorkspaceGuiComp.

◆ GetSaveFilePath()

virtual QString idoc::CMultiDocumentManagerBase::GetSaveFilePath	(	const QByteArray &	documentTypeId,
		const istd::IChangeable *	dataObjectPtr,
		const QString &	currentFilePath
	)		const

protectedpure virtual

Gets save file name.

Implemented in iqtdoc::TQtDocumentManagerWrap< idoc::CMultiDocumentManagerBase, iqtgui::TRestorableGuiWrap< iqtgui::TGuiComponentBase< QMdiArea > > >.

◆ GetSingleDocumentData()

SingleDocumentData & idoc::CMultiDocumentManagerBase::GetSingleDocumentData ( int index ) const

protected

Get internal document data object.

◆ GetUndoManagerForDocument()

virtual idoc::IUndoManager * idoc::CMultiDocumentManagerBase::GetUndoManagerForDocument ( const istd::IChangeable * documentPtr ) const

overridevirtual

Return undo manager for document documentPtr.

Parameters

documentPtr Pointer to the document to get undo manager for.

Returns: Pointer to the undo manager associated with this document, or NULL if no undo manager exists.

Each document can have its own undo manager to track and reverse changes.

Example: istd::IChangeable* doc = docMgr->GetDocumentFromView(*view);

idoc::IUndoManager* undoMgr = docMgr->GetUndoManagerForDocument(doc);

if (undoMgr && undoMgr->GetAvailableUndoSteps() > 0) {

undoMgr->DoUndo();

}

idoc::IUndoManager
Interface providing UNDO/REDO functionality.
Definition IUndoManager.h:70

idoc::IUndoManager::DoUndo
virtual bool DoUndo(int steps=1)=0
Process UNDO steps.

idoc::IUndoManager::GetAvailableUndoSteps
virtual int GetAvailableUndoSteps() const =0
Get number of available UNDO levels.

Implements idoc::IDocumentManager.

◆ GetViewFromIndex()

virtual istd::IPolymorphic * idoc::CMultiDocumentManagerBase::GetViewFromIndex	(	int	documentIndex,
		int	viewIndex
	)		const

overridevirtual

Get single view using its and document indices.

Implements idoc::IDocumentManager.

◆ GetViewsCount()

virtual int idoc::CMultiDocumentManagerBase::GetViewsCount ( int documentIndex ) const

overridevirtual

Get number of view for specified document.

Implements idoc::IDocumentManager.

◆ InsertNewDocument()

virtual bool idoc::CMultiDocumentManagerBase::InsertNewDocument	(	const QByteArray &	documentTypeId,
		bool	createView = `true`,
		const QByteArray &	viewTypeId = `""`,
		istd::IChangeableSharedPtr *	newDocumentPtr = `nullptr`,
		bool	beQuiet = `false`,
		bool *	ignoredPtr = `NULL`
	)

overridevirtual

Creates a new document with the document ID documentTypeId.

Parameters

documentTypeId	ID of document type.
createView	if true, view will be automatically created.
viewTypeId	ID of view type, if it will be created.
newDocumentPtr	optional pointer where new created document will be returned.
beQuiet	if true, no user interaction will be done.
ignoredPtr	optional return flag indicating that creating was aborted by user.

Returns: true, if success.

Implements idoc::IDocumentManager.

◆ OnDocumentSaved()

virtual void idoc::CMultiDocumentManagerBase::OnDocumentSaved ( )

protectedvirtual

Execute after document saved.

◆ OnViewRegistered()

virtual void idoc::CMultiDocumentManagerBase::OnViewRegistered	(	istd::IPolymorphic *	viewPtr,
		const SingleDocumentData &	documentData
	)

protectedpure virtual

Called after view is registered.

Implemented in iqtdoc::CMultiDocumentWorkspaceGuiComp.

◆ OnViewRemoved()

virtual void idoc::CMultiDocumentManagerBase::OnViewRemoved ( istd::IPolymorphic * viewPtr )

protectedpure virtual

Called before view is removed.

Implemented in iqtdoc::CMultiDocumentWorkspaceGuiComp.

◆ OpenDocument()

virtual bool idoc::CMultiDocumentManagerBase::OpenDocument	(	const QByteArray *	documentTypeIdPtr,
		const QString *	fileNamePtr = `NULL`,
		bool	createView = `true`,
		const QByteArray &	viewTypeId = `""`,
		istd::IChangeableSharedPtr *	documentPtr = `nullptr`,
		FileToTypeMap *	loadedMapPtr = `NULL`,
		bool	beQuiet = `false`,
		bool *	ignoredPtr = `NULL`,
		ibase::IProgressManager *	progressManagerPtr = `NULL`
	)

overridevirtual

Opens document(s) from the file list.

Parameters

documentTypeIdPtr	optional ID of document type. If it is NULL, document type will be found automatically.
fileNamePtr	file name.
createView	if true, view will be automatically created.
viewTypeId	ID of view type, if it will be created.
loadedMapPtr	optional list of loaded files and its document type ID's.
beQuiet	if true, no user interaction will be done.
ignoredPtr	optional return flag indicating that opening was aborted by user.

Implements idoc::IDocumentManager.

◆ OpenSingleDocument()

virtual istd::IChangeableSharedPtr idoc::CMultiDocumentManagerBase::OpenSingleDocument	(	const QString &	filePath,
		bool	createView,
		const QByteArray &	viewTypeId,
		QByteArray &	documentTypeId,
		bool	beQuiet,
		bool *	ignoredPtr,
		ibase::IProgressManager *	progressManagerPtr
	)

protectedvirtual

Open single document using its file path.

Parameters

filePath	file path.
createView	if true, instance of view will be created.
viewTypeId	optional view type ID should be created.
documentTypeId	output parameter returning loaded ducument type ID.

Returns: instance of created document or NULL if error occurred.

Reimplemented in iqtdoc::CMultiDocumentWorkspaceGuiComp.

◆ QueryDocumentSave()

virtual bool idoc::CMultiDocumentManagerBase::QueryDocumentSave	(	const SingleDocumentData &	info,
		bool *	ignoredPtr
	)

protectedpure virtual

Query user if this document should be saved.

Parameters

info	document info of document will be closed.
ignoredPtr	optional return flag indicating that user ignored this close operation.

Implemented in iqtdoc::CMultiDocumentWorkspaceGuiComp.

◆ RegisterDocument()

bool idoc::CMultiDocumentManagerBase::RegisterDocument ( SingleDocumentData * documentPtr )

protected

Register (attach) created document as new working document.

◆ SaveDirtyDocuments()

virtual bool idoc::CMultiDocumentManagerBase::SaveDirtyDocuments	(	bool	beQuiet = `false`,
		bool *	ignoredPtr = `NULL`
	)

overridevirtual

Ask user (optional) and save all dirty (changed) documents.

Parameters

beQuiet	if true, no user interaction will be done. Typically user will be asked for saving document.
ignoredPtr	optional return flag indicating that process was aborted by user.

Returns: true if all documents were saved and are not dirty now.

Implements idoc::IDocumentManager.

◆ SaveDocument()

virtual bool idoc::CMultiDocumentManagerBase::SaveDocument	(	int	documentIndex = `-1`,
		bool	requestFileName = `false`,
		FileToTypeMap *	savedMapPtr = `NULL`,
		bool	beQuiet = `false`,
		bool *	ignoredPtr = `NULL`,
		ibase::IProgressManager *	progressManagerPtr = `NULL`
	)

overridevirtual

Save document.

Parameters

documentIndex	optional index of document to save, if negative then current active document will be saved.
requestFileName	if true, file name will be always requested by user.
savedMapPtr	optional list of files will be extended with currently saved file.
beQuiet	if true, no user interaction will be done.
ignoredPtr	optional return flag indicating that saving was aborted by user.

Implements idoc::IDocumentManager.

◆ SerializeOpenDocumentList()

bool idoc::CMultiDocumentManagerBase::SerializeOpenDocumentList ( iser::IArchive & archive )

protected

Serializes open documents information.

◆ SetActiveView()

virtual void idoc::CMultiDocumentManagerBase::SetActiveView ( istd::IPolymorphic * viewPtr )

overridevirtual

Indicate that some view is active now.

Implements idoc::IDocumentManager.

Reimplemented in iqtdoc::CMultiDocumentWorkspaceGuiComp.

Member Data Documentation

◆ m_activeViewPtr

istd::IPolymorphic* idoc::CMultiDocumentManagerBase::m_activeViewPtr

protected

Definition at line 216 of file CMultiDocumentManagerBase.h.

◆ m_documentInfos

DocumentInfos idoc::CMultiDocumentManagerBase::m_documentInfos

protected

Definition at line 214 of file CMultiDocumentManagerBase.h.

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

Acf/Include/idoc/CMultiDocumentManagerBase.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DocumentInfos

◆ DocumentPtr

◆ UndoManagerPtr

◆ ViewPtr

◆ Views

Member Enumeration Documentation

◆ ModelId

Constructor & Destructor Documentation

◆ CMultiDocumentManagerBase()

Member Function Documentation

◆ AddViewToDocument()

◆ CloseAllDocuments()

◆ CloseDocument()

◆ CloseView()

◆ CreateUnregisteredDocument()

◆ GetActiveDocumentInfo()

◆ GetActiveView()

◆ GetDocumentFromIndex()

◆ GetDocumentFromView()

◆ GetDocumentIndex()

◆ GetDocumentInfoFromPath()

◆ GetDocumentInfoFromView()

◆ GetDocumentsCount()

◆ GetDocumentTypeId()

◆ GetOpenFilePaths()

◆ GetSaveFilePath()

◆ GetSingleDocumentData()

◆ GetUndoManagerForDocument()

◆ GetViewFromIndex()

◆ GetViewsCount()

◆ InsertNewDocument()

◆ OnDocumentSaved()

◆ OnViewRegistered()

◆ OnViewRemoved()

◆ OpenDocument()

◆ OpenSingleDocument()

◆ QueryDocumentSave()

◆ RegisterDocument()

◆ SaveDirtyDocuments()

◆ SaveDocument()

◆ SerializeOpenDocumentList()

◆ SetActiveView()

Member Data Documentation

◆ m_activeViewPtr

◆ m_documentInfos