Classes | Public Types | Public Member Functions | List of all members
idoc::IDocumentManager Class Referenceabstract

Provide set of user actions needed to manage documents in MVC (Model View Controller) concept. More...

#include <IDocumentManager.h>

Inheritance diagram for idoc::IDocumentManager:
istd::IChangeable idoc::IDocumentTypesInfo istd::IPolymorphic istd::IPolymorphic idoc::CTmplBasedDocumentManagerBase idoc::CMultiDocumentManagerBase idoc::CSingleDocumentManagerBase iqtdoc::TQtDocumentManagerWrap< idoc::CMultiDocumentManagerBase, iqtgui::TRestorableGuiWrap< iqtgui::TGuiComponentBase< QMdiArea > > > iqtdoc::TQtDocumentManagerWrap< idoc::CSingleDocumentManagerBase, iqtgui::TRestorableGuiWrap< iqtgui::TGuiComponentBase< QWidget > > > iqtdoc::CMultiDocumentWorkspaceGuiComp iqtdoc::CSingleDocumentWorkspaceGuiComp

Classes

struct  DocumentInfo
 

Public Types

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
 

Public Member Functions

virtual int GetAllowedOperationFlags (const istd::IPolymorphic *viewPtr=NULL) const =0
 Get flags of allowed operations. More...
 
virtual idoc::IUndoManagerGetUndoManagerForDocument (const istd::IChangeable *documentPtr) const =0
 Return undo mananger for document documenPtr. More...
 
virtual int GetDocumentsCount () const =0
 Get number of opened documents. More...
 
virtual istd::IChangeableGetDocumentFromIndex (int index, DocumentInfo *documentInfoPtr=NULL) const =0
 Get document at specified index. More...
 
virtual int GetViewsCount (int documentIndex) const =0
 Get number of view for specified document. More...
 
virtual istd::IPolymorphicGetViewFromIndex (int documentIndex, int viewIndex) const =0
 Get single view using its and document indices. More...
 
virtual istd::IPolymorphicGetActiveView () const =0
 Return the active document. More...
 
virtual istd::IChangeableGetDocumentFromView (const istd::IPolymorphic &view, DocumentInfo *documentInfoPtr=NULL) const =0
 Return the document assigned to view. More...
 
virtual istd::IPolymorphicAddViewToDocument (const istd::IChangeable &document, const QByteArray &viewTypeId=QByteArray())=0
 Add a new view to the document. More...
 
virtual QByteArray GetDocumentTypeId (const istd::IChangeable &document) const =0
 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)=0
 Creates a new document with the document ID documentTypeId. More...
 
virtual bool OpenDocument (const QByteArray *documentTypeIdPtr=NULL, const QString *fileNamePtr=NULL, bool createView=true, const QByteArray &viewTypeId="", istd::IChangeable **documentPtr=NULL, FileToTypeMap *loadedMapPtr=NULL, bool beQuiet=false, bool *ignoredPtr=NULL)=0
 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)=0
 Save document. More...
 
virtual bool SaveDirtyDocuments (bool beQuiet=false, bool *ignoredPtr=NULL)=0
 Ask user (optional) and save all dirty (changed) documents. More...
 
virtual bool CloseDocument (int documentIndex=-1, bool beQuiet=false, bool *ignoredPtr=NULL)=0
 Close document and all its views. More...
 
virtual bool CloseView (istd::IPolymorphic *viewPtr=NULL, bool beQuiet=false, bool *ignoredPtr=NULL)=0
 Close view. 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 ()
 
- Public Member Functions inherited from idoc::IDocumentTypesInfo
virtual bool IsFeatureSupported (int featureFlags, const QByteArray &documentTypeId) const =0
 Return true, if the feature(s) is supported by this document template. More...
 
virtual Ids GetDocumentTypeIds () const =0
 Get list of supported document ID's can be created for specified file. More...
 
virtual QString GetDocumentTypeName (const QByteArray &documentTypeId) const =0
 Get human readable name of some document type ID. More...
 
virtual ifile::IFileTypeInfoGetDocumentFileTypeInfo (const QByteArray &documentTypeId) const =0
 Get file type information object for some selected document type. More...
 
