Public Member Functions | Protected Member Functions | List of all members
idoc::CSingleDocumentManagerBase Class Referenceabstract

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

#include <CSingleDocumentManagerBase.h>

Inheritance diagram for idoc::CSingleDocumentManagerBase:
idoc::CTmplBasedDocumentManagerBase imod::CSingleModelObserverBase idoc::IDocumentManager imod::IObserver istd::IChangeable idoc::IDocumentTypesInfo istd::IPolymorphic istd::IPolymorphic istd::IPolymorphic iqtdoc::TQtDocumentManagerWrap< idoc::CSingleDocumentManagerBase, iqtgui::TRestorableGuiWrap< iqtgui::TGuiComponentBase< QWidget > > > iqtdoc::CSingleDocumentWorkspaceGuiComp

Public Member Functions

 CSingleDocumentManagerBase ()
 
virtual idoc::IUndoManagerGetUndoManagerForDocument (const istd::IChangeable *documentPtr) const
 Return undo mananger for document documenPtr. More...
 
virtual int GetDocumentsCount () const
 Get number of opened documents. More...
 
virtual istd::IChangeableGetDocumentFromIndex (int index, DocumentInfo *documentInfoPtr=NULL) const
 Get document at specified index. More...
 
virtual int GetViewsCount (int documentIndex) const
 Get number of view for specified document. More...
 
virtual istd::IPolymorphicGetViewFromIndex (int documentIndex, int viewIndex) const
 Get single view using its and document indices. More...
 
virtual istd::IPolymorphicGetActiveView () const
 Return the active document. More...
 
virtual istd::IChangeableGetDocumentFromView (const istd::IPolymorphic &view, DocumentInfo *documentInfoPtr=NULL) const
 Return the document assigned to view. More...
 
virtual istd::IPolymorphicAddViewToDocument (const istd::IChangeable &document, const QByteArray &viewTypeId=QByteArray())
 Add a new view to the document. More...
 
virtual QByteArray GetDocumentTypeId (const istd::IChangeable &document) const
 Get ID of document type managed by this object. More...
 
virtual bool InsertNewDocument (const QByteArray &documentTypeId, bool createView=true, const QByteArray &viewTypeId="", istd::IChangeable **newDocumentPtr=NULL, bool beQuiet=false, bool *ignoredPtr=NULL)
 Creates a new document with the document ID documentTypeId. More...
 
virtual bool OpenDocument (const QByteArray *documentTypeIdPtr, const QString *fileNamePtr=NULL, bool createView=true, const QByteArray &viewTypeId="", istd::IChangeable **documentPtr=NULL, FileToTypeMap *loadedMapPtr=NULL, bool beQuiet=false, bool *ignoredPtr=NULL)
 Opens document(s) from the file list. More...
 
virtual bool SaveDocument (int documentIndex=-1, bool requestFileName=false, FileToTypeMap *savedMapPtr=NULL, bool beQuiet=false, bool *ignoredPtr=NULL)
 Save document. More...
 
virtual bool SaveDirtyDocuments (bool beQuiet=false, bool *ignoredPtr=NULL)
 Ask user (optional) and save all dirty (changed) documents. More...
 
virtual bool CloseDocument (int documentIndex=-1, bool beQuiet=false, bool *ignoredPtr=NULL)
 Close document and all its views. More...
 
virtual bool CloseView (istd::IPolymorphic *viewPtr=NULL, bool beQuiet=false, bool *ignoredPtr=NULL)
 Close view. More...
 
- Public Member Functions inherited from idoc::CTmplBasedDocumentManagerBase
 CTmplBasedDocumentManagerBase ()
 
virtual int GetAllowedOperationFlags (const istd::IPolymorphic *viewPtr=NULL) const
 Get flags of allowed operations. More...
 
virtual bool IsFeatureSupported (int featureFlags, const QByteArray &documentTypeId) const
 Return true, if the feature(s) is supported by this document template. More...
 
virtual Ids GetDocumentTypeIds () const
 Get list of supported document ID's can be created for specified file. More...
 
virtual QString GetDocumentTypeName (const QByteArray &documentTypeId) const
 Get human readable name of some document type ID. More...
 
virtual ifile::IFileTypeInfoGetDocumentFileTypeInfo (const QByteArray &documentTypeId) const
 Get file type information object for some selected document type. More...
 
virtual Ids GetDocumentTypeIdsForFile (const QString &filePath) const
 Get list of supported document ID's can be created for specified file. More...
 
virtual QString GetDefaultDirectory (const QString &sugestedDir="", const QByteArray *documentTypeIdPtr=NULL) const
 Return default directory for specified document type. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Protected Member Functions

virtual bool OpenSingleDocument (const QString &filePath, bool createView, const QByteArray &viewTypeId, QByteArray &documentTypeId, bool beQuiet, bool *ignoredPtr)
 Open single document using its file path. More...
 
bool NewDocument (const QByteArray &documentTypeId, bool createView, const QByteArray &viewTypeId, bool initialize, bool beQuiet, bool *ignoredPtr)
 Create instance of specified document without attaching to this manager. More...
 
