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 37
1bd8d19a3aa7
parent 19
f8e3c1676f9b
child 61
fe1e8783a95f
equal deleted inserted replaced
36:548dea93941c 37:1bd8d19a3aa7
34 34
35 <table> 35 <table>
36 36
37 <tr> 37 <tr>
38 <td><a href="#PyBabelProject">PyBabelProject</a></td> 38 <td><a href="#PyBabelProject">PyBabelProject</a></td>
39 <td>Class implementing the Flask project support.</td> 39 <td>Class implementing the flask-babel project support.</td>
40 </tr> 40 </tr>
41 </table> 41 </table>
42 <h3>Functions</h3> 42 <h3>Functions</h3>
43 43
44 <table> 44 <table>
48 <hr /> 48 <hr />
49 <a NAME="PyBabelProject" ID="PyBabelProject"></a> 49 <a NAME="PyBabelProject" ID="PyBabelProject"></a>
50 <h2>PyBabelProject</h2> 50 <h2>PyBabelProject</h2>
51 51
52 <p> 52 <p>
53 Class implementing the Flask project support. 53 Class implementing the flask-babel project support.
54 </p> 54 </p>
55 <h3>Derived from</h3> 55 <h3>Derived from</h3>
56 QObject 56 QObject
57 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58 58
71 <tr> 71 <tr>
72 <td><a href="#PyBabelProject.__init__">PyBabelProject</a></td> 72 <td><a href="#PyBabelProject.__init__">PyBabelProject</a></td>
73 <td>Constructor</td> 73 <td>Constructor</td>
74 </tr> 74 </tr>
75 <tr> 75 <tr>
76 <td><a href="#PyBabelProject.__checkAvailability">__checkAvailability</a></td>
77 <td>Private slot to check the availability of the 'flask-babel' extension.</td>
78 </tr>
79 <tr>
80 <td><a href="#PyBabelProject.__configurePyBabel">__configurePyBabel</a></td>
81 <td>Private slot to show a dialog to edit the pybabel configuration.</td>
82 </tr>
83 <tr>
76 <td><a href="#PyBabelProject.__createBabelCfg">__createBabelCfg</a></td> 84 <td><a href="#PyBabelProject.__createBabelCfg">__createBabelCfg</a></td>
77 <td>Private method to create a template pybabel configuration file.</td> 85 <td>Private method to create a template pybabel configuration file.</td>
78 </tr> 86 </tr>
79 <tr> 87 <tr>
80 <td><a href="#PyBabelProject.__ensurePybabelConfigured">__ensurePybabelConfigured</a></td> 88 <td><a href="#PyBabelProject.__ensurePybabelConfigured">__ensurePybabelConfigured</a></td>
81 <td>Private method to ensure, that PyBabel has been configured.</td> 89 <td>Private method to ensure, that PyBabel has been configured.</td>
82 </tr> 90 </tr>
83 <tr> 91 <tr>
92 <td><a href="#PyBabelProject.__flaskBabelAvailable">__flaskBabelAvailable</a></td>
93 <td>Private method to check, if the 'flask-babel' package is available.</td>
94 </tr>
95 <tr>
84 <td><a href="#PyBabelProject.__getLocale">__getLocale</a></td> 96 <td><a href="#PyBabelProject.__getLocale">__getLocale</a></td>
85 <td>Private method to extract the locale out of a file name.</td> 97 <td>Private method to extract the locale out of a file name.</td>
86 </tr> 98 </tr>
87 <tr> 99 <tr>
100 <td><a href="#PyBabelProject.__installFlaskBabel">__installFlaskBabel</a></td>
101 <td>Private slot to install the flask-babel extension into the configured environment.</td>
102 </tr>
103 <tr>
88 <td><a href="#PyBabelProject.__projectLanguageAdded">__projectLanguageAdded</a></td> 104 <td><a href="#PyBabelProject.__projectLanguageAdded">__projectLanguageAdded</a></td>
89 <td>Private slot handling the addition of a new language.</td> 105 <td>Private slot handling the addition of a new language.</td>
90 </tr> 106 </tr>
91 <tr> 107 <tr>
92 <td><a href="#PyBabelProject.compileCatalogs">compileCatalogs</a></td> 108 <td><a href="#PyBabelProject.compileCatalogs">compileCatalogs</a></td>
95 <tr> 111 <tr>
96 <td><a href="#PyBabelProject.compileSelectedCatalogs">compileSelectedCatalogs</a></td> 112 <td><a href="#PyBabelProject.compileSelectedCatalogs">compileSelectedCatalogs</a></td>
97 <td>Public method to update the message catalogs.</td> 113 <td>Public method to update the message catalogs.</td>
98 </tr> 114 </tr>
99 <tr> 115 <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> 116 <td><a href="#PyBabelProject.determineCapability">determineCapability</a></td>
105 <td>Public method to determine the availability of flask-babel.</td> 117 <td>Public method to determine the availability of flask-babel.</td>
106 </tr> 118 </tr>
107 <tr> 119 <tr>
108 <td><a href="#PyBabelProject.extractMessages">extractMessages</a></td> 120 <td><a href="#PyBabelProject.extractMessages">extractMessages</a></td>
109 <td>Public method to extract the messages catalog template file.</td> 121 <td>Public method to extract the messages catalog template file.</td>
110 </tr> 122 </tr>
111 <tr> 123 <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> 124 <td><a href="#PyBabelProject.getBabelCommand">getBabelCommand</a></td>
117 <td>Public method to build the Babel command.</td> 125 <td>Public method to build the Babel command.</td>
126 </tr>
127 <tr>
128 <td><a href="#PyBabelProject.initActions">initActions</a></td>
129 <td>Public method to define the flask-babel actions.</td>
130 </tr>
131 <tr>
132 <td><a href="#PyBabelProject.initMenu">initMenu</a></td>
133 <td>Public method to initialize the flask-babel menu.</td>
118 </tr> 134 </tr>
119 <tr> 135 <tr>
120 <td><a href="#PyBabelProject.openPOEditor">openPOEditor</a></td> 136 <td><a href="#PyBabelProject.openPOEditor">openPOEditor</a></td>
121 <td>Public method to edit the given file in an external .po editor.</td> 137 <td>Public method to edit the given file in an external .po editor.</td>
122 </tr> 138 </tr>
175 <dt><i>parent</i> (QObject)</dt> 191 <dt><i>parent</i> (QObject)</dt>
176 <dd> 192 <dd>
177 parent 193 parent
178 </dd> 194 </dd>
179 </dl> 195 </dl>
196 <a NAME="PyBabelProject.__checkAvailability" ID="PyBabelProject.__checkAvailability"></a>
197 <h4>PyBabelProject.__checkAvailability</h4>
198 <b>__checkAvailability</b>(<i></i>)
199
200 <p>
201 Private slot to check the availability of the 'flask-babel' extension.
202 </p>
203 <a NAME="PyBabelProject.__configurePyBabel" ID="PyBabelProject.__configurePyBabel"></a>
204 <h4>PyBabelProject.__configurePyBabel</h4>
205 <b>__configurePyBabel</b>(<i></i>)
206
207 <p>
208 Private slot to show a dialog to edit the pybabel configuration.
209 </p>
180 <a NAME="PyBabelProject.__createBabelCfg" ID="PyBabelProject.__createBabelCfg"></a> 210 <a NAME="PyBabelProject.__createBabelCfg" ID="PyBabelProject.__createBabelCfg"></a>
181 <h4>PyBabelProject.__createBabelCfg</h4> 211 <h4>PyBabelProject.__createBabelCfg</h4>
182 <b>__createBabelCfg</b>(<i>configFile</i>) 212 <b>__createBabelCfg</b>(<i>configFile</i>)
183 213
184 <p> 214 <p>
220 <dt>Return Type:</dt> 250 <dt>Return Type:</dt>
221 <dd> 251 <dd>
222 bool 252 bool
223 </dd> 253 </dd>
224 </dl> 254 </dl>
255 <a NAME="PyBabelProject.__flaskBabelAvailable" ID="PyBabelProject.__flaskBabelAvailable"></a>
256 <h4>PyBabelProject.__flaskBabelAvailable</h4>
257 <b>__flaskBabelAvailable</b>(<i></i>)
258
259 <p>
260 Private method to check, if the 'flask-babel' package is available.
261 </p>
262 <dl>
263 <dt>Returns:</dt>
264 <dd>
265 flag indicating the availability of 'flask-babel'
266 </dd>
267 </dl>
268 <dl>
269 <dt>Return Type:</dt>
270 <dd>
271 bool
272 </dd>
273 </dl>
225 <a NAME="PyBabelProject.__getLocale" ID="PyBabelProject.__getLocale"></a> 274 <a NAME="PyBabelProject.__getLocale" ID="PyBabelProject.__getLocale"></a>
226 <h4>PyBabelProject.__getLocale</h4> 275 <h4>PyBabelProject.__getLocale</h4>
227 <b>__getLocale</b>(<i>filename</i>) 276 <b>__getLocale</b>(<i>filename</i>)
228 277
229 <p> 278 <p>
246 <dt>Return Type:</dt> 295 <dt>Return Type:</dt>
247 <dd> 296 <dd>
248 str or None 297 str or None
249 </dd> 298 </dd>
250 </dl> 299 </dl>
300 <a NAME="PyBabelProject.__installFlaskBabel" ID="PyBabelProject.__installFlaskBabel"></a>
301 <h4>PyBabelProject.__installFlaskBabel</h4>
302 <b>__installFlaskBabel</b>(<i></i>)
303
304 <p>
305 Private slot to install the flask-babel extension into the configured
306 environment.
307 </p>
251 <a NAME="PyBabelProject.__projectLanguageAdded" ID="PyBabelProject.__projectLanguageAdded"></a> 308 <a NAME="PyBabelProject.__projectLanguageAdded" ID="PyBabelProject.__projectLanguageAdded"></a>
252 <h4>PyBabelProject.__projectLanguageAdded</h4> 309 <h4>PyBabelProject.__projectLanguageAdded</h4>
253 <b>__projectLanguageAdded</b>(<i>code</i>) 310 <b>__projectLanguageAdded</b>(<i>code</i>)
254 311
255 <p> 312 <p>
288 <dt><i>filenames</i> (list of str)</dt> 345 <dt><i>filenames</i> (list of str)</dt>
289 <dd> 346 <dd>
290 list of file names 347 list of file names
291 </dd> 348 </dd>
292 </dl> 349 </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> 350 <a NAME="PyBabelProject.determineCapability" ID="PyBabelProject.determineCapability"></a>
301 <h4>PyBabelProject.determineCapability</h4> 351 <h4>PyBabelProject.determineCapability</h4>
302 <b>determineCapability</b>(<i></i>) 352 <b>determineCapability</b>(<i></i>)
303 353
304 <p> 354 <p>
309 <b>extractMessages</b>(<i></i>) 359 <b>extractMessages</b>(<i></i>)
310 360
311 <p> 361 <p>
312 Public method to extract the messages catalog template file. 362 Public method to extract the messages catalog template file.
313 </p> 363 </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> 364 <a NAME="PyBabelProject.getBabelCommand" ID="PyBabelProject.getBabelCommand"></a>
334 <h4>PyBabelProject.getBabelCommand</h4> 365 <h4>PyBabelProject.getBabelCommand</h4>
335 <b>getBabelCommand</b>(<i></i>) 366 <b>getBabelCommand</b>(<i></i>)
336 367
337 <p> 368 <p>
347 <dt>Return Type:</dt> 378 <dt>Return Type:</dt>
348 <dd> 379 <dd>
349 str 380 str
350 </dd> 381 </dd>
351 </dl> 382 </dl>
383 <a NAME="PyBabelProject.initActions" ID="PyBabelProject.initActions"></a>
384 <h4>PyBabelProject.initActions</h4>
385 <b>initActions</b>(<i></i>)
386
387 <p>
388 Public method to define the flask-babel actions.
389 </p>
390 <a NAME="PyBabelProject.initMenu" ID="PyBabelProject.initMenu"></a>
391 <h4>PyBabelProject.initMenu</h4>
392 <b>initMenu</b>(<i></i>)
393
394 <p>
395 Public method to initialize the flask-babel menu.
396 </p>
397 <dl>
398 <dt>Returns:</dt>
399 <dd>
400 the menu generated
401 </dd>
402 </dl>
403 <dl>
404 <dt>Return Type:</dt>
405 <dd>
406 QMenu
407 </dd>
408 </dl>
352 <a NAME="PyBabelProject.openPOEditor" ID="PyBabelProject.openPOEditor"></a> 409 <a NAME="PyBabelProject.openPOEditor" ID="PyBabelProject.openPOEditor"></a>
353 <h4>PyBabelProject.openPOEditor</h4> 410 <h4>PyBabelProject.openPOEditor</h4>
354 <b>openPOEditor</b>(<i>poFile</i>) 411 <b>openPOEditor</b>(<i>poFile</i>)
355 412
356 <p> 413 <p>

Mercurial Repository: Flask Project

eric ide

mercurial