virtual Ids GetDocumentTypeIdsForFile (const QString &filePath) const =0
 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 =0
 Return default directory for specified document type. More...
 

Additional Inherited Members

- 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 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...
 

Detailed Description

Provide set of user actions needed to manage documents in MVC (Model View Controller) concept.

Definition at line 25 of file IDocumentManager.h.

Member Typedef Documentation

typedef QMap<QString, QByteArray> idoc::IDocumentManager::FileToTypeMap

Map from file path to ducument type ID's.

Definition at line 64 of file IDocumentManager.h.

Member Enumeration Documentation

Possible changes in the mananger data model.

Enumerator
CF_DOCUMENT_RENAMED 
CF_DOCUMENT_CREATED 
CF_DOCUMENT_REMOVED 
CF_DOCUMENT_COUNT_CHANGED 
CF_VIEW_ACTIVATION_CHANGED 

Definition at line 33 of file IDocumentManager.h.

Flags describing possible operations.

Enumerator
OF_FILE_NEW 
OF_FILE_OPEN 
OF_FILE_SAVE 
OF_FILE_SAVE_AS 
OF_KNOWN_PATH 

Definition at line 52 of file IDocumentManager.h.

Member Function Documentation

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

Add a new view to the document.

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

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual bool idoc::IDocumentManager::CloseDocument ( int  documentIndex = -1,
bool  beQuiet = false,
bool *  ignoredPtr = NULL 
)
pure 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.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual bool idoc::IDocumentManager::CloseView ( istd::IPolymorphic viewPtr = NULL,
bool  beQuiet = false,
bool *  ignoredPtr = NULL 
)
pure 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.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual istd::IPolymorphic* idoc::IDocumentManager::GetActiveView ( ) const
pure virtual

Return the active document.

If no document is active, the function return a NULL

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual int idoc::IDocumentManager::GetAllowedOperationFlags ( const istd::IPolymorphic viewPtr = NULL) const
pure virtual

Get flags of allowed operations.

Implemented in idoc::CTmplBasedDocumentManagerBase.

virtual istd::IChangeable& idoc::IDocumentManager::GetDocumentFromIndex ( int  index,
DocumentInfo documentInfoPtr = NULL 
) const
pure virtual

Get document at specified index.

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

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual istd::IChangeable* idoc::IDocumentManager::GetDocumentFromView ( const istd::IPolymorphic view,
DocumentInfo documentInfoPtr = NULL 
) const
pure 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.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual int idoc::IDocumentManager::GetDocumentsCount ( ) const
pure virtual

Get number of opened documents.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual QByteArray idoc::IDocumentManager::GetDocumentTypeId ( const istd::IChangeable document) const
pure virtual

Get ID of document type managed by this object.

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

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

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

Return undo mananger for document documenPtr.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

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

Get single view using its and document indices.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual int idoc::IDocumentManager::GetViewsCount ( int  documentIndex) const
pure virtual

Get number of view for specified document.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual bool idoc::IDocumentManager::InsertNewDocument ( const QByteArray &  documentTypeId,
bool  createView = true,
const QByteArray &  viewTypeId = "",
istd::IChangeable **  newDocumentPtr = NULL,
bool  beQuiet = false,
bool *  ignoredPtr = NULL 
)
pure 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.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual bool idoc::IDocumentManager::OpenDocument ( const QByteArray *  documentTypeIdPtr = NULL,
const QString *  fileNamePtr = NULL,
bool  createView = true,
const QByteArray &  viewTypeId = "",
istd::IChangeable **  documentPtr = NULL,
FileToTypeMap loadedMapPtr = NULL,
bool  beQuiet = false,
bool *  ignoredPtr = NULL 
)
pure 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.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual bool idoc::IDocumentManager::SaveDirtyDocuments ( bool  beQuiet = false,
bool *  ignoredPtr = NULL 
)
pure 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.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.

virtual bool idoc::IDocumentManager::SaveDocument ( int  documentIndex = -1,
bool  requestFileName = false,
FileToTypeMap savedMapPtr = NULL,
bool  beQuiet = false,
bool *  ignoredPtr = NULL 
)
pure 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.

Implemented in idoc::CMultiDocumentManagerBase, and idoc::CSingleDocumentManagerBase.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy