ICF 3.1.1.10
Technical documentation of ICF Libraries
idocgui::CExternalOpenDocumentCommandComp Class Reference

#include <CExternalOpenDocumentCommandComp.h>

Inheritance diagram for idocgui::CExternalOpenDocumentCommandComp:
Collaboration diagram for idocgui::CExternalOpenDocumentCommandComp:

Public Types

typedef ifilegui::CExternalOpenDocumentCommandCompBase BaseClass
 
- Public Types inherited from ifilegui::CExternalOpenDocumentCommandCompBase
typedef istdgui::CProcessStartCommandComp BaseClass
 
- Public Types inherited from istdgui::CProcessStartCommandComp
enum  GroupId { GI_START_PROCESS_COMMAND = 0x800 }
 
typedef ilog::CLoggerComponentBase BaseClass
 
- Public Types inherited from ilog::TLoggerCompWrap< Base >
enum  MessageId { MI_BAD_DEPENDENCY = 0x8a340 }
 
typedef Base BaseClass
 
typedef ilog::CLoggerBase BaseClass2
 
- Public Types inherited from ibase::ICommandsProvider
enum  ChangeFlags { CF_COMMANDS = 0x62b7e8 }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ICF_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 , SO_CHANGE_LOCK = 1 << 5
}
 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...
 

Protected Member Functions

virtual void UpdateCommands ()
 
const istd::IChangeableGetDocumentPtr () const override
 
void CreateMenu () override
 
void OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
 Called on update of observed model.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ifilegui::CExternalOpenDocumentCommandCompBase
bool StartProcess (const QStringList &arguments) override
 
void OnComponentCreated () override
 
- Protected Member Functions inherited from istdgui::CProcessStartCommandComp
virtual QStringList GetProcessArguments () const
 
void OnComponentCreated () override
 
- Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
 Decorate message parts before outputting.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ilog::CLoggerBase
bool IsVerboseEnabled () const
 Check if verbose messages are enabled.
 
bool SendVerboseMessage (const QString &message, const QString &messageSource=QString()) const
 Send verbose message.
 
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.
 
bool IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=nullptr, const int *flagsPtr=nullptr) const override
 Check if any log message is consumed.
 
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::ILogger
- 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.
 
bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 This call back function will be called, if an observable object is about to be attached.
 
bool OnModelDetached (imod::IModel *modelPtr) override
 This call back function will be called, if an observable object is about to be detached.
 
- 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.
 
bool IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
 Check if specified model is attached.
 
void BeforeModelChange (imod::IModel *modelPtr) override
 This function will be called before update of the observer contents occures.
 
void AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 This function will be called after update of the observer contents occures.
 
- Protected Member Functions inherited from imod::IObserver

Additional Inherited Members

- Public Member Functions inherited from istdgui::CProcessStartCommandComp
 CProcessStartCommandComp ()
 
const ibase::IHierarchicalCommandGetCommands () const override
 Get list of menu commands.
 
- Public Member Functions inherited from ilog::CLoggerBase
 CLoggerBase ()
 
const QByteArray & GetVerboseSenderId () const
 Get sender ID for verbose messages.
 
void SetVerboseSenderId (const QByteArray &id)
 Set sender ID for verbose messages.
 
void SetLogPtr (ilog::IMessageConsumer *logPtr) override
 Install log.
 
ilog::IMessageConsumerGetLogPtr () const override
 Get log.
 
- Public Member Functions inherited from ilog::ILoggable
- Public Member Functions inherited from ibase::ICommandsProvider
- 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 std::unique_ptr< 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 QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
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 istdgui::CProcessStartCommandComp
istdgui::CHierarchicalCommand m_rootCommands
 
istdgui::CHierarchicalCommand m_startProcessCommand
 
- Protected Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

Definition at line 19 of file CExternalOpenDocumentCommandComp.h.

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ CreateMenu()

void idocgui::CExternalOpenDocumentCommandComp::CreateMenu ( )
overrideprotectedvirtual

Reimplemented from istdgui::CProcessStartCommandComp.

◆ GetDocumentPtr()

const istd::IChangeable * idocgui::CExternalOpenDocumentCommandComp::GetDocumentPtr ( ) const
overrideprotectedvirtual

◆ OnComponentCreated()

void idocgui::CExternalOpenDocumentCommandComp::OnComponentCreated ( )
overrideprotected

◆ OnComponentDestroyed()

void idocgui::CExternalOpenDocumentCommandComp::OnComponentDestroyed ( )
overrideprotected

◆ OnUpdate()

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

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

© Witold Gantzke and Kirill Lepskiy