idoc::IDocumentTypesInfo Class Reference

Provide information about different document types. More...

#include <IDocumentTypesInfo.h>

Inheritance diagram for idoc::IDocumentTypesInfo:

Public Types
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 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::IFileTypeInfo *	GetDocumentFileTypeInfo (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...
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Detailed Description

Provide information about different document types.

Definition at line 20 of file IDocumentTypesInfo.h.

Member Typedef Documentation

typedef QVector<QByteArray> idoc::IDocumentTypesInfo::Ids

Definition at line 23 of file IDocumentTypesInfo.h.

Member Enumeration Documentation

enum idoc::IDocumentTypesInfo::SupportedFeatures

Enumeration for supported types of operation with the document.

Enumerator
SF_NEW_DOCUMENT	A new document can be created.
SF_EDIT_DOCUMENT	A document is editable.
SF_DEFAULT	All features are supported.

Definition at line 28 of file IDocumentTypesInfo.h.

Member Function Documentation

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

pure virtual

Return default directory for specified document type.

Parameters

sugestedDir	template directory sugested by user.
documentTypeIdPtr	optional ID of document type.

Implemented in idoc::CSingleDocumentTemplateBase, idoc::CCompositeDocumentTemplateComp, and idoc::CTmplBasedDocumentManagerBase.

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

pure virtual

Get file type information object for some selected document type.

Parameters

documentTypeId

ID of document type as returned by GetDocumentTypeIds().

Implemented in idoc::CSingleDocumentTemplateBase, idoc::CCompositeDocumentTemplateComp, and idoc::CTmplBasedDocumentManagerBase.

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

pure virtual

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

Implemented in idoc::CSingleDocumentTemplateBase, idoc::CCompositeDocumentTemplateComp, and idoc::CTmplBasedDocumentManagerBase.

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

pure virtual

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

Implemented in idoc::CSingleDocumentTemplateBase, idoc::CCompositeDocumentTemplateComp, idoc::CTmplBasedDocumentManagerBase, and iqtdoc::CExtendedDocumentTemplateComp.

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

pure virtual

Get human readable name of some document type ID.

Parameters

documentTypeId

ID of document type as returned by GetDocumentTypeIds().

Implemented in idoc::CSingleDocumentTemplateBase, idoc::CCompositeDocumentTemplateComp, and idoc::CTmplBasedDocumentManagerBase.

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

pure virtual

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

Implemented in idoc::CSingleDocumentTemplateBase, idoc::CCompositeDocumentTemplateComp, and idoc::CTmplBasedDocumentManagerBase.

---

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

• Include/idoc/IDocumentTypesInfo.h