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

Document template component supported only one type of the provided document. More...

#include <CSingleDocumentTemplateComp.h>

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

Public Types

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

virtual ifile::IFilePersistenceGetFileLoader (const QByteArray &documentTypeId) const
 Get file loader/saver for spacified document ID. More...
 
virtual istd::IChangeableCreateDocument (QByteArray &documentTypeId, bool initialize=true, bool beQuiet=false, bool *ignoredFlagPtr=NULL) const
 Creates a document instance for document type documentTypeId. More...
 
virtual istd::IPolymorphicCreateView (const QByteArray &documentTypeId, istd::IChangeable *documentPtr, const QByteArray &viewTypeId=QByteArray()) const
 Creates a view instance for document document of type viewTypeId. More...
 
idoc::IUndoManagerCreateUndoManager (const QByteArray &documentTypeId, istd::IChangeable *documentPtr) const
 Creates an undo manger for a given document documentPtr. More...
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context. More...
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component. More...
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface. More...
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry. More...
 
virtual void SetComponentContext (const icomp::IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component. More...
 
- 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
 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...
 

Protected Member Functions

virtual istd::IPolymorphicExtractViewInterface (icomp::IComponent *componentPtr) const
 Extract pointer of view interface from factorisied view component. More...
 
virtual void OnComponentCreated ()
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active. More...
 
virtual void OnComponentDestroyed ()
 
virtual const
icomp::IRealComponentStaticInfo
GetComponentStaticInfo () const =0
 Get access to static info of this component. More...
 
- 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::IRealComponentStaticInfo
InitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

Document template component supported only one type of the provided document.

Definition at line 19 of file CSingleDocumentTemplateComp.h.

Member Typedef Documentation

Definition at line 22 of file CSingleDocumentTemplateComp.h.

Definition at line 23 of file CSingleDocumentTemplateComp.h.

Member Function Documentation

virtual istd::IChangeable* idoc::CSingleDocumentTemplateComp::CreateDocument ( QByteArray &  documentTypeId,
bool  initialize = true,
bool  beQuiet = false,
bool *  ignoredFlagPtr = NULL 
) const
virtual

Creates a document instance for document type documentTypeId.

Parameters
documentTypeIdID of document type, can be empty for default document. If document type is undefined (empty), this field will be used to return ID of used type.
initializeIf true, document should be filled with initial data (operation new), otherwise initialization is not needed (e.g. for document loading - filling of data will be done by loader).
ignoredFlagPtroptional output flag indicating that the user canceled this operation.

Implements idoc::IDocumentTemplate.

idoc::IUndoManager* idoc::CSingleDocumentTemplateComp::CreateUndoManager ( const QByteArray &  documentTypeId,
istd::IChangeable documentPtr 
) const
virtual

Creates an undo manger for a given document documentPtr.

Parameters
documentTypeIdID of document type.
documentPtrpointer to document object.
Returns
pointer to created instance of undo manager or NULL, if creating of undo manager was impossible.

Implements idoc::IDocumentTemplate.

virtual istd::IPolymorphic* idoc::CSingleDocumentTemplateComp::CreateView ( const QByteArray &  documentTypeId,
istd::IChangeable documentPtr,
const QByteArray &  viewTypeId = QByteArray() 
) const
virtual

Creates a view instance for document document of type viewTypeId.

Parameters
documentTypeIdID of document type.
documentPtrpointer to document object.
viewTypeIdoptional ID specifying view type if more view types are supported.

Implements idoc::IDocumentTemplate.

virtual istd::IPolymorphic* idoc::CSingleDocumentTemplateComp::ExtractViewInterface ( icomp::IComponent componentPtr) const
protectedvirtual

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 in iqtdoc::CExtendedDocumentTemplateComp.

virtual ifile::IFilePersistence* idoc::CSingleDocumentTemplateComp::GetFileLoader ( const QByteArray &  documentTypeId) const
virtual

Get file loader/saver for spacified document ID.

Parameters
documentTypeIdtype ID of document will be loaded/saved.

Implements idoc::IDocumentTemplate.

virtual void idoc::CSingleDocumentTemplateComp::OnComponentCreated ( )
protectedvirtual

Reimplemented from icomp::CComponentBase.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy