ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Member Functions | List of all members
iqtdoc::CExtendedDocumentTemplateComp Class Reference

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

#include <CExtendedDocumentTemplateComp.h>

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

Public Types

typedef idoc::CSingleDocumentTemplateComp BaseClass
 
- Public Types inherited from idoc::CSingleDocumentTemplateComp
typedef icomp::CComponentBase BaseClass
 
typedef CSingleDocumentTemplateBase BaseClass2
 
- Public Types inherited from idoc::IDocumentTemplate
typedef istd::TUniqueInterfacePtr< istd::IPolymorphicViewUniquePtr
 Type definitions for view smart pointers.
 
typedef istd::TSharedInterfacePtr< istd::IPolymorphicViewSharedPtr
 
- Public Types inherited from idoc::IDocumentTypesInfo
enum  SupportedFeatures { SF_NEW_DOCUMENT = 0x0001 , SF_EDIT_DOCUMENT = 0x0010 , SF_DEFAULT = 0xffff }
 Enumeration for supported types of operations with documents. More...
 
typedef QVector< QByteArray > Ids
 Type definition for document type ID collections.
 

Public Member Functions

virtual Ids GetDocumentTypeIdsForFile (const QString &filePath) const override
 Get list of supported document IDs that can handle the specified file.
 
- Public Member Functions inherited from idoc::CSingleDocumentTemplateComp
virtual ifile::IFilePersistenceGetFileLoader (const QByteArray &documentTypeId) const override
 Get file loader/saver for specified document ID.
 
virtual istd::IChangeableUniquePtr CreateDocument (QByteArray &documentTypeId, bool initialize=true, bool beQuiet=false, bool *ignoredFlagPtr=NULL) const override
 Creates a document instance for document type documentTypeId.
 
virtual ViewUniquePtr CreateView (const QByteArray &documentTypeId, istd::IChangeable *documentPtr, const QByteArray &viewTypeId=QByteArray()) const override
 Creates a view instance for document document of type viewTypeId.
 
virtual idoc::IUndoManagerUniquePtr CreateUndoManager (const QByteArray &documentTypeId, istd::IChangeable *documentPtr) const override
 Creates an undo manager for a given document documentPtr.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
virtual const icomp::IComponentGetParentComponent (bool ownerOnly=false) const override
 Get parent of this component.
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
 Get access to specified component interface.
 
virtual IComponentContextSharedPtr GetComponentContext () const override
 Get access to component context describing all application-specified component information loaded from components registry.
 
virtual void SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
 Set component context of this component.
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- 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 override
 Return true, if the feature(s) is supported by this document template.
 
virtual Ids GetDocumentTypeIds () const override
 Get list of supported document type IDs.
 
virtual QString GetDocumentTypeName (const QByteArray &documentTypeId) const override
 Get human readable name of some document type ID.
 
virtual ifile::IFileTypeInfoGetDocumentFileTypeInfo (const QByteArray &documentTypeId) const override
 Get file type information object for some selected document type.
 
virtual QString GetDefaultDirectory (const QString &sugestedDir="", const QByteArray *documentTypeIdPtr=NULL) const override
 Return default directory for specified document type.
 
virtual Ids GetViewTypeIds (const QByteArray &documentTypeId) const override
 Return supported view type IDs for specified document type.
 
virtual QString GetViewTypeName (const QByteArray &documentTypeId, const QByteArray &viewTypeId) const override
 Get human readable name of some view type ID.
 

Protected Member Functions

virtual idoc::IDocumentTemplate::ViewUniquePtr ExtractViewInterface (icomp::IComponentUniquePtr &componentPtr) const override
 Extract pointer of view interface from factorisied view component.
 
- Protected Member Functions inherited from idoc::CSingleDocumentTemplateComp
virtual void OnComponentCreated () override
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual void OnComponentDestroyed ()
 
virtual const icomp::IRealComponentStaticInfoGetComponentStaticInfo () 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 icomp::IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

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

Definition at line 17 of file CExtendedDocumentTemplateComp.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 20 of file CExtendedDocumentTemplateComp.h.

Member Function Documentation

◆ ExtractViewInterface()

virtual idoc::IDocumentTemplate::ViewUniquePtr iqtdoc::CExtendedDocumentTemplateComp::ExtractViewInterface ( icomp::IComponentUniquePtr 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()

virtual Ids iqtdoc::CExtendedDocumentTemplateComp::GetDocumentTypeIdsForFile ( const QString &  filePath) const
overridevirtual

Get list of supported document IDs that can handle the specified file.

Parameters
filePathFull path to file to check.
Returns
Vector of document type IDs that can open/handle this file.

This method determines which document types are compatible with a given file based on file extension, content analysis, or other criteria.

Reimplemented from idoc::CSingleDocumentTemplateBase.


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