diff -r 548dea93941c -r 1bd8d19a3aa7 ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html --- a/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html Sun Nov 29 16:04:25 2020 +0100 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html Sun Nov 29 16:05:10 2020 +0100 @@ -36,7 +36,7 @@ <tr> <td><a href="#PyBabelProject">PyBabelProject</a></td> -<td>Class implementing the Flask project support.</td> +<td>Class implementing the flask-babel project support.</td> </tr> </table> <h3>Functions</h3> @@ -50,7 +50,7 @@ <h2>PyBabelProject</h2> <p> - Class implementing the Flask project support. + Class implementing the flask-babel project support. </p> <h3>Derived from</h3> QObject @@ -73,6 +73,14 @@ <td>Constructor</td> </tr> <tr> +<td><a href="#PyBabelProject.__checkAvailability">__checkAvailability</a></td> +<td>Private slot to check the availability of the 'flask-babel' extension.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.__configurePyBabel">__configurePyBabel</a></td> +<td>Private slot to show a dialog to edit the pybabel configuration.</td> +</tr> +<tr> <td><a href="#PyBabelProject.__createBabelCfg">__createBabelCfg</a></td> <td>Private method to create a template pybabel configuration file.</td> </tr> @@ -81,10 +89,18 @@ <td>Private method to ensure, that PyBabel has been configured.</td> </tr> <tr> +<td><a href="#PyBabelProject.__flaskBabelAvailable">__flaskBabelAvailable</a></td> +<td>Private method to check, if the 'flask-babel' package is available.</td> +</tr> +<tr> <td><a href="#PyBabelProject.__getLocale">__getLocale</a></td> <td>Private method to extract the locale out of a file name.</td> </tr> <tr> +<td><a href="#PyBabelProject.__installFlaskBabel">__installFlaskBabel</a></td> +<td>Private slot to install the flask-babel extension into the configured environment.</td> +</tr> +<tr> <td><a href="#PyBabelProject.__projectLanguageAdded">__projectLanguageAdded</a></td> <td>Private slot handling the addition of a new language.</td> </tr> @@ -97,10 +113,6 @@ <td>Public method to update the message catalogs.</td> </tr> <tr> -<td><a href="#PyBabelProject.configurePyBabel">configurePyBabel</a></td> -<td>Public slot to show a dialog to edit the pybabel configuration.</td> -</tr> -<tr> <td><a href="#PyBabelProject.determineCapability">determineCapability</a></td> <td>Public method to determine the availability of flask-babel.</td> </tr> @@ -109,12 +121,16 @@ <td>Public method to extract the messages catalog template file.</td> </tr> <tr> -<td><a href="#PyBabelProject.flaskBabelAvailable">flaskBabelAvailable</a></td> -<td>Public method to check, if the 'flask-babel' package is available.</td> +<td><a href="#PyBabelProject.getBabelCommand">getBabelCommand</a></td> +<td>Public method to build the Babel command.</td> </tr> <tr> -<td><a href="#PyBabelProject.getBabelCommand">getBabelCommand</a></td> -<td>Public method to build the Babel command.</td> +<td><a href="#PyBabelProject.initActions">initActions</a></td> +<td>Public method to define the flask-babel actions.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.initMenu">initMenu</a></td> +<td>Public method to initialize the flask-babel menu.</td> </tr> <tr> <td><a href="#PyBabelProject.openPOEditor">openPOEditor</a></td> @@ -177,6 +193,20 @@ parent </dd> </dl> +<a NAME="PyBabelProject.__checkAvailability" ID="PyBabelProject.__checkAvailability"></a> +<h4>PyBabelProject.__checkAvailability</h4> +<b>__checkAvailability</b>(<i></i>) + +<p> + Private slot to check the availability of the 'flask-babel' extension. +</p> +<a NAME="PyBabelProject.__configurePyBabel" ID="PyBabelProject.__configurePyBabel"></a> +<h4>PyBabelProject.__configurePyBabel</h4> +<b>__configurePyBabel</b>(<i></i>) + +<p> + Private slot to show a dialog to edit the pybabel configuration. +</p> <a NAME="PyBabelProject.__createBabelCfg" ID="PyBabelProject.__createBabelCfg"></a> <h4>PyBabelProject.__createBabelCfg</h4> <b>__createBabelCfg</b>(<i>configFile</i>) @@ -222,6 +252,25 @@ bool </dd> </dl> +<a NAME="PyBabelProject.__flaskBabelAvailable" ID="PyBabelProject.__flaskBabelAvailable"></a> +<h4>PyBabelProject.__flaskBabelAvailable</h4> +<b>__flaskBabelAvailable</b>(<i></i>) + +<p> + Private method to check, if the 'flask-babel' package is available. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the availability of 'flask-babel' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="PyBabelProject.__getLocale" ID="PyBabelProject.__getLocale"></a> <h4>PyBabelProject.__getLocale</h4> <b>__getLocale</b>(<i>filename</i>) @@ -248,6 +297,14 @@ str or None </dd> </dl> +<a NAME="PyBabelProject.__installFlaskBabel" ID="PyBabelProject.__installFlaskBabel"></a> +<h4>PyBabelProject.__installFlaskBabel</h4> +<b>__installFlaskBabel</b>(<i></i>) + +<p> + Private slot to install the flask-babel extension into the configured + environment. +</p> <a NAME="PyBabelProject.__projectLanguageAdded" ID="PyBabelProject.__projectLanguageAdded"></a> <h4>PyBabelProject.__projectLanguageAdded</h4> <b>__projectLanguageAdded</b>(<i>code</i>) @@ -290,13 +347,6 @@ list of file names </dd> </dl> -<a NAME="PyBabelProject.configurePyBabel" ID="PyBabelProject.configurePyBabel"></a> -<h4>PyBabelProject.configurePyBabel</h4> -<b>configurePyBabel</b>(<i></i>) - -<p> - Public slot to show a dialog to edit the pybabel configuration. -</p> <a NAME="PyBabelProject.determineCapability" ID="PyBabelProject.determineCapability"></a> <h4>PyBabelProject.determineCapability</h4> <b>determineCapability</b>(<i></i>) @@ -311,25 +361,6 @@ <p> Public method to extract the messages catalog template file. </p> -<a NAME="PyBabelProject.flaskBabelAvailable" ID="PyBabelProject.flaskBabelAvailable"></a> -<h4>PyBabelProject.flaskBabelAvailable</h4> -<b>flaskBabelAvailable</b>(<i></i>) - -<p> - Public method to check, if the 'flask-babel' package is available. -</p> -<dl> -<dt>Returns:</dt> -<dd> -flag indicating the availability of 'flask-babel' -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> <a NAME="PyBabelProject.getBabelCommand" ID="PyBabelProject.getBabelCommand"></a> <h4>PyBabelProject.getBabelCommand</h4> <b>getBabelCommand</b>(<i></i>) @@ -349,6 +380,32 @@ str </dd> </dl> +<a NAME="PyBabelProject.initActions" ID="PyBabelProject.initActions"></a> +<h4>PyBabelProject.initActions</h4> +<b>initActions</b>(<i></i>) + +<p> + Public method to define the flask-babel actions. +</p> +<a NAME="PyBabelProject.initMenu" ID="PyBabelProject.initMenu"></a> +<h4>PyBabelProject.initMenu</h4> +<b>initMenu</b>(<i></i>) + +<p> + Public method to initialize the flask-babel menu. +</p> +<dl> +<dt>Returns:</dt> +<dd> +the menu generated +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu +</dd> +</dl> <a NAME="PyBabelProject.openPOEditor" ID="PyBabelProject.openPOEditor"></a> <h4>PyBabelProject.openPOEditor</h4> <b>openPOEditor</b>(<i>poFile</i>)