Plugins/UiExtensionPlugins/Translator/TranslatorEngines/TranslationEngine.py

changeset 6018
1c858879d3d0
child 6048
82ad8ec9548c
diff -r dab01678626d -r 1c858879d3d0 Plugins/UiExtensionPlugins/Translator/TranslatorEngines/TranslationEngine.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Plugins/UiExtensionPlugins/Translator/TranslatorEngines/TranslationEngine.py	Sun Dec 10 16:23:29 2017 +0100
@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2014 - 2017 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing the translation engine base class.
+"""
+
+from __future__ import unicode_literals
+
+from PyQt5.QtCore import QObject
+
+
+class TranslationEngine(QObject):
+    """
+    Class implementing the translation engine base class containing
+    default methods.
+    """
+    def __init__(self, plugin, parent=None):
+        """
+        Constructor
+        
+        @param plugin reference to the plugin object (TranslatorPlugin)
+        @param parent reference to the parent object (QObject)
+        """
+        super(TranslationEngine, self).__init__(parent)
+        
+        self.plugin = plugin
+    
+    def engineName(self):
+        """
+        Public method to get the name of the engine.
+        
+        @return engine name (string)
+        """
+        return ""
+    
+    def supportedLanguages(self):
+        """
+        Public method to get the supported languages.
+        
+        @return list of supported language codes (list of string)
+        """
+        return []
+    
+    def hasTTS(self):
+        """
+        Public method indicating the Text-to-Speech capability.
+        
+        @return flag indicating the Text-to-Speech capability (boolean)
+        """
+        return False
+    
+    def getTextToSpeechData(self, requestObject, text, language):
+        """
+        Public method to pronounce the given text.
+        
+        @param requestObject reference to the request object
+            (TranslatorRequest)
+        @param text text to be pronounced (string)
+        @param language language code of the text (string)
+        @return tuple with pronounce data (QByteArray) or error string (string)
+            and success flag (boolean)
+        """
+        return self.tr("No pronounce data available"), False
+    
+    def getTranslation(self, requestObject, text, originalLanguage,
+                       translationLanguage):
+        """
+        Public method to translate the given text.
+        
+        @param requestObject reference to the request object
+            (TranslatorRequest)
+        @param text text to be translated (string)
+        @param originalLanguage language code of the original (string)
+        @param translationLanguage language code of the translation (string)
+        @return tuple of translated text (string) and flag indicating
+            success (boolean)
+        """
+        return self.tr("No translation available"), False

eric ide

mercurial