Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__.html
Documentation/Source/eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__.html
- changeset 6018
- 1c858879d3d0
equal
deleted
inserted
replaced
| 6017:dab01678626d | 6018:1c858879d3d0 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__</h1> | |
| 23 <p> | |
| 24 Package containing the various translation engines. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Functions</h3> | |
| 35 <table> | |
| 36 <tr> | |
| 37 <td><a href="#engineDisplayName">engineDisplayName</a></td> | |
| 38 <td>Module function to get a translated name for an engine.</td> | |
| 39 </tr><tr> | |
| 40 <td><a href="#getEngineIcon">getEngineIcon</a></td> | |
| 41 <td>Module function to get the icon of the named engine.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#getKeyUrl">getKeyUrl</a></td> | |
| 44 <td>Module function to get an URL to request a user key.</td> | |
| 45 </tr><tr> | |
| 46 <td><a href="#getTranslationEngine">getTranslationEngine</a></td> | |
| 47 <td>Module function to instantiate an engine object for the named service.</td> | |
| 48 </tr><tr> | |
| 49 <td><a href="#supportedEngineNames">supportedEngineNames</a></td> | |
| 50 <td>Module function to get the list of supported translation engines.</td> | |
| 51 </tr> | |
| 52 </table> | |
| 53 <hr /><hr /> | |
| 54 <a NAME="engineDisplayName" ID="engineDisplayName"></a> | |
| 55 <h2>engineDisplayName</h2> | |
| 56 <b>engineDisplayName</b>(<i>name</i>) | |
| 57 <p> | |
| 58 Module function to get a translated name for an engine. | |
| 59 </p><dl> | |
| 60 <dt><i>name</i></dt> | |
| 61 <dd> | |
| 62 name of a translation engine (string) | |
| 63 </dd> | |
| 64 </dl><dl> | |
| 65 <dt>Returns:</dt> | |
| 66 <dd> | |
| 67 translated engine name (string) | |
| 68 </dd> | |
| 69 </dl> | |
| 70 <div align="right"><a href="#top">Up</a></div> | |
| 71 <hr /><hr /> | |
| 72 <a NAME="getEngineIcon" ID="getEngineIcon"></a> | |
| 73 <h2>getEngineIcon</h2> | |
| 74 <b>getEngineIcon</b>(<i>name</i>) | |
| 75 <p> | |
| 76 Module function to get the icon of the named engine. | |
| 77 </p><dl> | |
| 78 <dt><i>name</i> (str)</dt> | |
| 79 <dd> | |
| 80 name of the translation engine | |
| 81 </dd> | |
| 82 </dl><dl> | |
| 83 <dt>Returns:</dt> | |
| 84 <dd> | |
| 85 engine icon | |
| 86 </dd> | |
| 87 </dl><dl> | |
| 88 <dt>Return Type:</dt> | |
| 89 <dd> | |
| 90 QIcon | |
| 91 </dd> | |
| 92 </dl> | |
| 93 <div align="right"><a href="#top">Up</a></div> | |
| 94 <hr /><hr /> | |
| 95 <a NAME="getKeyUrl" ID="getKeyUrl"></a> | |
| 96 <h2>getKeyUrl</h2> | |
| 97 <b>getKeyUrl</b>(<i>name</i>) | |
| 98 <p> | |
| 99 Module function to get an URL to request a user key. | |
| 100 </p><dl> | |
| 101 <dt><i>name</i></dt> | |
| 102 <dd> | |
| 103 name of the online translation service (string) | |
| 104 </dd> | |
| 105 </dl><dl> | |
| 106 <dt>Returns:</dt> | |
| 107 <dd> | |
| 108 key request URL (string) | |
| 109 </dd> | |
| 110 </dl> | |
| 111 <div align="right"><a href="#top">Up</a></div> | |
| 112 <hr /><hr /> | |
| 113 <a NAME="getTranslationEngine" ID="getTranslationEngine"></a> | |
| 114 <h2>getTranslationEngine</h2> | |
| 115 <b>getTranslationEngine</b>(<i>name, plugin, parent=None</i>) | |
| 116 <p> | |
| 117 Module function to instantiate an engine object for the named service. | |
| 118 </p><dl> | |
| 119 <dt><i>name</i></dt> | |
| 120 <dd> | |
| 121 name of the online translation service (string) | |
| 122 </dd><dt><i>plugin</i></dt> | |
| 123 <dd> | |
| 124 reference to the plugin object (TranslatorPlugin) | |
| 125 </dd><dt><i>parent</i></dt> | |
| 126 <dd> | |
| 127 reference to the parent object | |
| 128 </dd> | |
| 129 </dl><dl> | |
| 130 <dt>Returns:</dt> | |
| 131 <dd> | |
| 132 translation engine (TranslatorEngine) | |
| 133 </dd> | |
| 134 </dl> | |
| 135 <div align="right"><a href="#top">Up</a></div> | |
| 136 <hr /><hr /> | |
| 137 <a NAME="supportedEngineNames" ID="supportedEngineNames"></a> | |
| 138 <h2>supportedEngineNames</h2> | |
| 139 <b>supportedEngineNames</b>(<i></i>) | |
| 140 <p> | |
| 141 Module function to get the list of supported translation engines. | |
| 142 </p><dl> | |
| 143 <dt>Returns:</dt> | |
| 144 <dd> | |
| 145 names of supported engines (list of string) | |
| 146 </dd> | |
| 147 </dl> | |
| 148 <div align="right"><a href="#top">Up</a></div> | |
| 149 <hr /> | |
| 150 </body></html> |
