Extension of idoc::CSingleDocumentTemplateComp providing additional Qt-specified functionality. More...

#include <CExtendedDocumentTemplateComp.h>

Inheritance diagram for idocgui::CExtendedDocumentTemplateComp:

Collaboration diagram for idocgui::CExtendedDocumentTemplateComp:

Public Types
typedef idoc::CSingleDocumentTemplateComp	BaseClass

Public Types inherited from idoc::CSingleDocumentTemplateComp
typedef icomp::CComponentBase	BaseClass

typedef CSingleDocumentTemplateBase	BaseClass2

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
Ids	GetDocumentTypeIdsForFile (const QString &filePath) const override
	Get list of supported document ID's can be created for specified file.

Public Member Functions inherited from idoc::CSingleDocumentTemplateComp
ifile::IFilePersistence *	GetFileLoader (const QByteArray &documentTypeId) const override
	Get file loader/saver for spacified document ID.

std::unique_ptr< istd::IChangeable >	CreateDocument (QByteArray &documentTypeId, bool initialize=true, bool beQuiet=false, bool *ignoredFlagPtr=nullptr) const override
	Creates a document instance for document type `documentTypeId`.

std::unique_ptr< istd::IPolymorphic >	CreateView (const QByteArray &documentTypeId, istd::IChangeable *documentPtr, const QByteArray &viewTypeId=QByteArray()) const override
	Creates a view instance for document `document` of type `viewTypeId`.

std::unique_ptr< IUndoManager >	CreateUndoManager (const QByteArray &documentTypeId, istd::IChangeable *documentPtr) const override
	Creates an undo manger for a given document `documentPtr`.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

	CComponentBase (const CComponentBase &)=delete

CComponentBase &	operator= (const CComponentBase &)=delete

virtual const ICompositeComponent *	GetParentComponent (bool ownerOnly=false) const
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
	Get access to specified component interface.

virtual const IComponentContext *	GetComponentContext () const
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContext contextPtr, const ICompositeComponent parentPtr, bool isParentOwner)
	Set component context of this component.

Public Member Functions inherited from icomp::IComponent
Public Member Functions inherited from idoc::CSingleDocumentTemplateBase
	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.

virtual Ids	GetDocumentTypeIds () const
	Get list of supported document ID's can be created for specified file.

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

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

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

virtual Ids	GetViewTypeIds (const QByteArray &documentTypeId) const
	Return supported view type IDs for specified document type.

virtual QString	GetViewTypeName (const QByteArray &documentTypeId, const QByteArray &viewTypeId) const
	Get human readable name of some view type ID.

Public Member Functions inherited from idoc::IDocumentTemplate
Public Member Functions inherited from idoc::IDocumentTypesInfo

Protected Member Functions
istd::IPolymorphic *	ExtractViewInterface (icomp::IComponent *componentPtr) const override
	Extract pointer of view interface from factorisied view component.

Protected Member Functions inherited from idoc::CSingleDocumentTemplateComp
void	OnComponentCreated () override

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual void	OnComponentDestroyed ()

virtual const IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Protected Member Functions inherited from idoc::CSingleDocumentTemplateBase
bool	IsDocumentTypeSupported (const QByteArray &documentTypeId) const

bool	IsViewTypeSupported (const QByteArray &viewTypeId) const

Additional Inherited Members
Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Detailed Description

Extension of idoc::CSingleDocumentTemplateComp providing additional Qt-specified functionality.

Definition at line 22 of file CExtendedDocumentTemplateComp.h.

Member Typedef Documentation

◆ BaseClass

idoc::CSingleDocumentTemplateComp idocgui::CExtendedDocumentTemplateComp::BaseClass

Definition at line 25 of file CExtendedDocumentTemplateComp.h.

Member Function Documentation

◆ ExtractViewInterface()

istd::IPolymorphic * idocgui::CExtendedDocumentTemplateComp::ExtractViewInterface ( icomp::IComponent * componentPtr ) const

overrideprotectedvirtual

Extract pointer of view interface from factorisied view component.

This functionality is provided to allow derrived classes to extract implementation-specific GUI interfaces from created composited instances. Default is instance of interface imod::IObserver extracted, but for composite components it can be inaccurate for some cases.

Reimplemented from idoc::CSingleDocumentTemplateComp.

◆ GetDocumentTypeIdsForFile()

Ids idocgui::CExtendedDocumentTemplateComp::GetDocumentTypeIdsForFile ( const QString & filePath ) const

overridevirtual

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

Reimplemented from idoc::CSingleDocumentTemplateBase.

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

idocgui/CExtendedDocumentTemplateComp.h

Public Types

Public Member Functions