![]() |
digiKam Developer Documentation
Professional Photo Management with the Power of Open Source
|
Provides translation data.
Public Types | |
enum | Engine { Google , Yandex , Bing , LibreTranslate , Lingva } |
Represents online engines. | |
enum | Language { NoLanguage = -1 , Auto , Afrikaans , Albanian , Amharic , Arabic , Armenian , Azerbaijani , Bashkir , Basque , Belarusian , Bengali , Bosnian , Bulgarian , Cantonese , Catalan , Cebuano , Chichewa , Corsican , Croatian , Czech , Danish , Dutch , English , Esperanto , Estonian , Fijian , Filipino , Finnish , French , Frisian , Galician , Georgian , German , Greek , Gujarati , HaitianCreole , Hausa , Hawaiian , Hebrew , HillMari , Hindi , Hmong , Hungarian , Icelandic , Igbo , Indonesian , Irish , Italian , Japanese , Javanese , Kannada , Kazakh , Khmer , Kinyarwanda , Klingon , KlingonPlqaD , Korean , Kurdish , Kyrgyz , Lao , Latin , Latvian , LevantineArabic , Lithuanian , Luxembourgish , Macedonian , Malagasy , Malay , Malayalam , Maltese , Maori , Marathi , Mari , Mongolian , Myanmar , Nepali , Norwegian , Oriya , Papiamento , Pashto , Persian , Polish , Portuguese , Punjabi , QueretaroOtomi , Romanian , Russian , Samoan , ScotsGaelic , SerbianCyrillic , SerbianLatin , Sesotho , Shona , SimplifiedChinese , Sindhi , Sinhala , Slovak , Slovenian , Somali , Spanish , Sundanese , Swahili , Swedish , Tagalog , Tahitian , Tajik , Tamil , Tatar , Telugu , Thai , Tongan , TraditionalChinese , Turkish , Turkmen , Udmurt , Uighur , Ukrainian , Urdu , Uzbek , Vietnamese , Welsh , Xhosa , Yiddish , Yoruba , YucatecMaya , Zulu } |
Represents all languages for translation. | |
enum | TranslationError { NoError , ParametersError , NetworkError , ServiceError , ParsingError } |
Indicates all possible error conditions found during the processing of the translation. More... | |
Signals | |
void | signalFinished () |
Translation finished. | |
Public Member Functions | |
DOnlineTranslator (QObject *const parent=nullptr) | |
Create object. | |
void | abort () |
Cancel translation operation (if any). | |
void | detectLanguage (const QString &text, Engine engine=Google) |
Detect language. | |
TranslationError | error () const |
Last error. | |
QString | errorString () const |
Last error string. | |
bool | isRunning () const |
Check translation progress. | |
bool | isSourceTranscriptionEnabled () const |
Check if source transcription is enabled. | |
bool | isSourceTranslitEnabled () const |
Check if source transliteration is enabled. | |
bool | isTranslationOptionsEnabled () const |
Check if translation options are enabled. | |
bool | isTranslationTranslitEnabled () const |
Check if translation transliteration is enabled. | |
void | setEngineApiKey (Engine engine, const QByteArray &apiKey) |
Set api key for engine. | |
void | setEngineUrl (Engine engine, const QString &url) |
Set the URL engine. | |
void | setSourceTranscriptionEnabled (bool enable) |
Enable or disable source transcription. | |
void | setSourceTranslitEnabled (bool enable) |
Enable or disable source transliteration. | |
void | setTranslationOptionsEnabled (bool enable) |
Enable or disable translation options. | |
void | setTranslationTranslitEnabled (bool enable) |
Enable or disable translation transliteration. | |
QString | source () const |
Source text. | |
Language | sourceLanguage () const |
Source language. | |
QString | sourceLanguageName () const |
Source language name. | |
QString | sourceTranscription () const |
Source transcription. | |
QString | sourceTranslit () const |
Source transliteration. | |
QJsonDocument | toJson () const |
Converts the object to JSON. | |
void | translate (const QString &text, Engine engine=Google, Language translationLang=Auto, Language sourceLang=Auto, Language uiLang=Auto) |
Translate text. | |
QString | translation () const |
Translated text. | |
Language | translationLanguage () const |
Translation language. | |
QString | translationLanguageName () const |
Translation language name. | |
QMap< QString, QVector< DOnlineTranslatorOption > > | translationOptions () const |
Translation options. | |
QString | translationTranslit () const |
Translation transliteration. | |
Static Public Member Functions | |
static QString | engineName (Engine engine) |
Return the engine literal name. | |
static QString | fromRFC3066 (Engine engine, const QString &langCodeRFC3066) |
Convert language RFC3066 to supported language code. | |
static bool | isSupportTranslation (Engine engine, Language lang) |
Check if transliteration is supported. | |
static Language | language (const QLocale &locale) |
Language. | |
static Language | language (const QString &langCode) |
Returns general language code. | |
static QString | languageCode (Language lang) |
Language code. | |
static QString | languageName (Language lang) |
Language name. | |
static QStringList | supportedRFC3066 (Engine engine) |
Return a list of all supported language in RFC3066. | |
Friends | |
class | DOnlineTts |
|
explicit |
Constructs an object with empty data and with parent. You can use translate() to send text to object.
parent | the parent object |
void Digikam::DOnlineTranslator::detectLanguage | ( | const QString & | text, |
Engine | engine = Google |
||
) |
text | the text for language detection |
engine | the engine to use |
DOnlineTranslator::TranslationError Digikam::DOnlineTranslator::error | ( | ) | const |
Error that was found during the processing of the last translation. If no error was found, returns DOnlineTranslator::NoError. The text of the error can be obtained by errorString().
QString Digikam::DOnlineTranslator::errorString | ( | ) | const |
A human-readable description of the last translation error that occurred.
bool Digikam::DOnlineTranslator::isRunning | ( | ) | const |
true
when the translation is still processing and has not finished or was aborted yet. bool Digikam::DOnlineTranslator::isSourceTranscriptionEnabled | ( | ) | const |
true
if source transcription is enabled bool Digikam::DOnlineTranslator::isSourceTranslitEnabled | ( | ) | const |
true
if source transliteration is enabled engine | the engine to use |
lang | language |
true
if the specified engine supports transliteration for specified language bool Digikam::DOnlineTranslator::isTranslationOptionsEnabled | ( | ) | const |
true
if translation options are enabled bool Digikam::DOnlineTranslator::isTranslationTranslitEnabled | ( | ) | const |
true
if translation transliteration is enabled
|
static |
locale | the locale to use |
|
static |
langCode | code |
|
static |
lang | language |
|
static |
lang | language |
void Digikam::DOnlineTranslator::setEngineApiKey | ( | Engine | engine, |
const QByteArray & | apiKey | ||
) |
Affects only LibreTranslate.
engine | the engine to use |
apiKey | your key for this particular instance |
void Digikam::DOnlineTranslator::setEngineUrl | ( | Engine | engine, |
const QString & | url | ||
) |
Only affects LibreTranslate and Lingva because these engines have multiple instances. You need to call this function to specify the URL of an instance for them.
engine | the engine to use |
url | engine url |
void Digikam::DOnlineTranslator::setSourceTranscriptionEnabled | ( | bool | enable | ) |
enable | whether to enable source transcription |
void Digikam::DOnlineTranslator::setSourceTranslitEnabled | ( | bool | enable | ) |
enable | whether to enable source transliteration |
void Digikam::DOnlineTranslator::setTranslationOptionsEnabled | ( | bool | enable | ) |
enable | whether to enable translation options |
void Digikam::DOnlineTranslator::setTranslationTranslitEnabled | ( | bool | enable | ) |
enable | whether to enable translation transliteration |
|
signal |
This signal is emitted when the translation is complete.
QString Digikam::DOnlineTranslator::source | ( | ) | const |
DOnlineTranslator::Language Digikam::DOnlineTranslator::sourceLanguage | ( | ) | const |
QString Digikam::DOnlineTranslator::sourceLanguageName | ( | ) | const |
QString Digikam::DOnlineTranslator::sourceTranscription | ( | ) | const |
QString Digikam::DOnlineTranslator::sourceTranslit | ( | ) | const |
QJsonDocument Digikam::DOnlineTranslator::toJson | ( | ) | const |
void Digikam::DOnlineTranslator::translate | ( | const QString & | text, |
Engine | engine = Google , |
||
Language | translationLang = Auto , |
||
Language | sourceLang = Auto , |
||
Language | uiLang = Auto |
||
) |
text | the text to translate |
engine | online engine to use |
translationLang | language to translation |
sourceLang | language of the passed text |
uiLang | ui language to use for display |
QString Digikam::DOnlineTranslator::translation | ( | ) | const |
DOnlineTranslator::Language Digikam::DOnlineTranslator::translationLanguage | ( | ) | const |
QString Digikam::DOnlineTranslator::translationLanguageName | ( | ) | const |
QMap< QString, QVector< DOnlineTranslatorOption > > Digikam::DOnlineTranslator::translationOptions | ( | ) | const |
QString Digikam::DOnlineTranslator::translationTranslit | ( | ) | const |