src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9148
b31f0d894b55
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__</h1>
10
11 <p>
12 Package containing the various translation engines.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22 <tr><td>None</td></tr>
23 </table>
24 <h3>Functions</h3>
25
26 <table>
27
28 <tr>
29 <td><a href="#engineDisplayName">engineDisplayName</a></td>
30 <td>Module function to get a translated name for an engine.</td>
31 </tr>
32 <tr>
33 <td><a href="#getEngineIcon">getEngineIcon</a></td>
34 <td>Module function to get the icon of the named engine.</td>
35 </tr>
36 <tr>
37 <td><a href="#getKeyUrl">getKeyUrl</a></td>
38 <td>Module function to get an URL to request a user key.</td>
39 </tr>
40 <tr>
41 <td><a href="#getTranslationEngine">getTranslationEngine</a></td>
42 <td>Module function to instantiate an engine object for the named service.</td>
43 </tr>
44 <tr>
45 <td><a href="#supportedEngineNames">supportedEngineNames</a></td>
46 <td>Module function to get the list of supported translation engines.</td>
47 </tr>
48 </table>
49 <hr />
50 <hr />
51 <a NAME="engineDisplayName" ID="engineDisplayName"></a>
52 <h2>engineDisplayName</h2>
53 <b>engineDisplayName</b>(<i>name</i>)
54
55 <p>
56 Module function to get a translated name for an engine.
57 </p>
58 <dl>
59
60 <dt><i>name</i> (str)</dt>
61 <dd>
62 name of a translation engine
63 </dd>
64 </dl>
65 <dl>
66 <dt>Return:</dt>
67 <dd>
68 translated engine name
69 </dd>
70 </dl>
71 <dl>
72 <dt>Return Type:</dt>
73 <dd>
74 str
75 </dd>
76 </dl>
77 <div align="right"><a href="#top">Up</a></div>
78 <hr />
79 <hr />
80 <a NAME="getEngineIcon" ID="getEngineIcon"></a>
81 <h2>getEngineIcon</h2>
82 <b>getEngineIcon</b>(<i>name</i>)
83
84 <p>
85 Module function to get the icon of the named engine.
86 </p>
87 <dl>
88
89 <dt><i>name</i> (str)</dt>
90 <dd>
91 name of the translation engine
92 </dd>
93 </dl>
94 <dl>
95 <dt>Return:</dt>
96 <dd>
97 engine icon
98 </dd>
99 </dl>
100 <dl>
101 <dt>Return Type:</dt>
102 <dd>
103 QIcon
104 </dd>
105 </dl>
106 <div align="right"><a href="#top">Up</a></div>
107 <hr />
108 <hr />
109 <a NAME="getKeyUrl" ID="getKeyUrl"></a>
110 <h2>getKeyUrl</h2>
111 <b>getKeyUrl</b>(<i>name</i>)
112
113 <p>
114 Module function to get an URL to request a user key.
115 </p>
116 <dl>
117
118 <dt><i>name</i> (str)</dt>
119 <dd>
120 name of the online translation service
121 </dd>
122 </dl>
123 <dl>
124 <dt>Return:</dt>
125 <dd>
126 key request URL
127 </dd>
128 </dl>
129 <dl>
130 <dt>Return Type:</dt>
131 <dd>
132 str
133 </dd>
134 </dl>
135 <div align="right"><a href="#top">Up</a></div>
136 <hr />
137 <hr />
138 <a NAME="getTranslationEngine" ID="getTranslationEngine"></a>
139 <h2>getTranslationEngine</h2>
140 <b>getTranslationEngine</b>(<i>name, plugin, parent=None</i>)
141
142 <p>
143 Module function to instantiate an engine object for the named service.
144 </p>
145 <dl>
146
147 <dt><i>name</i> (str)</dt>
148 <dd>
149 name of the online translation service
150 </dd>
151 <dt><i>plugin</i> (TranslatorPlugin)</dt>
152 <dd>
153 reference to the plugin object
154 </dd>
155 <dt><i>parent</i> (QObject)</dt>
156 <dd>
157 reference to the parent object
158 </dd>
159 </dl>
160 <dl>
161 <dt>Return:</dt>
162 <dd>
163 translation engine
164 </dd>
165 </dl>
166 <dl>
167 <dt>Return Type:</dt>
168 <dd>
169 TranslatorEngine
170 </dd>
171 </dl>
172 <div align="right"><a href="#top">Up</a></div>
173 <hr />
174 <hr />
175 <a NAME="supportedEngineNames" ID="supportedEngineNames"></a>
176 <h2>supportedEngineNames</h2>
177 <b>supportedEngineNames</b>(<i></i>)
178
179 <p>
180 Module function to get the list of supported translation engines.
181 </p>
182 <dl>
183 <dt>Return:</dt>
184 <dd>
185 names of supported engines
186 </dd>
187 </dl>
188 <dl>
189 <dt>Return Type:</dt>
190 <dd>
191 list of str
192 </dd>
193 </dl>
194 <div align="right"><a href="#top">Up</a></div>
195 <hr />
196 </body></html>

eric ide

mercurial