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

Sun, 22 Nov 2020 14:12:44 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 22 Nov 2020 14:12:44 +0100
changeset 19
f8e3c1676f9b
child 37
1bd8d19a3aa7
permissions
-rw-r--r--

Added source code documentation.

<!DOCTYPE html>
<html><head>
<title>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog</h1>

<p>
Module implementing a dialog to edit the PyBabel configuration.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#PyBabelConfigDialog">PyBabelConfigDialog</a></td>
<td>Class implementing a dialog to edit the PyBabel configuration.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="PyBabelConfigDialog" ID="PyBabelConfigDialog"></a>
<h2>PyBabelConfigDialog</h2>

<p>
    Class implementing a dialog to edit the PyBabel configuration.
</p>
<h3>Derived from</h3>
QDialog, Ui_PyBabelConfigDialog
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#PyBabelConfigDialog.__init__">PyBabelConfigDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PyBabelConfigDialog.__updateCatalogPicker">__updateCatalogPicker</a></td>
<td>Private method to update the contents of the catalog picker.</td>
</tr>
<tr>
<td><a href="#PyBabelConfigDialog.__updateOK">__updateOK</a></td>
<td>Private method to update the status of the OK button.</td>
</tr>
<tr>
<td><a href="#PyBabelConfigDialog.getConfiguration">getConfiguration</a></td>
<td>Public method to get the entered configuration data.</td>
</tr>
<tr>
<td><a href="#PyBabelConfigDialog.on_configFilePicker_textChanged">on_configFilePicker_textChanged</a></td>
<td>Private slot to handle a change of the configuration file name.</td>
</tr>
<tr>
<td><a href="#PyBabelConfigDialog.on_domainEdit_textChanged">on_domainEdit_textChanged</a></td>
<td>Private slot to handle a change of the translations domain.</td>
</tr>
<tr>
<td><a href="#PyBabelConfigDialog.on_translationsDirectoryPicker_textChanged">on_translationsDirectoryPicker_textChanged</a></td>
<td>Private slot to handle a change of the catalog file name.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="PyBabelConfigDialog.__init__" ID="PyBabelConfigDialog.__init__"></a>
<h4>PyBabelConfigDialog (Constructor)</h4>
<b>PyBabelConfigDialog</b>(<i>configuration, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>configuration</i> (dict)</dt>
<dd>
current pybabel configuration
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="PyBabelConfigDialog.__updateCatalogPicker" ID="PyBabelConfigDialog.__updateCatalogPicker"></a>
<h4>PyBabelConfigDialog.__updateCatalogPicker</h4>
<b>__updateCatalogPicker</b>(<i></i>)

<p>
        Private method to update the contents of the catalog picker.
</p>
<a NAME="PyBabelConfigDialog.__updateOK" ID="PyBabelConfigDialog.__updateOK"></a>
<h4>PyBabelConfigDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)

<p>
        Private method to update the status of the OK button.
</p>
<a NAME="PyBabelConfigDialog.getConfiguration" ID="PyBabelConfigDialog.getConfiguration"></a>
<h4>PyBabelConfigDialog.getConfiguration</h4>
<b>getConfiguration</b>(<i></i>)

<p>
        Public method to get the entered configuration data.
</p>
<dl>
<dt>Returns:</dt>
<dd>
pybabel configuration
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="PyBabelConfigDialog.on_configFilePicker_textChanged" ID="PyBabelConfigDialog.on_configFilePicker_textChanged"></a>
<h4>PyBabelConfigDialog.on_configFilePicker_textChanged</h4>
<b>on_configFilePicker_textChanged</b>(<i>txt</i>)

<p>
        Private slot to handle a change of the configuration file name.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
configuration file name
</dd>
</dl>
<a NAME="PyBabelConfigDialog.on_domainEdit_textChanged" ID="PyBabelConfigDialog.on_domainEdit_textChanged"></a>
<h4>PyBabelConfigDialog.on_domainEdit_textChanged</h4>
<b>on_domainEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot to handle a change of the translations domain.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
entered translations domain
</dd>
</dl>
<a NAME="PyBabelConfigDialog.on_translationsDirectoryPicker_textChanged" ID="PyBabelConfigDialog.on_translationsDirectoryPicker_textChanged"></a>
<h4>PyBabelConfigDialog.on_translationsDirectoryPicker_textChanged</h4>
<b>on_translationsDirectoryPicker_textChanged</b>(<i>txt</i>)

<p>
        Private slot to handle a change of the catalog file name.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
configuration file name
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial