ICF 3.0.5.47
Technical documentation of ICF Libraries
ibase::CTranslationManagerComp Class Reference

A translation manager component. More...

#include <CTranslationManagerComp.h>

Inheritance diagram for ibase::CTranslationManagerComp:
Collaboration diagram for ibase::CTranslationManagerComp:

Public Types

typedef ilog::CLoggerComponentBase BaseClass
 
typedef imod::CMultiModelDispatcherBase BaseClass2
 
- Public Types inherited from ilog::TLoggerCompWrap< Base >
enum  MessageId { MI_BAD_DEPENDENCY = 0x8a340 }
 
typedef Base BaseClass
 
typedef ilog::CLoggerBase BaseClass2
 
- 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...
 

Public Member Functions

 CTranslationManagerComp ()
 Default constructor.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
const iprm::IOptionsListGetLanguagesInfo () const override
 Get the list of supported languages given as a list of options.
 
QByteArray GetCurrentLanguageId () const override
 Get current language ID.
 
bool SwitchLanguage (const QByteArray &languageId) override
 Switch the current language to the language with the ID languageId.
 
void SetSystemLanguage () override
 Set default system's language.
 
- 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::ITranslationManager
- 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.
 

Protected Member Functions

virtual void LoadTranslations ()
 
virtual void UpdateToSelection ()
 
void OnModelChanged (int modelId, const ChangeSet &changeSet) override
 Called when some model observed by dispatcher will be changed.
 
- Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
virtual 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::CMultiModelDispatcherBase
bool RegisterModel (IModel *modelPtr, int modelId=0, const istd::IChangeable::ChangeSet &relevantFlags=istd::IChangeable::GetAllChanges())
 Register the data model to be observed.
 
void UnregisterModel (int modelId=0)
 Unregister the data model object.
 
void UnregisterAllModels ()
 Unregister all observed data objects.
 
template<class Object >
Object * GetObjectAt (int modelId) const
 Get concrete object instance of the obsered model.
 

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 Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

A translation manager component.

Translation manager based on using a set of Qt translation files.

Definition at line 32 of file CTranslationManagerComp.h.

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Constructor & Destructor Documentation

◆ CTranslationManagerComp()

ibase::CTranslationManagerComp::CTranslationManagerComp ( )

Default constructor.

Member Function Documentation

◆ GetCurrentLanguageId()

QByteArray ibase::CTranslationManagerComp::GetCurrentLanguageId ( ) const
overridevirtual

Get current language ID.

Implements ibase::ITranslationManager.

◆ GetLanguagesInfo()

const iprm::IOptionsList & ibase::CTranslationManagerComp::GetLanguagesInfo ( ) const
overridevirtual

Get the list of supported languages given as a list of options.

Implements ibase::ITranslationManager.

◆ LoadTranslations()

virtual void ibase::CTranslationManagerComp::LoadTranslations ( )
protectedvirtual

◆ OnComponentCreated()

void ibase::CTranslationManagerComp::OnComponentCreated ( )
override

◆ OnComponentDestroyed()

void ibase::CTranslationManagerComp::OnComponentDestroyed ( )
override

◆ OnModelChanged()

void ibase::CTranslationManagerComp::OnModelChanged ( int modelId,
const ChangeSet & changeSet )
overrideprotectedvirtual

Called when some model observed by dispatcher will be changed.

Implements imod::CMultiModelDispatcherBase.

◆ SetSystemLanguage()

void ibase::CTranslationManagerComp::SetSystemLanguage ( )
overridevirtual

Set default system's language.

Implements ibase::ITranslationManager.

◆ SwitchLanguage()

bool ibase::CTranslationManagerComp::SwitchLanguage ( const QByteArray & languageId)
overridevirtual

Switch the current language to the language with the ID languageId.

Implements ibase::ITranslationManager.

◆ UpdateToSelection()

virtual void ibase::CTranslationManagerComp::UpdateToSelection ( )
protectedvirtual

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

© Witold Gantzke and Kirill Lepskiy