bool RegisterDocument ()
 Register (attach) created document as new working document. More...
 
void EnsureViewRemoved ()
 
QString GetCurrentDocumentFilePath () const
 
bool HasDocumentPendingChanges () const
 
virtual void OnUpdate (const istd::IChangeable::ChangeSet &changeSet)
 Called on update of observed model. More...
 
virtual void OnViewRegistered (istd::IPolymorphic *viewPtr)=0
 Called after view is registered. More...
 
virtual void OnViewRemoved (istd::IPolymorphic *viewPtr)=0
 Called before view is removed. More...
 
virtual QString GetOpenFilePath (const QByteArray *documentTypeIdPtr=NULL) const =0
 Gets open file names. More...
 
virtual QString GetSaveFilePath (const QByteArray &documentTypeId, const istd::IChangeable *dataObjectPtr, const QString &currentFilePath) const =0
 Gets save file name. More...
 
virtual bool QueryDocumentSave (bool *ignoredPtr)=0
 Query user if this document can be closed. More...
 
bool SerializeOpenDocument (iser::IArchive &archive)
 Serializes open documents information. More...
 
- 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. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 
- Protected Member Functions inherited from imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value. More...
 
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model. More...
 
imod::IModelGetModelPtr () const
 Get access to observed model. More...
 
void EnsureModelDetached ()
 Make sure this observer is detached. More...
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed. More...
 
virtual bool IsModelAttached (const imod::IModel *modelPtr=NULL) const
 Check if specified model is attached. More...
 
virtual bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask)
 This call back function will be called, if an observable object is about to be attached. More...
 
virtual bool OnModelDetached (imod::IModel *modelPtr)
 This call back function will be called, if an observable object is about to be detached. More...
 
virtual void BeforeUpdate (imod::IModel *modelPtr)
 This function will be called before update of the observer contents occures. More...
 
virtual void AfterUpdate (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet)
 This function will be called after update of the observer contents occures. More...
 

Additional Inherited Members

- 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 mananger 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. More...
 
typedef QMap< QString, QByteArray > FileToTypeMap
 Map from file path to ducument type ID's. More...
 
- 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...
 
- Public Types inherited from idoc::IDocumentTypesInfo
enum  SupportedFeatures { SF_NEW_DOCUMENT = 0x0001, SF_EDIT_DOCUMENT = 0x0010, SF_DEFAULT = 0xffff }
 Enumeration for supported types of operation with the document. More...
 
typedef QVector< QByteArray > Ids
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- Static Protected Attributes inherited from imod::CSingleModelObserverBase
static const
istd::IChangeable::ChangeSet 
s_undoChanges
 

Detailed Description

Basic implementation of a template-based single document manager.

Definition at line 23 of file CSingleDocumentManagerBase.h.

Constructor & Destructor Documentation

idoc::CSingleDocumentManagerBase::CSingleDocumentManagerBase ( )

Member Function Documentation

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

Add a new view to the document.

Parameters
documentdocument instance
viewTypeIdID of view type, if it will be created.
Returns
Created view object

Implements idoc::IDocumentManager.

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

Close document and all its views.

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

Implements idoc::IDocumentManager.

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

Close view.

Parameters
viewPtrpointer to view should be closed or NULL if current active view should be closed.
beQuietif true, no user interaction will be done. Typically user will be asked for saving document.
ignoredPtroptional return flag indicating that closing was aborted by user.

Implements idoc::IDocumentManager.

void idoc::CSingleDocumentManagerBase::EnsureViewRemoved ( )
protected
virtual istd::IPolymorphic* idoc::CSingleDocumentManagerBase::GetActiveView ( ) const
virtual

Return the active document.

If no document is active, the function return a NULL

Implements idoc::IDocumentManager.

QString idoc::CSingleDocumentManagerBase::GetCurrentDocumentFilePath ( ) const
protected
virtual istd::IChangeable& idoc::CSingleDocumentManagerBase::GetDocumentFromIndex ( int  index,
DocumentInfo documentInfoPtr = NULL 
) const
virtual

Get document at specified index.

Parameters
indexindex of document.
documentInfoPtroptional return value describing some additional informations about document.

Implements idoc::IDocumentManager.

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

Return the document assigned to view.

Parameters
viewview object.
documentInfoPtroptional 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.

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

Get number of opened documents.

Implements idoc::IDocumentManager.

virtual QByteArray idoc::CSingleDocumentManagerBase::GetDocumentTypeId ( const istd::IChangeable document) const
virtual

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.

virtual QString idoc::CSingleDocumentManagerBase::GetOpenFilePath ( const QByteArray *  documentTypeIdPtr = NULL) const
protectedpure virtual

Gets open file names.

Implemented in iqtdoc::CSingleDocumentWorkspaceGuiComp.

virtual QString idoc::CSingleDocumentManagerBase::GetSaveFilePath ( const QByteArray &  documentTypeId,
const istd::IChangeable dataObjectPtr,
const QString &  currentFilePath 
) const
protectedpure virtual
virtual idoc::IUndoManager* idoc::CSingleDocumentManagerBase::GetUndoManagerForDocument ( const istd::IChangeable documentPtr) const
virtual

