Public Member Functions | Protected Member Functions | List of all members
idoc::CSingleDocumentTemplateBase Class Reference

Base class implementing document template for single document type. More...

#include <CSingleDocumentTemplateBase.h>

Inheritance diagram for idoc::CSingleDocumentTemplateBase:
idoc::IDocumentTemplate idoc::IDocumentTypesInfo istd::IPolymorphic idoc::CSingleDocumentTemplateComp iqtdoc::CExtendedDocumentTemplateComp

Public Member Functions

 CSingleDocumentTemplateBase ()
 
const QByteArray & GetDocumentTypeId () const
 
virtual void SetSupportedFeatures (int featureFlags)
 
virtual void SetDocumentTypeId (const QByteArray &id)
 
virtual void SetDocumentTypeName (const QString &name)
 
virtual void SetViewTypeId (const QByteArray &id)
 
virtual void SetViewTypeName (const QString &name)
 
virtual void SetDefaultDirectory (const QString &defaultDirectory)
 
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...
 
virtual Ids GetViewTypeIds (const QByteArray &documentTypeId) const
 Return supported view type IDs for specified document type. More...
 
virtual QString GetViewTypeName (const QByteArray &documentTypeId, const QByteArray &viewTypeId) const
 Get human readable name of some view type ID. More...
 
- Public Member Functions inherited from idoc::IDocumentTemplate
virtual ifile::IFilePersistenceGetFileLoader (const QByteArray &documentTypeId) const =0
 Get file loader/saver for spacified document ID. More...
 
virtual istd::IChangeableCreateDocument (QByteArray &documentTypeId, bool initialize=true, bool beQuiet=false, bool *ignoredFlagPtr=NULL) const =0
 Creates a document instance for document type documentTypeId. More...
 
virtual istd::IPolymorphicCreateView (const QByteArray &documentTypeId, istd::IChangeable *documentPtr, const QByteArray &viewTypeId=QByteArray()) const =0
 Creates a view instance for document document of type viewTypeId. More...
 
virtual idoc::IUndoManagerCreateUndoManager (const QByteArray &documentTypeId, istd::IChangeable *documentPtr) const =0
 Creates an undo manger for a given document documentPtr. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Protected Member Functions

bool IsDocumentTypeSupported (const QByteArray &documentTypeId) const
 
bool IsViewTypeSupported (const QByteArray &viewTypeId) const
 

Additional Inherited Members

- 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
 

Detailed Description

Base class implementing document template for single document type.

Definition at line 20 of file CSingleDocumentTemplateBase.h.

Constructor & Destructor Documentation

idoc::CSingleDocumentTemplateBase::CSingleDocumentTemplateBase ( )

Member Function Documentation

virtual QString idoc::CSingleDocumentTemplateBase::GetDefaultDirectory ( const QString &  sugestedDir = "",
const QByteArray *  documentTypeIdPtr = NULL 
) const
virtual

Return default directory for specified document type.

Parameters
sugestedDirtemplate directory sugested by user.
documentTypeIdPtroptional ID of document type.

Implements idoc::IDocumentTypesInfo.

virtual ifile::IFileTypeInfo* idoc::CSingleDocumentTemplateBase::GetDocumentFileTypeInfo ( const QByteArray &  documentTypeId) const
virtual

Get file type information object for some selected document type.

Parameters
documentTypeIdID of document type as returned by GetDocumentTypeIds().

Implements idoc::IDocumentTypesInfo.

const QByteArray & idoc::CSingleDocumentTemplateBase::GetDocumentTypeId ( ) const
inline

Definition at line 65 of file CSingleDocumentTemplateBase.h.

virtual Ids idoc::CSingleDocumentTemplateBase::GetDocumentTypeIds ( ) const
virtual

Get list of supported document ID's can be created for specified file.

Implements idoc::IDocumentTypesInfo.

virtual Ids idoc::CSingleDocumentTemplateBase::GetDocumentTypeIdsForFile ( const QString &  filePath) const
virtual

Get list of supported document ID's can be created for specified file.

Implements idoc::IDocumentTypesInfo.

Reimplemented in iqtdoc::CExtendedDocumentTemplateComp.

virtual QString idoc::CSingleDocumentTemplateBase::GetDocumentTypeName ( const QByteArray &  documentTypeId) const
virtual

Get human readable name of some document type ID.

Parameters
documentTypeIdID of document type as returned by GetDocumentTypeIds().

Implements idoc::IDocumentTypesInfo.

virtual Ids idoc::CSingleDocumentTemplateBase::GetViewTypeIds ( const QByteArray &  documentTypeId) const
virtual

Return supported view type IDs for specified document type.

Parameters
documentTypeIdID of document type.

Implements idoc::IDocumentTemplate.

virtual QString idoc::CSingleDocumentTemplateBase::GetViewTypeName ( const QByteArray &  documentTypeId,
const QByteArray &  viewTypeId 
) const
virtual

Get human readable name of some view type ID.

Implements idoc::IDocumentTemplate.

bool idoc::CSingleDocumentTemplateBase::IsDocumentTypeSupported ( const QByteArray &  documentTypeId) const
inlineprotected

Definition at line 73 of file CSingleDocumentTemplateBase.h.

virtual bool idoc::CSingleDocumentTemplateBase::IsFeatureSupported ( int  featureFlags,
const QByteArray &  documentTypeId 
) const
virtual

Return true, if the feature(s) is supported by this document template.

Implements idoc::IDocumentTypesInfo.

bool idoc::CSingleDocumentTemplateBase::IsViewTypeSupported ( const QByteArray &  viewTypeId) const
inlineprotected

Definition at line 79 of file CSingleDocumentTemplateBase.h.

virtual void idoc::CSingleDocumentTemplateBase::SetDefaultDirectory ( const QString &  defaultDirectory)
virtual
virtual void idoc::CSingleDocumentTemplateBase::SetDocumentTypeId ( const QByteArray &  id)
virtual
virtual void idoc::CSingleDocumentTemplateBase::SetDocumentTypeName ( const QString &  name)
virtual
virtual void idoc::CSingleDocumentTemplateBase::SetSupportedFeatures ( int  featureFlags)
virtual
virtual void idoc::CSingleDocumentTemplateBase::SetViewTypeId ( const QByteArray &  id)
virtual
virtual void idoc::CSingleDocumentTemplateBase::SetViewTypeName ( const QString &  name)
virtual

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy