Mercurial Repositories > Flask Project / file comparison

comparison: ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html

ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html

changeset 19
f8e3c1676f9b
child 37
1bd8d19a3aa7
equal deleted inserted replaced
18:d76a0939be6a 19:f8e3c1676f9b
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension</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>
22 <a NAME="top" ID="top"></a>
23 <h1>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension</h1>
24
25 <p>
26 Module implementing the project support for flask-babel.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#PyBabelProject">PyBabelProject</a></td>
39 <td>Class implementing the Flask project support.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="PyBabelProject" ID="PyBabelProject"></a>
50 <h2>PyBabelProject</h2>
51
52 <p>
53 Class implementing the Flask project support.
54 </p>
55 <h3>Derived from</h3>
56 QObject
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#PyBabelProject.__init__">PyBabelProject</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#PyBabelProject.__createBabelCfg">__createBabelCfg</a></td>
77 <td>Private method to create a template pybabel configuration file.</td>
78 </tr>
79 <tr>
80 <td><a href="#PyBabelProject.__ensurePybabelConfigured">__ensurePybabelConfigured</a></td>
81 <td>Private method to ensure, that PyBabel has been configured.</td>
82 </tr>
83 <tr>
84 <td><a href="#PyBabelProject.__getLocale">__getLocale</a></td>
85 <td>Private method to extract the locale out of a file name.</td>
86 </tr>
87 <tr>
88 <td><a href="#PyBabelProject.__projectLanguageAdded">__projectLanguageAdded</a></td>
89 <td>Private slot handling the addition of a new language.</td>
90 </tr>
91 <tr>
92 <td><a href="#PyBabelProject.compileCatalogs">compileCatalogs</a></td>
93 <td>Public method to compile the message catalogs.</td>
94 </tr>
95 <tr>
96 <td><a href="#PyBabelProject.compileSelectedCatalogs">compileSelectedCatalogs</a></td>
97 <td>Public method to update the message catalogs.</td>
98 </tr>
99 <tr>
100 <td><a href="#PyBabelProject.configurePyBabel">configurePyBabel</a></td>
101 <td>Public slot to show a dialog to edit the pybabel configuration.</td>
102 </tr>
103 <tr>
104 <td><a href="#PyBabelProject.determineCapability">determineCapability</a></td>
105 <td>Public method to determine the availability of flask-babel.</td>
106 </tr>
107 <tr>
108 <td><a href="#PyBabelProject.extractMessages">extractMessages</a></td>
109 <td>Public method to extract the messages catalog template file.</td>
110 </tr>
111 <tr>
112 <td><a href="#PyBabelProject.flaskBabelAvailable">flaskBabelAvailable</a></td>
113 <td>Public method to check, if the 'flask-babel' package is available.</td>
114 </tr>
115 <tr>
116 <td><a href="#PyBabelProject.getBabelCommand">getBabelCommand</a></td>
117 <td>Public method to build the Babel command.</td>
118 </tr>
119 <tr>
120 <td><a href="#PyBabelProject.openPOEditor">openPOEditor</a></td>
121 <td>Public method to edit the given file in an external .po editor.</td>
122 </tr>
123 <tr>
124 <td><a href="#PyBabelProject.projectClosedHooks">projectClosedHooks</a></td>
125 <td>Public method to remove our hook methods.</td>
126 </tr>
127 <tr>
128 <td><a href="#PyBabelProject.projectOpenedHooks">projectOpenedHooks</a></td>
129 <td>Public method to add our hook methods.</td>
130 </tr>
131 <tr>
132 <td><a href="#PyBabelProject.registerOpenHook">registerOpenHook</a></td>
133 <td>Public method to register the open hook to open a translations file in a translations editor.</td>
134 </tr>
135 <tr>
136 <td><a href="#PyBabelProject.updateCatalogs">updateCatalogs</a></td>
137 <td>Public method to update the message catalogs.</td>
138 </tr>
139 <tr>
140 <td><a href="#PyBabelProject.updateCatalogsObsolete">updateCatalogsObsolete</a></td>
141 <td>Public method to update the message catalogs keeping obsolete translations.</td>
142 </tr>
143 <tr>
144 <td><a href="#PyBabelProject.updateSelectedCatalogs">updateSelectedCatalogs</a></td>
145 <td>Public method to update the selected message catalogs.</td>
146 </tr>
147 <tr>
148 <td><a href="#PyBabelProject.updateSelectedCatalogsObsolete">updateSelectedCatalogsObsolete</a></td>
149 <td>Public method to update the message catalogs keeping obsolete translations.</td>
150 </tr>
151 </table>
152 <h3>Static Methods</h3>
153
154 <table>
155 <tr><td>None</td></tr>
156 </table>
157
158 <a NAME="PyBabelProject.__init__" ID="PyBabelProject.__init__"></a>
159 <h4>PyBabelProject (Constructor)</h4>
160 <b>PyBabelProject</b>(<i>plugin, project, parent=None</i>)
161
162 <p>
163 Constructor
164 </p>
165 <dl>
166
167 <dt><i>plugin</i> (ProjectFlaskPlugin)</dt>
168 <dd>
169 reference to the plugin object
170 </dd>
171 <dt><i>project</i> (Project)</dt>
172 <dd>
173 reference to the project object
174 </dd>
175 <dt><i>parent</i> (QObject)</dt>
176 <dd>
177 parent
178 </dd>
179 </dl>
180 <a NAME="PyBabelProject.__createBabelCfg" ID="PyBabelProject.__createBabelCfg"></a>
181 <h4>PyBabelProject.__createBabelCfg</h4>
182 <b>__createBabelCfg</b>(<i>configFile</i>)
183
184 <p>
185 Private method to create a template pybabel configuration file.
186 </p>
187 <dl>
188
189 <dt><i>configFile</i> (str)</dt>
190 <dd>
191 name of the configuration file to be created
192 </dd>
193 </dl>
194 <dl>
195 <dt>Returns:</dt>
196 <dd>
197 flag indicating successful configuration file creation
198 </dd>
199 </dl>
200 <dl>
201 <dt>Return Type:</dt>
202 <dd>
203 bool
204 </dd>
205 </dl>
206 <a NAME="PyBabelProject.__ensurePybabelConfigured" ID="PyBabelProject.__ensurePybabelConfigured"></a>
207 <h4>PyBabelProject.__ensurePybabelConfigured</h4>
208 <b>__ensurePybabelConfigured</b>(<i></i>)
209
210 <p>
211 Private method to ensure, that PyBabel has been configured.
212 </p>
213 <dl>
214 <dt>Returns:</dt>
215 <dd>
216 flag indicating successful configuration
217 </dd>
218 </dl>
219 <dl>
220 <dt>Return Type:</dt>
221 <dd>
222 bool
223 </dd>
224 </dl>
225 <a NAME="PyBabelProject.__getLocale" ID="PyBabelProject.__getLocale"></a>
226 <h4>PyBabelProject.__getLocale</h4>
227 <b>__getLocale</b>(<i>filename</i>)
228
229 <p>
230 Private method to extract the locale out of a file name.
231 </p>
232 <dl>
233
234 <dt><i>filename</i> (str)</dt>
235 <dd>
236 name of the file used for extraction
237 </dd>
238 </dl>
239 <dl>
240 <dt>Returns:</dt>
241 <dd>
242 extracted locale
243 </dd>
244 </dl>
245 <dl>
246 <dt>Return Type:</dt>
247 <dd>
248 str or None
249 </dd>
250 </dl>
251 <a NAME="PyBabelProject.__projectLanguageAdded" ID="PyBabelProject.__projectLanguageAdded"></a>
252 <h4>PyBabelProject.__projectLanguageAdded</h4>
253 <b>__projectLanguageAdded</b>(<i>code</i>)
254
255 <p>
256 Private slot handling the addition of a new language.
257 </p>
258 <dl>
259
260 <dt><i>code</i> (str)</dt>
261 <dd>
262 language code of the new language
263 </dd>
264 </dl>
265 <a NAME="PyBabelProject.compileCatalogs" ID="PyBabelProject.compileCatalogs"></a>
266 <h4>PyBabelProject.compileCatalogs</h4>
267 <b>compileCatalogs</b>(<i>filenames</i>)
268
269 <p>
270 Public method to compile the message catalogs.
271 </p>
272 <dl>
273
274 <dt><i>filenames</i> (list of str)</dt>
275 <dd>
276 list of filenames (not used)
277 </dd>
278 </dl>
279 <a NAME="PyBabelProject.compileSelectedCatalogs" ID="PyBabelProject.compileSelectedCatalogs"></a>
280 <h4>PyBabelProject.compileSelectedCatalogs</h4>
281 <b>compileSelectedCatalogs</b>(<i>filenames</i>)
282
283 <p>
284 Public method to update the message catalogs.
285 </p>
286 <dl>
287
288 <dt><i>filenames</i> (list of str)</dt>
289 <dd>
290 list of file names
291 </dd>
292 </dl>
293 <a NAME="PyBabelProject.configurePyBabel" ID="PyBabelProject.configurePyBabel"></a>
294 <h4>PyBabelProject.configurePyBabel</h4>
295 <b>configurePyBabel</b>(<i></i>)
296
297 <p>
298 Public slot to show a dialog to edit the pybabel configuration.
299 </p>
300 <a NAME="PyBabelProject.determineCapability" ID="PyBabelProject.determineCapability"></a>
301 <h4>PyBabelProject.determineCapability</h4>
302 <b>determineCapability</b>(<i></i>)
303
304 <p>
305 Public method to determine the availability of flask-babel.
306 </p>
307 <a NAME="PyBabelProject.extractMessages" ID="PyBabelProject.extractMessages"></a>
308 <h4>PyBabelProject.extractMessages</h4>
309 <b>extractMessages</b>(<i></i>)
310
311 <p>
312 Public method to extract the messages catalog template file.
313 </p>
314 <a NAME="PyBabelProject.flaskBabelAvailable" ID="PyBabelProject.flaskBabelAvailable"></a>
315 <h4>PyBabelProject.flaskBabelAvailable</h4>
316 <b>flaskBabelAvailable</b>(<i></i>)
317
318 <p>
319 Public method to check, if the 'flask-babel' package is available.
320 </p>
321 <dl>
322 <dt>Returns:</dt>
323 <dd>
324 flag indicating the availability of 'flask-babel'
325 </dd>
326 </dl>
327 <dl>
328 <dt>Return Type:</dt>
329 <dd>
330 bool
331 </dd>
332 </dl>
333 <a NAME="PyBabelProject.getBabelCommand" ID="PyBabelProject.getBabelCommand"></a>
334 <h4>PyBabelProject.getBabelCommand</h4>
335 <b>getBabelCommand</b>(<i></i>)
336
337 <p>
338 Public method to build the Babel command.
339 </p>
340 <dl>
341 <dt>Returns:</dt>
342 <dd>
343 full pybabel command
344 </dd>
345 </dl>
346 <dl>
347 <dt>Return Type:</dt>
348 <dd>
349 str
350 </dd>
351 </dl>
352 <a NAME="PyBabelProject.openPOEditor" ID="PyBabelProject.openPOEditor"></a>
353 <h4>PyBabelProject.openPOEditor</h4>
354 <b>openPOEditor</b>(<i>poFile</i>)
355
356 <p>
357 Public method to edit the given file in an external .po editor.
358 </p>
359 <dl>
360
361 <dt><i>poFile</i> (str)</dt>
362 <dd>
363 name of the .po file
364 </dd>
365 </dl>
366 <a NAME="PyBabelProject.projectClosedHooks" ID="PyBabelProject.projectClosedHooks"></a>
367 <h4>PyBabelProject.projectClosedHooks</h4>
368 <b>projectClosedHooks</b>(<i></i>)
369
370 <p>
371 Public method to remove our hook methods.
372 </p>
373 <a NAME="PyBabelProject.projectOpenedHooks" ID="PyBabelProject.projectOpenedHooks"></a>
374 <h4>PyBabelProject.projectOpenedHooks</h4>
375 <b>projectOpenedHooks</b>(<i></i>)
376
377 <p>
378 Public method to add our hook methods.
379 </p>
380 <a NAME="PyBabelProject.registerOpenHook" ID="PyBabelProject.registerOpenHook"></a>
381 <h4>PyBabelProject.registerOpenHook</h4>
382 <b>registerOpenHook</b>(<i></i>)
383
384 <p>
385 Public method to register the open hook to open a translations file
386 in a translations editor.
387 </p>
388 <a NAME="PyBabelProject.updateCatalogs" ID="PyBabelProject.updateCatalogs"></a>
389 <h4>PyBabelProject.updateCatalogs</h4>
390 <b>updateCatalogs</b>(<i>filenames, withObsolete=False</i>)
391
392 <p>
393 Public method to update the message catalogs.
394 </p>
395 <dl>
396
397 <dt><i>filenames</i> (list of str)</dt>
398 <dd>
399 list of filenames (not used)
400 </dd>
401 <dt><i>withObsolete</i> (bool)</dt>
402 <dd>
403 flag indicating to keep obsolete translations
404 </dd>
405 </dl>
406 <a NAME="PyBabelProject.updateCatalogsObsolete" ID="PyBabelProject.updateCatalogsObsolete"></a>
407 <h4>PyBabelProject.updateCatalogsObsolete</h4>
408 <b>updateCatalogsObsolete</b>(<i>filenames</i>)
409
410 <p>
411 Public method to update the message catalogs keeping obsolete
412 translations.
413 </p>
414 <dl>
415
416 <dt><i>filenames</i> (list of str)</dt>
417 <dd>
418 list of filenames (not used)
419 </dd>
420 </dl>
421 <a NAME="PyBabelProject.updateSelectedCatalogs" ID="PyBabelProject.updateSelectedCatalogs"></a>
422 <h4>PyBabelProject.updateSelectedCatalogs</h4>
423 <b>updateSelectedCatalogs</b>(<i>filenames, withObsolete=False</i>)
424
425 <p>
426 Public method to update the selected message catalogs.
427 </p>
428 <dl>
429
430 <dt><i>filenames</i> (list of str)</dt>
431 <dd>
432 list of filenames
433 </dd>
434 <dt><i>withObsolete</i> (bool)</dt>
435 <dd>
436 flag indicating to keep obsolete translations
437 </dd>
438 </dl>
439 <a NAME="PyBabelProject.updateSelectedCatalogsObsolete" ID="PyBabelProject.updateSelectedCatalogsObsolete"></a>
440 <h4>PyBabelProject.updateSelectedCatalogsObsolete</h4>
441 <b>updateSelectedCatalogsObsolete</b>(<i>filenames</i>)
442
443 <p>
444 Public method to update the message catalogs keeping obsolete
445 translations.
446 </p>
447 <dl>
448
449 <dt><i>filenames</i> (list of str)</dt>
450 <dd>
451 list of filenames (not used)
452 </dd>
453 </dl>
454 <div align="right"><a href="#top">Up</a></div>
455 <hr />
456 </body></html>

Mercurial Repository: Flask Project

eric ide

mercurial