eric6/Documentation/Source/eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__</h1> 23 <h1>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__</h1>
24
23 <p> 25 <p>
24 Package containing the various translation engines. 26 Package containing the various translation engines.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
32 <tr><td>None</td></tr> 36 <tr><td>None</td></tr>
33 </table> 37 </table>
34 <h3>Functions</h3> 38 <h3>Functions</h3>
39
35 <table> 40 <table>
41
36 <tr> 42 <tr>
37 <td><a href="#engineDisplayName">engineDisplayName</a></td> 43 <td><a href="#engineDisplayName">engineDisplayName</a></td>
38 <td>Module function to get a translated name for an engine.</td> 44 <td>Module function to get a translated name for an engine.</td>
39 </tr><tr> 45 </tr>
46 <tr>
40 <td><a href="#getEngineIcon">getEngineIcon</a></td> 47 <td><a href="#getEngineIcon">getEngineIcon</a></td>
41 <td>Module function to get the icon of the named engine.</td> 48 <td>Module function to get the icon of the named engine.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#getKeyUrl">getKeyUrl</a></td> 51 <td><a href="#getKeyUrl">getKeyUrl</a></td>
44 <td>Module function to get an URL to request a user key.</td> 52 <td>Module function to get an URL to request a user key.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#getTranslationEngine">getTranslationEngine</a></td> 55 <td><a href="#getTranslationEngine">getTranslationEngine</a></td>
47 <td>Module function to instantiate an engine object for the named service.</td> 56 <td>Module function to instantiate an engine object for the named service.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#supportedEngineNames">supportedEngineNames</a></td> 59 <td><a href="#supportedEngineNames">supportedEngineNames</a></td>
50 <td>Module function to get the list of supported translation engines.</td> 60 <td>Module function to get the list of supported translation engines.</td>
51 </tr> 61 </tr>
52 </table> 62 </table>
53 <hr /><hr /> 63 <hr />
64 <hr />
54 <a NAME="engineDisplayName" ID="engineDisplayName"></a> 65 <a NAME="engineDisplayName" ID="engineDisplayName"></a>
55 <h2>engineDisplayName</h2> 66 <h2>engineDisplayName</h2>
56 <b>engineDisplayName</b>(<i>name</i>) 67 <b>engineDisplayName</b>(<i>name</i>)
68
57 <p> 69 <p>
58 Module function to get a translated name for an engine. 70 Module function to get a translated name for an engine.
59 </p><dl> 71 </p>
72 <dl>
73
60 <dt><i>name</i></dt> 74 <dt><i>name</i></dt>
61 <dd> 75 <dd>
62 name of a translation engine (string) 76 name of a translation engine (string)
63 </dd> 77 </dd>
64 </dl><dl> 78 </dl>
79 <dl>
65 <dt>Returns:</dt> 80 <dt>Returns:</dt>
66 <dd> 81 <dd>
67 translated engine name (string) 82 translated engine name (string)
68 </dd> 83 </dd>
69 </dl> 84 </dl>
70 <div align="right"><a href="#top">Up</a></div> 85 <div align="right"><a href="#top">Up</a></div>
71 <hr /><hr /> 86 <hr />
87 <hr />
72 <a NAME="getEngineIcon" ID="getEngineIcon"></a> 88 <a NAME="getEngineIcon" ID="getEngineIcon"></a>
73 <h2>getEngineIcon</h2> 89 <h2>getEngineIcon</h2>
74 <b>getEngineIcon</b>(<i>name</i>) 90 <b>getEngineIcon</b>(<i>name</i>)
91
75 <p> 92 <p>
76 Module function to get the icon of the named engine. 93 Module function to get the icon of the named engine.
77 </p><dl> 94 </p>
95 <dl>
96
78 <dt><i>name</i> (str)</dt> 97 <dt><i>name</i> (str)</dt>
79 <dd> 98 <dd>
80 name of the translation engine 99 name of the translation engine
81 </dd> 100 </dd>
82 </dl><dl> 101 </dl>
102 <dl>
83 <dt>Returns:</dt> 103 <dt>Returns:</dt>
84 <dd> 104 <dd>
85 engine icon 105 engine icon
86 </dd> 106 </dd>
87 </dl><dl> 107 </dl>
108 <dl>
88 <dt>Return Type:</dt> 109 <dt>Return Type:</dt>
89 <dd> 110 <dd>
90 QIcon 111 QIcon
91 </dd> 112 </dd>
92 </dl> 113 </dl>
93 <div align="right"><a href="#top">Up</a></div> 114 <div align="right"><a href="#top">Up</a></div>
94 <hr /><hr /> 115 <hr />
116 <hr />
95 <a NAME="getKeyUrl" ID="getKeyUrl"></a> 117 <a NAME="getKeyUrl" ID="getKeyUrl"></a>
96 <h2>getKeyUrl</h2> 118 <h2>getKeyUrl</h2>
97 <b>getKeyUrl</b>(<i>name</i>) 119 <b>getKeyUrl</b>(<i>name</i>)
120
98 <p> 121 <p>
99 Module function to get an URL to request a user key. 122 Module function to get an URL to request a user key.
100 </p><dl> 123 </p>
124 <dl>
125
101 <dt><i>name</i></dt> 126 <dt><i>name</i></dt>
102 <dd> 127 <dd>
103 name of the online translation service (string) 128 name of the online translation service (string)
104 </dd> 129 </dd>
105 </dl><dl> 130 </dl>
131 <dl>
106 <dt>Returns:</dt> 132 <dt>Returns:</dt>
107 <dd> 133 <dd>
108 key request URL (string) 134 key request URL (string)
109 </dd> 135 </dd>
110 </dl> 136 </dl>
111 <div align="right"><a href="#top">Up</a></div> 137 <div align="right"><a href="#top">Up</a></div>
112 <hr /><hr /> 138 <hr />
139 <hr />
113 <a NAME="getTranslationEngine" ID="getTranslationEngine"></a> 140 <a NAME="getTranslationEngine" ID="getTranslationEngine"></a>
114 <h2>getTranslationEngine</h2> 141 <h2>getTranslationEngine</h2>
115 <b>getTranslationEngine</b>(<i>name, plugin, parent=None</i>) 142 <b>getTranslationEngine</b>(<i>name, plugin, parent=None</i>)
143
116 <p> 144 <p>
117 Module function to instantiate an engine object for the named service. 145 Module function to instantiate an engine object for the named service.
118 </p><dl> 146 </p>
147 <dl>
148
119 <dt><i>name</i></dt> 149 <dt><i>name</i></dt>
120 <dd> 150 <dd>
121 name of the online translation service (string) 151 name of the online translation service (string)
122 </dd><dt><i>plugin</i></dt> 152 </dd>
153 <dt><i>plugin</i></dt>
123 <dd> 154 <dd>
124 reference to the plugin object (TranslatorPlugin) 155 reference to the plugin object (TranslatorPlugin)
125 </dd><dt><i>parent</i></dt> 156 </dd>
157 <dt><i>parent</i></dt>
126 <dd> 158 <dd>
127 reference to the parent object 159 reference to the parent object
128 </dd> 160 </dd>
129 </dl><dl> 161 </dl>
162 <dl>
130 <dt>Returns:</dt> 163 <dt>Returns:</dt>
131 <dd> 164 <dd>
132 translation engine (TranslatorEngine) 165 translation engine (TranslatorEngine)
133 </dd> 166 </dd>
134 </dl> 167 </dl>
135 <div align="right"><a href="#top">Up</a></div> 168 <div align="right"><a href="#top">Up</a></div>
136 <hr /><hr /> 169 <hr />
170 <hr />
137 <a NAME="supportedEngineNames" ID="supportedEngineNames"></a> 171 <a NAME="supportedEngineNames" ID="supportedEngineNames"></a>
138 <h2>supportedEngineNames</h2> 172 <h2>supportedEngineNames</h2>
139 <b>supportedEngineNames</b>(<i></i>) 173 <b>supportedEngineNames</b>(<i></i>)
174
140 <p> 175 <p>
141 Module function to get the list of supported translation engines. 176 Module function to get the list of supported translation engines.
142 </p><dl> 177 </p>
178 <dl>
143 <dt>Returns:</dt> 179 <dt>Returns:</dt>
144 <dd> 180 <dd>
145 names of supported engines (list of string) 181 names of supported engines (list of string)
146 </dd> 182 </dd>
147 </dl> 183 </dl>

eric ide

mercurial