A translation manager component. More...

#include <CTranslationManagerComp.h>

Inheritance diagram for iqt::CTranslationManagerComp:

Classes
class	LanguageSelectionObserver

struct	Translator

Public Types
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 iprm::IOptionsList
enum	ChangeFlags { CF_OPTIONS_CHANGED = 0x8263d86 , CF_OPTION_RENAMED }
	Flags for changes related to this interface. More...

enum	OptionsFlags { SCF_NONE = 0 , SCF_SUPPORT_UNIQUE_ID = 256 , SFC_DISABLE_ALLOWED = 32 }
	Flags for controlling constraints behavior. More...

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

Signals
void	EmitInstallTranslator (int languageIndex)

Public Member Functions
	CTranslationManagerComp ()
	Default constructor.

virtual void	OnComponentCreated () override
	Called when component is created.

virtual void	OnComponentDestroyed () override
	Called when component is destroyed.

virtual const iprm::IOptionsList &	GetLanguagesInfo () const override
	Get the list of supported languages given as a list of options.

virtual int	GetCurrentLanguageIndex () const override
	Get current language index.

virtual const QTranslator *	GetLanguageTranslator (int languageIndex) const override
	Get Qt translator for a given language.

virtual const ITranslationManager *	GetSlaveTranslationManager () const override
	Get slave translation manager, if set.

virtual void	SwitchLanguage (int languageIndex) override
	Switch the current language to the language with the index `languageIndex`.

virtual void	SetSystemLanguage () override
	Set default system's language.

virtual int	GetOptionsFlags () const override
	Get constraints flags.

virtual int	GetOptionsCount () const override
	Get number of managed options.

virtual QString	GetOptionName (int index) const override
	Get name of specified option.

virtual QString	GetOptionDescription (int index) const override
	Get human-readable description for an option.

virtual QByteArray	GetOptionId (int index) const override
	Get option ID.

virtual bool	IsOptionEnabled (int index) const override
	Return true if the option is enabled and can be selected.

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::IMessageConsumer *	GetLogPtr () 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::IChangeable >	CloneMe (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 Types
typedef QVector< Translator >	TranslatorsList

Protected Slots
void	InstallTranslator (int languageIndex)

Protected Member Functions
virtual void	LoadTranslations ()

	I_MULTITEXTATTR (m_languageNamesAttrPtr)

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 Attributes
TranslatorsList	m_translatorsList

LanguageSelectionObserver	m_selectionObserver

int	m_currentLanguageIndex

QReadWriteLock	m_mutex

Protected Attributes inherited from ilog::CLoggerBase
QSet< int >	m_onceMessageIds

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Detailed Description

A translation manager component.

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

Definition at line 30 of file CTranslationManagerComp.h.

Member Typedef Documentation

◆ BaseClass

typedef ilog::CLoggerComponentBase iqt::CTranslationManagerComp::BaseClass

Definition at line 38 of file CTranslationManagerComp.h.

◆ TranslatorsList

typedef QVector<Translator> iqt::CTranslationManagerComp::TranslatorsList

protected

Definition at line 124 of file CTranslationManagerComp.h.

Constructor & Destructor Documentation

◆ CTranslationManagerComp()

iqt::CTranslationManagerComp::CTranslationManagerComp ( )

Default constructor.

Member Function Documentation

◆ EmitInstallTranslator

void iqt::CTranslationManagerComp::EmitInstallTranslator ( int languageIndex )

signal

◆ GetCurrentLanguageIndex()

virtual int iqt::CTranslationManagerComp::GetCurrentLanguageIndex ( ) const

overridevirtual

Get current language index.

Implements iqt::ITranslationManager.

◆ GetLanguagesInfo()

virtual const iprm::IOptionsList & iqt::CTranslationManagerComp::GetLanguagesInfo ( ) const

overridevirtual

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

Implements iqt::ITranslationManager.

◆ GetLanguageTranslator()

virtual const QTranslator * iqt::CTranslationManagerComp::GetLanguageTranslator ( int languageIndex ) const

overridevirtual

Get Qt translator for a given language.

Implements iqt::ITranslationManager.

◆ GetOptionDescription()

virtual QString iqt::CTranslationManagerComp::GetOptionDescription ( int index ) const

overridevirtual

Get human-readable description for an option.

Returns detailed description or tooltip text for an option.

Parameters

index Option index (0-based).

Returns: Option description as QString, or empty string if no description exists or index is out of range.

QString description = options->GetOptionDescription(2);
if (!description.isEmpty())
{
    qDebug() << "Description:" << description;
}

See also: GetOptionName

Implements iprm::IOptionsList.

◆ GetOptionId()

virtual QByteArray iqt::CTranslationManagerComp::GetOptionId ( int index ) const

overridevirtual

Get option ID.

Returns the unique identifier for an option. The ID is stable and doesn't change when options are reordered, making it suitable for persistent references.

Parameters

index Option index (0-based).

Returns: Option ID as QByteArray, or empty array if index is out of range.

Note: The ID must be unique if SCF_SUPPORT_UNIQUE_ID flag is set.; Use FindOptionIndexById() to find an option by its ID.

QByteArray id = options->GetOptionId(1);
qDebug() << "Option ID:" << id;
 
// Later, find the option by ID
int index = iprm::FindOptionIndexById(id, *options);

See also: OptionsFlags, FindOptionIndexById

Implements iprm::IOptionsList.

◆ GetOptionName()

virtual QString iqt::CTranslationManagerComp::GetOptionName ( int index ) const

overridevirtual

Get name of specified option.

Returns the display name for an option.

Parameters

index Option index (0-based).

Returns: Option name as QString, or empty string if index is out of range.

QString name = options->GetOptionName(0);

qDebug() << "First option:" << name;

See also: GetOptionDescription, GetOptionId

Implements iprm::IOptionsList.

◆ GetOptionsCount()

virtual int iqt::CTranslationManagerComp::GetOptionsCount ( ) const

overridevirtual

Get number of managed options.

Returns: Total count of options in the list (including disabled options).

int count = options->GetOptionsCount();
for (int i = 0; i < count; ++i)
{
    // Process each option
}

See also: GetOptionName

Implements iprm::IOptionsList.

◆ GetOptionsFlags()

virtual int iqt::CTranslationManagerComp::GetOptionsFlags ( ) const

overridevirtual

Get constraints flags.

Returns flags that describe how the constraints object behaves and what features it supports.

Returns: Bitwise OR combination of OptionsFlags values.

int flags = options->GetOptionsFlags();
 
if (flags & iprm::IOptionsList::SCF_SUPPORT_UNIQUE_ID)
{
    qDebug() << "Options have unique IDs";
}
 
if (flags & iprm::IOptionsList::SFC_DISABLE_ALLOWED)
{
    qDebug() << "Options can be disabled";
}

See also: OptionsFlags

Implements iprm::IOptionsList.

◆ GetSlaveTranslationManager()

virtual const ITranslationManager * iqt::CTranslationManagerComp::GetSlaveTranslationManager ( ) const

overridevirtual

Get slave translation manager, if set.

Implements iqt::ITranslationManager.

◆ I_MULTITEXTATTR()

iqt::CTranslationManagerComp::I_MULTITEXTATTR ( m_languageNamesAttrPtr )

protected

◆ InstallTranslator

void iqt::CTranslationManagerComp::InstallTranslator ( int languageIndex )

protectedslot

◆ IsOptionEnabled()

virtual bool iqt::CTranslationManagerComp::IsOptionEnabled ( int index ) const

overridevirtual

Return true if the option is enabled and can be selected.

Checks whether an option is currently enabled. Disabled options cannot be selected but remain visible in the list.

Parameters

index Option index (0-based).

Returns: true if option is enabled and can be selected, false if disabled or index is out of range.

for (int i = 0; i < options->GetOptionsCount(); ++i)
{
    if (options->IsOptionEnabled(i))
    {
        QString name = options->GetOptionName(i);
        qDebug() << "Enabled option:" << name;
    }
}

See also: SFC_DISABLE_ALLOWED

Implements iprm::IOptionsList.

◆ LoadTranslations()

virtual void iqt::CTranslationManagerComp::LoadTranslations ( )

protectedvirtual

◆ OnComponentCreated()

virtual void iqt::CTranslationManagerComp::OnComponentCreated ( )

overridevirtual

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

BaseClass::OnComponentCreated();

}

