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

#include <CExternalOpenDocumentCommandComp.h>

Inheritance diagram for iqtdoc::CExternalOpenDocumentCommandComp:
ifilegui::CExternalOpenDocumentCommandCompBase imod::TSingleModelObserverBase< idoc::IDocumentManager > iqtgui::CProcessStartCommandComp imod::CSingleModelObserverBase ilog::TLoggerCompWrap< Base > ibase::ICommandsProvider imod::IObserver ilog::CLoggerBase istd::IChangeable istd::IPolymorphic ilog::ILoggable istd::ILogger istd::IPolymorphic istd::IPolymorphic istd::IPolymorphic

Public Types

typedef ifilegui::CExternalOpenDocumentCommandCompBase BaseClass
 
- Public Types inherited from ifilegui::CExternalOpenDocumentCommandCompBase
typedef iqtgui::CProcessStartCommandComp BaseClass
 
- Public Types inherited from iqtgui::CProcessStartCommandComp
enum  GroupId { GI_START_PROCESS_COMMAND = 0x800 }
 
typedef ilog::CLoggerComponentBase BaseClass
 
- Public Types inherited from ilog::TLoggerCompWrap< Base >
typedef Base BaseClass
 Base class typedef for component functionality.
 
typedef ilog::CLoggerBase BaseClass2
 Base class typedef for logger functionality.
 
- 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
 

Protected Member Functions

virtual void UpdateCommands ()
 
virtual const istd::IChangeableGetDocumentPtr () const override
 
virtual void CreateMenu () override
 
virtual void OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
 Called on update of observed model.
 
virtual void OnComponentCreated () override
 Called when component is created.
 
virtual void OnComponentDestroyed () override
 Called when component is destroyed.
 
- Protected Member Functions inherited from ifilegui::CExternalOpenDocumentCommandCompBase
virtual bool StartProcess (const QStringList &arguments) override
 
- Protected Member Functions inherited from iqtgui::CProcessStartCommandComp
virtual QStringList GetProcessArguments () const
 
- Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
bool IsVerboseEnabled (int tracingLevel=0) const
 Check if verbose messages are enabled for a given tracing level.
 
void SendVerboseMessage (const QString &message, const QString &messageSource=QString(), int tracingLevel=0) const
 Send a verbose message if enabled.
 
virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
 Decorate message before sending.
 
- Protected Member Functions inherited from ilog::CLoggerBase
bool SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send info message to log.
 
bool SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send warning message to log.
 
bool SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send error message to log.
 
bool SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send critical message to log.
 
bool SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once info message to log.
 
bool SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once warning message to log.
 
bool SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once error message to log.
 
bool SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once critical message to log.
 
bool SendUserMessage (const istd::IInformationProvider *messagePtr) const
 Send message with user object.
 
bool AllowMessageOnceAgain (int id)
 Reset message lock.
 
virtual bool IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=NULL, const int *flagsPtr=NULL) const override
 Check if any log message is consumed.
 
virtual bool SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
 Send any message to log.
 
- 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.
 
- 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.
 

Additional Inherited Members

- Public Member Functions inherited from iqtgui::CProcessStartCommandComp
 CProcessStartCommandComp ()
 
virtual const ibase::IHierarchicalCommandGetCommands () const override
 Get list of menu commands.
 
- Public Member Functions inherited from ilog::CLoggerBase
 CLoggerBase ()
 Default constructor.
 
virtual void SetLogPtr (ilog::IMessageConsumer *logPtr) override
 Attach a message consumer for logging.
 
virtual ilog::IMessageConsumerGetLogPtr () const override
 Get the currently attached message consumer.
 
- 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.
 
- 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 Attributes inherited from iqtgui::CProcessStartCommandComp
iqtgui::CHierarchicalCommand m_rootCommands
 
iqtgui::CHierarchicalCommand m_startProcessCommand
 
- Protected Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 
- Static Protected Attributes inherited from imod::CSingleModelObserverBase
static const istd::IChangeable::ChangeSet s_undoChanges
 

Detailed Description

Definition at line 15 of file CExternalOpenDocumentCommandComp.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 20 of file CExternalOpenDocumentCommandComp.h.

Member Function Documentation

◆ CreateMenu()

virtual void iqtdoc::CExternalOpenDocumentCommandComp::CreateMenu ( )
overrideprotectedvirtual

Reimplemented from iqtgui::CProcessStartCommandComp.

◆ GetDocumentPtr()

virtual const istd::IChangeable * iqtdoc::CExternalOpenDocumentCommandComp::GetDocumentPtr ( ) const
overrideprotectedvirtual

◆ OnComponentCreated()

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

Called when component is created.

Automatically connects the log consumer from the "Log" reference.

Note
Override to add initialization, but always call base class:
virtual void OnComponentCreated() override {
// Custom initialization
}
virtual void OnComponentCreated() override
Called when component is created.
virtual void OnComponentCreated() override
Called when component is created.

Reimplemented from ifilegui::CExternalOpenDocumentCommandCompBase.

◆ OnComponentDestroyed()

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

Called when component is destroyed.

Automatically disconnects the log consumer for cleanup.

Note
Override to add cleanup, but always call base class:
virtual void OnComponentDestroyed() override {
// Custom cleanup
}
virtual void OnComponentDestroyed() override
Called when component is destroyed.
virtual void OnComponentDestroyed() override
Called when component is destroyed.

Reimplemented from ilog::TLoggerCompWrap< Base >.

◆ OnUpdate()

virtual void iqtdoc::CExternalOpenDocumentCommandComp::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::CExternalOpenDocumentCommandComp::UpdateCommands ( )
protectedvirtual

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