Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.PluginTranslator.html

eric6/Documentation/Source/eric6.Plugins.PluginTranslator.html

changeset 7273
391d6b7b1eff
parent 7204
cbf6d88004ce
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.PluginTranslator</h1> 23 <h1>eric6.Plugins.PluginTranslator</h1>
24
23 <p> 25 <p>
24 Module implementing the Translator plugin. 26 Module implementing the Translator plugin.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>translatorPluginObject</td></tr><tr><td>version</td></tr> 31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>translatorPluginObject</td></tr><tr><td>version</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#TranslatorPlugin">TranslatorPlugin</a></td> 38 <td><a href="#TranslatorPlugin">TranslatorPlugin</a></td>
34 <td>Class implementing the Translator plug-in.</td> 39 <td>Class implementing the Translator plug-in.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#createTranslatorPage">createTranslatorPage</a></td> 47 <td><a href="#createTranslatorPage">createTranslatorPage</a></td>
41 <td>Module function to create the Translator configuration page.</td> 48 <td>Module function to create the Translator configuration page.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#getConfigData">getConfigData</a></td> 51 <td><a href="#getConfigData">getConfigData</a></td>
44 <td>Module function returning data as required by the configuration dialog.</td> 52 <td>Module function returning data as required by the configuration dialog.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#prepareUninstall">prepareUninstall</a></td> 55 <td><a href="#prepareUninstall">prepareUninstall</a></td>
47 <td>Module function to prepare for an uninstallation.</td> 56 <td>Module function to prepare for an uninstallation.</td>
48 </tr> 57 </tr>
49 </table> 58 </table>
50 <hr /><hr /> 59 <hr />
60 <hr />
51 <a NAME="TranslatorPlugin" ID="TranslatorPlugin"></a> 61 <a NAME="TranslatorPlugin" ID="TranslatorPlugin"></a>
52 <h2>TranslatorPlugin</h2> 62 <h2>TranslatorPlugin</h2>
63
53 <p> 64 <p>
54 Class implementing the Translator plug-in. 65 Class implementing the Translator plug-in.
55 </p><h3>Signals</h3> 66 </p>
56 <dl> 67 <h3>Signals</h3>
68 <dl>
69
57 <dt>updateLanguages()</dt> 70 <dt>updateLanguages()</dt>
58 <dd> 71 <dd>
59 emitted to indicate a languages update 72 emitted to indicate a languages update
60 </dd> 73 </dd>
61 </dl> 74 </dl>
62 <h3>Derived from</h3> 75 <h3>Derived from</h3>
63 QObject 76 QObject
64 <h3>Class Attributes</h3> 77 <h3>Class Attributes</h3>
78
65 <table> 79 <table>
66 <tr><td>PreferencesKey</td></tr> 80 <tr><td>PreferencesKey</td></tr>
67 </table> 81 </table>
68 <h3>Class Methods</h3> 82 <h3>Class Methods</h3>
83
69 <table> 84 <table>
70 <tr><td>None</td></tr> 85 <tr><td>None</td></tr>
71 </table> 86 </table>
72 <h3>Methods</h3> 87 <h3>Methods</h3>
73 <table> 88
89 <table>
90
74 <tr> 91 <tr>
75 <td><a href="#TranslatorPlugin.__init__">TranslatorPlugin</a></td> 92 <td><a href="#TranslatorPlugin.__init__">TranslatorPlugin</a></td>
76 <td>Constructor</td> 93 <td>Constructor</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#TranslatorPlugin.__initialize">__initialize</a></td> 96 <td><a href="#TranslatorPlugin.__initialize">__initialize</a></td>
79 <td>Private slot to (re)initialize the plugin.</td> 97 <td>Private slot to (re)initialize the plugin.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#TranslatorPlugin.activate">activate</a></td> 100 <td><a href="#TranslatorPlugin.activate">activate</a></td>
82 <td>Public method to activate this plugin.</td> 101 <td>Public method to activate this plugin.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#TranslatorPlugin.deactivate">deactivate</a></td> 104 <td><a href="#TranslatorPlugin.deactivate">deactivate</a></td>
85 <td>Public method to deactivate this plugin.</td> 105 <td>Public method to deactivate this plugin.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#TranslatorPlugin.getPreferences">getPreferences</a></td> 108 <td><a href="#TranslatorPlugin.getPreferences">getPreferences</a></td>
88 <td>Public method to retrieve the various settings.</td> 109 <td>Public method to retrieve the various settings.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#TranslatorPlugin.getPreferencesDefault">getPreferencesDefault</a></td> 112 <td><a href="#TranslatorPlugin.getPreferencesDefault">getPreferencesDefault</a></td>
91 <td>Public method to retrieve the various default settings.</td> 113 <td>Public method to retrieve the various default settings.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#TranslatorPlugin.setPreferences">setPreferences</a></td> 116 <td><a href="#TranslatorPlugin.setPreferences">setPreferences</a></td>
94 <td>Public method to store the various settings.</td> 117 <td>Public method to store the various settings.</td>
95 </tr> 118 </tr>
96 </table> 119 </table>
97 <h3>Static Methods</h3> 120 <h3>Static Methods</h3>
121
98 <table> 122 <table>
99 <tr><td>None</td></tr> 123 <tr><td>None</td></tr>
100 </table> 124 </table>
125
101 <a NAME="TranslatorPlugin.__init__" ID="TranslatorPlugin.__init__"></a> 126 <a NAME="TranslatorPlugin.__init__" ID="TranslatorPlugin.__init__"></a>
102 <h4>TranslatorPlugin (Constructor)</h4> 127 <h4>TranslatorPlugin (Constructor)</h4>
103 <b>TranslatorPlugin</b>(<i>ui</i>) 128 <b>TranslatorPlugin</b>(<i>ui</i>)
129
104 <p> 130 <p>
105 Constructor 131 Constructor
106 </p><dl> 132 </p>
133 <dl>
134
107 <dt><i>ui</i></dt> 135 <dt><i>ui</i></dt>
108 <dd> 136 <dd>
109 reference to the user interface object (UI.UserInterface) 137 reference to the user interface object (UI.UserInterface)
110 </dd> 138 </dd>
111 </dl><a NAME="TranslatorPlugin.__initialize" ID="TranslatorPlugin.__initialize"></a> 139 </dl>
140 <a NAME="TranslatorPlugin.__initialize" ID="TranslatorPlugin.__initialize"></a>
112 <h4>TranslatorPlugin.__initialize</h4> 141 <h4>TranslatorPlugin.__initialize</h4>
113 <b>__initialize</b>(<i></i>) 142 <b>__initialize</b>(<i></i>)
143
114 <p> 144 <p>
115 Private slot to (re)initialize the plugin. 145 Private slot to (re)initialize the plugin.
116 </p><a NAME="TranslatorPlugin.activate" ID="TranslatorPlugin.activate"></a> 146 </p>
147 <a NAME="TranslatorPlugin.activate" ID="TranslatorPlugin.activate"></a>
117 <h4>TranslatorPlugin.activate</h4> 148 <h4>TranslatorPlugin.activate</h4>
118 <b>activate</b>(<i></i>) 149 <b>activate</b>(<i></i>)
150
119 <p> 151 <p>
120 Public method to activate this plugin. 152 Public method to activate this plugin.
121 </p><dl> 153 </p>
154 <dl>
122 <dt>Returns:</dt> 155 <dt>Returns:</dt>
123 <dd> 156 <dd>
124 tuple of None and activation status (boolean) 157 tuple of None and activation status (boolean)
125 </dd> 158 </dd>
126 </dl><a NAME="TranslatorPlugin.deactivate" ID="TranslatorPlugin.deactivate"></a> 159 </dl>
160 <a NAME="TranslatorPlugin.deactivate" ID="TranslatorPlugin.deactivate"></a>
127 <h4>TranslatorPlugin.deactivate</h4> 161 <h4>TranslatorPlugin.deactivate</h4>
128 <b>deactivate</b>(<i></i>) 162 <b>deactivate</b>(<i></i>)
163
129 <p> 164 <p>
130 Public method to deactivate this plugin. 165 Public method to deactivate this plugin.
131 </p><a NAME="TranslatorPlugin.getPreferences" ID="TranslatorPlugin.getPreferences"></a> 166 </p>
167 <a NAME="TranslatorPlugin.getPreferences" ID="TranslatorPlugin.getPreferences"></a>
132 <h4>TranslatorPlugin.getPreferences</h4> 168 <h4>TranslatorPlugin.getPreferences</h4>
133 <b>getPreferences</b>(<i>key</i>) 169 <b>getPreferences</b>(<i>key</i>)
170
134 <p> 171 <p>
135 Public method to retrieve the various settings. 172 Public method to retrieve the various settings.
136 </p><dl> 173 </p>
174 <dl>
175
137 <dt><i>key</i></dt> 176 <dt><i>key</i></dt>
138 <dd> 177 <dd>
139 the key of the value to get 178 the key of the value to get
140 </dd> 179 </dd>
141 </dl><dl> 180 </dl>
181 <dl>
142 <dt>Returns:</dt> 182 <dt>Returns:</dt>
143 <dd> 183 <dd>
144 the requested setting 184 the requested setting
145 </dd> 185 </dd>
146 </dl><a NAME="TranslatorPlugin.getPreferencesDefault" ID="TranslatorPlugin.getPreferencesDefault"></a> 186 </dl>
187 <a NAME="TranslatorPlugin.getPreferencesDefault" ID="TranslatorPlugin.getPreferencesDefault"></a>
147 <h4>TranslatorPlugin.getPreferencesDefault</h4> 188 <h4>TranslatorPlugin.getPreferencesDefault</h4>
148 <b>getPreferencesDefault</b>(<i>key</i>) 189 <b>getPreferencesDefault</b>(<i>key</i>)
190
149 <p> 191 <p>
150 Public method to retrieve the various default settings. 192 Public method to retrieve the various default settings.
151 </p><dl> 193 </p>
194 <dl>
195
152 <dt><i>key</i></dt> 196 <dt><i>key</i></dt>
153 <dd> 197 <dd>
154 the key of the value to get 198 the key of the value to get
155 </dd> 199 </dd>
156 </dl><dl> 200 </dl>
201 <dl>
157 <dt>Returns:</dt> 202 <dt>Returns:</dt>
158 <dd> 203 <dd>
159 the requested setting 204 the requested setting
160 </dd> 205 </dd>
161 </dl><a NAME="TranslatorPlugin.setPreferences" ID="TranslatorPlugin.setPreferences"></a> 206 </dl>
207 <a NAME="TranslatorPlugin.setPreferences" ID="TranslatorPlugin.setPreferences"></a>
162 <h4>TranslatorPlugin.setPreferences</h4> 208 <h4>TranslatorPlugin.setPreferences</h4>
163 <b>setPreferences</b>(<i>key, value</i>) 209 <b>setPreferences</b>(<i>key, value</i>)
210
164 <p> 211 <p>
165 Public method to store the various settings. 212 Public method to store the various settings.
166 </p><dl> 213 </p>
214 <dl>
215
167 <dt><i>key</i></dt> 216 <dt><i>key</i></dt>
168 <dd> 217 <dd>
169 the key of the setting to be set (string) 218 the key of the setting to be set (string)
170 </dd><dt><i>value</i></dt> 219 </dd>
220 <dt><i>value</i></dt>
171 <dd> 221 <dd>
172 the value to be set 222 the value to be set
173 </dd> 223 </dd>
174 </dl> 224 </dl>
175 <div align="right"><a href="#top">Up</a></div> 225 <div align="right"><a href="#top">Up</a></div>
176 <hr /><hr /> 226 <hr />
227 <hr />
177 <a NAME="createTranslatorPage" ID="createTranslatorPage"></a> 228 <a NAME="createTranslatorPage" ID="createTranslatorPage"></a>
178 <h2>createTranslatorPage</h2> 229 <h2>createTranslatorPage</h2>
179 <b>createTranslatorPage</b>(<i>configDlg</i>) 230 <b>createTranslatorPage</b>(<i>configDlg</i>)
231
180 <p> 232 <p>
181 Module function to create the Translator configuration page. 233 Module function to create the Translator configuration page.
182 </p><dl> 234 </p>
235 <dl>
236
183 <dt><i>configDlg</i></dt> 237 <dt><i>configDlg</i></dt>
184 <dd> 238 <dd>
185 reference to the configuration dialog 239 reference to the configuration dialog
186 </dd> 240 </dd>
187 </dl><dl> 241 </dl>
242 <dl>
188 <dt>Returns:</dt> 243 <dt>Returns:</dt>
189 <dd> 244 <dd>
190 reference to the configuration page 245 reference to the configuration page
191 </dd> 246 </dd>
192 </dl> 247 </dl>
193 <div align="right"><a href="#top">Up</a></div> 248 <div align="right"><a href="#top">Up</a></div>
194 <hr /><hr /> 249 <hr />
250 <hr />
195 <a NAME="getConfigData" ID="getConfigData"></a> 251 <a NAME="getConfigData" ID="getConfigData"></a>
196 <h2>getConfigData</h2> 252 <h2>getConfigData</h2>
197 <b>getConfigData</b>(<i></i>) 253 <b>getConfigData</b>(<i></i>)
254
198 <p> 255 <p>
199 Module function returning data as required by the configuration dialog. 256 Module function returning data as required by the configuration dialog.
200 </p><dl> 257 </p>
258 <dl>
201 <dt>Returns:</dt> 259 <dt>Returns:</dt>
202 <dd> 260 <dd>
203 dictionary containing the relevant data 261 dictionary containing the relevant data
204 </dd> 262 </dd>
205 </dl> 263 </dl>
206 <div align="right"><a href="#top">Up</a></div> 264 <div align="right"><a href="#top">Up</a></div>
207 <hr /><hr /> 265 <hr />
266 <hr />
208 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 267 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
209 <h2>prepareUninstall</h2> 268 <h2>prepareUninstall</h2>
210 <b>prepareUninstall</b>(<i></i>) 269 <b>prepareUninstall</b>(<i></i>)
270
211 <p> 271 <p>
212 Module function to prepare for an uninstallation. 272 Module function to prepare for an uninstallation.
213 </p> 273 </p>
214 <div align="right"><a href="#top">Up</a></div> 274 <div align="right"><a href="#top">Up</a></div>
215 <hr /> 275 <hr />

Mercurial Repository: eric

eric ide

mercurial