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

Component used for triggering of the document import/export command from the file menu of a document based application. More...

#include <CDocumentImportExportCommandComp.h>

Inheritance diagram for iqtdoc::CDocumentImportExportCommandComp:
icomp::CComponentBase imod::TSingleModelObserverBase< idoc::IDocumentManager > ibase::ICommandsProvider icomp::IComponent imod::CSingleModelObserverBase istd::IChangeable istd::IPolymorphic imod::IObserver istd::IPolymorphic istd::IPolymorphic

Public Types

typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from ibase::ICommandsProvider
enum  ChangeFlags { CF_COMMANDS = 0x62b7e8 }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 
typedef QMultiMap< QByteArray, QVariant > ChangeInfoMap
 

Public Member Functions

 CDocumentImportExportCommandComp ()
 
virtual const ibase::IHierarchicalCommandGetCommands () const override
 Get list of menu commands.
 
- 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 istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual istd::TUniqueInterfacePtr< istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state.
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 

Protected Slots

virtual void OnImport ()
 
virtual void OnExport ()
 

Protected Member Functions

virtual void OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
 Called on update of observed model.
 
virtual void OnComponentCreated () override
 
virtual void OnComponentDestroyed () override
 
virtual void UpdateCommands ()
 
 I_TEXTATTR (m_importCommandNameAttrPtr)
 
 I_TEXTATTR (m_exportCommandNameAttrPtr)
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual const icomp::IRealComponentStaticInfoGetComponentStaticInfo () const =0
 Get access to static info of this component.
 
- Protected Member Functions inherited from imod::TSingleModelObserverBase< idoc::IDocumentManager >
virtual idoc::IDocumentManagerCastFromModel (imod::IModel *modelPtr) const
 
 TSingleModelObserverBase ()
 
idoc::IDocumentManagerGetObservedObject () const
 Get instance of observed object.
 
idoc::IDocumentManagerGetObjectPtr () const
 Get instance of observed object.
 
bool AttachOrSetObject (idoc::IDocumentManager *objectPtr)
 Attach to model of object or set object pointer, if no connection is possible.
 
virtual bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 Callback invoked when an observable model is about to be attached to this observer.
 
virtual bool OnModelDetached (imod::IModel *modelPtr) override
 Callback invoked when an observable model is about to be detached from this observer.
 
- Protected Member Functions inherited from imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value.
 
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model.
 
imod::IModelGetModelPtr () const
 Get access to observed model.
 
void EnsureModelDetached ()
 Make sure this observer is detached.
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed.
 
virtual bool IsModelAttached (const imod::IModel *modelPtr=NULL) const override
 Checks if the specified model is currently attached to this observer.
 
virtual void BeforeUpdate (imod::IModel *modelPtr) override
 Callback invoked before an update of the observer's content occurs.
 
virtual void AfterUpdate (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 Callback invoked after an update of the observer's content occurs.
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event.
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event.
 
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual istd::TUniqueInterfacePtr< istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state.
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 

Protected Attributes

iqtgui::CHierarchicalCommand m_rootCommands
 
iqtgui::CHierarchicalCommand m_fileCommands
 
iqtgui::CHierarchicalCommand m_importCommand
 
iqtgui::CHierarchicalCommand m_exportCommand
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Protected Types inherited from imod::TSingleModelObserverBase< idoc::IDocumentManager >
typedef CSingleModelObserverBase BaseClass
 
typedef idoc::IDocumentManager ModelType
 
- Protected Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- Protected Types inherited from ibase::ICommandsProvider
enum  ChangeFlags { CF_COMMANDS = 0x62b7e8 }
 
- Protected Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 
typedef QMultiMap< QByteArray, QVariant > ChangeInfoMap
 
- 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())
 
- Static Protected Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Static Protected Attributes inherited from imod::CSingleModelObserverBase
static const istd::IChangeable::ChangeSet s_undoChanges
 

Detailed Description

Component used for triggering of the document import/export command from the file menu of a document based application.

Definition at line 22 of file CDocumentImportExportCommandComp.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 30 of file CDocumentImportExportCommandComp.h.

Constructor & Destructor Documentation

◆ CDocumentImportExportCommandComp()

iqtdoc::CDocumentImportExportCommandComp::CDocumentImportExportCommandComp ( )

Member Function Documentation

◆ GetCommands()

virtual const ibase::IHierarchicalCommand * iqtdoc::CDocumentImportExportCommandComp::GetCommands ( ) const
overridevirtual

Get list of menu commands.

These commands will be integrated in global menu system, independent from actual selected view. For support of normal pull down menu, depth of this tree structure should be at least 3.

Reimplemented from ibase::ICommandsProvider.

◆ I_TEXTATTR() [1/2]

iqtdoc::CDocumentImportExportCommandComp::I_TEXTATTR ( m_exportCommandNameAttrPtr  )
protected

◆ I_TEXTATTR() [2/2]

iqtdoc::CDocumentImportExportCommandComp::I_TEXTATTR ( m_importCommandNameAttrPtr  )
protected

◆ OnComponentCreated()

virtual void iqtdoc::CDocumentImportExportCommandComp::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnComponentDestroyed()

virtual void iqtdoc::CDocumentImportExportCommandComp::OnComponentDestroyed ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnExport

virtual void iqtdoc::CDocumentImportExportCommandComp::OnExport ( )
protectedvirtualslot

◆ OnImport

virtual void iqtdoc::CDocumentImportExportCommandComp::OnImport ( )
protectedvirtualslot

◆ OnUpdate()

virtual void iqtdoc::CDocumentImportExportCommandComp::OnUpdate ( const istd::IChangeable::ChangeSet changeSet)
overrideprotectedvirtual

Called on update of observed model.

This method is designed to be overload by derrived classes.

Reimplemented from imod::CSingleModelObserverBase.

◆ UpdateCommands()

virtual void iqtdoc::CDocumentImportExportCommandComp::UpdateCommands ( )
protectedvirtual

Member Data Documentation

◆ m_exportCommand

iqtgui::CHierarchicalCommand iqtdoc::CDocumentImportExportCommandComp::m_exportCommand
protected

Definition at line 67 of file CDocumentImportExportCommandComp.h.

◆ m_fileCommands

iqtgui::CHierarchicalCommand iqtdoc::CDocumentImportExportCommandComp::m_fileCommands
protected

Definition at line 65 of file CDocumentImportExportCommandComp.h.

◆ m_importCommand

iqtgui::CHierarchicalCommand iqtdoc::CDocumentImportExportCommandComp::m_importCommand
protected

Definition at line 66 of file CDocumentImportExportCommandComp.h.

◆ m_rootCommands

iqtgui::CHierarchicalCommand iqtdoc::CDocumentImportExportCommandComp::m_rootCommands
protected

Definition at line 64 of file CDocumentImportExportCommandComp.h.


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