ilog::TLoggerCompWrap::OnComponentCreated
virtual void OnComponentCreated() override
Called when component is created.
Definition TLoggerCompWrap.h:330

iqt::CTranslationManagerComp::OnComponentCreated
virtual void OnComponentCreated() override
Called when component is created.

Reimplemented from ilog::TLoggerCompWrap< Base >.

◆ OnComponentDestroyed()

virtual void iqt::CTranslationManagerComp::OnComponentDestroyed ( )

overridevirtual

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

BaseClass::OnComponentDestroyed();

}

ilog::TLoggerCompWrap::OnComponentDestroyed
virtual void OnComponentDestroyed() override
Called when component is destroyed.
Definition TLoggerCompWrap.h:341

iqt::CTranslationManagerComp::OnComponentDestroyed
virtual void OnComponentDestroyed() override
Called when component is destroyed.

Reimplemented from ilog::TLoggerCompWrap< Base >.

◆ SetSystemLanguage()

virtual void iqt::CTranslationManagerComp::SetSystemLanguage ( )

overridevirtual

Set default system's language.

Implements iqt::ITranslationManager.

◆ SwitchLanguage()

virtual void iqt::CTranslationManagerComp::SwitchLanguage ( int languageIndex )

overridevirtual

Switch the current language to the language with the index languageIndex.

Implements iqt::ITranslationManager.

Member Data Documentation

◆ m_currentLanguageIndex

int iqt::CTranslationManagerComp::m_currentLanguageIndex

protected

Definition at line 130 of file CTranslationManagerComp.h.

◆ m_mutex

QReadWriteLock iqt::CTranslationManagerComp::m_mutex

mutableprotected

Definition at line 132 of file CTranslationManagerComp.h.

◆ m_selectionObserver

LanguageSelectionObserver iqt::CTranslationManagerComp::m_selectionObserver

protected

Definition at line 128 of file CTranslationManagerComp.h.

◆ m_translatorsList

TranslatorsList iqt::CTranslationManagerComp::m_translatorsList

protected

Definition at line 126 of file CTranslationManagerComp.h.

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

Acf/Include/iqt/CTranslationManagerComp.h

Classes

Public Types

Signals

Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ TranslatorsList

Constructor & Destructor Documentation

◆ CTranslationManagerComp()

Member Function Documentation

◆ EmitInstallTranslator

◆ GetCurrentLanguageIndex()

◆ GetLanguagesInfo()

◆ GetLanguageTranslator()

◆ GetOptionDescription()

◆ GetOptionId()

◆ GetOptionName()

◆ GetOptionsCount()

◆ GetOptionsFlags()

◆ GetSlaveTranslationManager()

◆ I_MULTITEXTATTR()

◆ InstallTranslator

◆ IsOptionEnabled()

◆ LoadTranslations()

◆ OnComponentCreated()

◆ OnComponentDestroyed()

◆ SetSystemLanguage()

◆ SwitchLanguage()

Member Data Documentation

◆ m_currentLanguageIndex

◆ m_mutex

◆ m_selectionObserver

◆ m_translatorsList