Return undo mananger for document documenPtr.

Implements idoc::IDocumentManager.

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

Get single view using its and document indices.

Implements idoc::IDocumentManager.

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

Get number of view for specified document.

Implements idoc::IDocumentManager.

bool idoc::CSingleDocumentManagerBase::HasDocumentPendingChanges ( ) const
protected
virtual bool idoc::CSingleDocumentManagerBase::InsertNewDocument ( const QByteArray &  documentTypeId,
bool  createView = true,
const QByteArray &  viewTypeId = "",
istd::IChangeable **  newDocumentPtr = NULL,
bool  beQuiet = false,
bool *  ignoredPtr = NULL 
)
virtual

Creates a new document with the document ID documentTypeId.

Parameters
documentTypeIdID of document type.
createViewif true, view will be automatically created.
viewTypeIdID of view type, if it will be created.
newDocumentPtroptional pointer where new created document will be returned.
beQuietif true, no user interaction will be done.
ignoredPtroptional return flag indicating that creating was aborted by user.
Returns
true, if success.

Implements idoc::IDocumentManager.

bool idoc::CSingleDocumentManagerBase::NewDocument ( const QByteArray &  documentTypeId,
bool  createView,
const QByteArray &  viewTypeId,
bool  initialize,
bool  beQuiet,
bool *  ignoredPtr 
)
protected

Create instance of specified document without attaching to this manager.

virtual void idoc::CSingleDocumentManagerBase::OnUpdate ( const istd::IChangeable::ChangeSet changeSet)
protectedvirtual

Called on update of observed model.

This method is designed to be overload by derrived classes.

Reimplemented from imod::CSingleModelObserverBase.

virtual void idoc::CSingleDocumentManagerBase::OnViewRegistered ( istd::IPolymorphic viewPtr)
protectedpure virtual

Called after view is registered.

Implemented in iqtdoc::CSingleDocumentWorkspaceGuiComp.

virtual void idoc::CSingleDocumentManagerBase::OnViewRemoved ( istd::IPolymorphic viewPtr)
protectedpure virtual

Called before view is removed.

Implemented in iqtdoc::CSingleDocumentWorkspaceGuiComp.

virtual bool idoc::CSingleDocumentManagerBase::OpenDocument ( const QByteArray *  documentTypeIdPtr,
const QString *  fileNamePtr = NULL,
bool  createView = true,
const QByteArray &  viewTypeId = "",
istd::IChangeable **  documentPtr = NULL,
FileToTypeMap loadedMapPtr = NULL,
bool  beQuiet = false,
bool *  ignoredPtr = NULL 
)
virtual

Opens document(s) from the file list.

Parameters
documentTypeIdPtroptional ID of document type. If it is NULL, document type will be found automatically.
fileNamePtrfile name.
createViewif true, view will be automatically created.
viewTypeIdID of view type, if it will be created.
loadedMapPtroptional list of loaded files and its document type ID's.
beQuietif true, no user interaction will be done.
ignoredPtroptional return flag indicating that opening was aborted by user.

Implements idoc::IDocumentManager.

virtual bool idoc::CSingleDocumentManagerBase::OpenSingleDocument ( const QString &  filePath,
bool  createView,
const QByteArray &  viewTypeId,
QByteArray &  documentTypeId,
bool  beQuiet,
bool *  ignoredPtr 
)
protectedvirtual

Open single document using its file path.

Parameters
filePathfile path.
createViewif true, instance of view will be created.
viewTypeIdoptional view type ID should be created.
documentTypeIdoutput parameter returning loaded ducument type ID.
Returns
instance of created document or NULL if error is occured.
virtual bool idoc::CSingleDocumentManagerBase::QueryDocumentSave ( bool *  ignoredPtr)
protectedpure virtual

Query user if this document can be closed.

Parameters
ignoredPtroptional return flag indicating that user ignored this close operation.

Implemented in iqtdoc::CSingleDocumentWorkspaceGuiComp.

bool idoc::CSingleDocumentManagerBase::RegisterDocument ( )
protected

Register (attach) created document as new working document.

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

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

Parameters
beQuietif true, no user interaction will be done. Typically user will be asked for saving document.
ignoredPtroptional return flag indicating that process was aborted by user.
Returns
true if all documents were saved and are not dirty now.

Implements idoc::IDocumentManager.

virtual bool idoc::CSingleDocumentManagerBase::SaveDocument ( int  documentIndex = -1,
bool  requestFileName = false,
FileToTypeMap savedMapPtr = NULL,
bool  beQuiet = false,
bool *  ignoredPtr = NULL 
)
virtual

Save document.

Parameters
documentIndexoptional index of document to save, if negative then current active document will be saved.
requestFileNameif true, file name will be always requested by user.
savedMapPtroptional list of files will be extended with currently saved file.
beQuietif true, no user interaction will be done.
ignoredPtroptional return flag indicating that saving was aborted by user.

Implements idoc::IDocumentManager.

bool idoc::CSingleDocumentManagerBase::SerializeOpenDocument ( iser::IArchive archive)
protected

Serializes open documents information.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy