ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog.html

changeset 161
208fced62e00
parent 83
b09e6a328c3d
child 169
b8f263e05c39
--- a/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog.html	Sat May 23 11:14:54 2020 +0200
+++ b/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog.html	Mon Jun 22 19:32:12 2020 +0200
@@ -18,173 +18,226 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog</h1>
+
 <p>
 Module implementing a dialog to enter the options for a check operation.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
+
 <tr>
 <td><a href="#DjangoCheckOptionsDialog">DjangoCheckOptionsDialog</a></td>
 <td>Class implementing a dialog to enter the options for a check operation.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="DjangoCheckOptionsDialog" ID="DjangoCheckOptionsDialog"></a>
 <h2>DjangoCheckOptionsDialog</h2>
+
 <p>
     Class implementing a dialog to enter the options for a check operation.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_DjangoCheckOptionsDialog
 <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="#DjangoCheckOptionsDialog.__init__">DjangoCheckOptionsDialog</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#DjangoCheckOptionsDialog.__moduleToPath">__moduleToPath</a></td>
 <td>Private method to convert a module name to an file path.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#DjangoCheckOptionsDialog.__pathToModule">__pathToModule</a></td>
 <td>Private method to convert a file path including a .py extension to a module name.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#DjangoCheckOptionsDialog.__populateTagsList">__populateTagsList</a></td>
 <td>Private slot to populate the tags list.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#DjangoCheckOptionsDialog.getData">getData</a></td>
 <td>Public method to get the options for the check operation.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#DjangoCheckOptionsDialog.on_deployCheckBox_toggled">on_deployCheckBox_toggled</a></td>
 <td>Private slot handling a change of the deploy check box.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#DjangoCheckOptionsDialog.on_settingsFileButton_clicked">on_settingsFileButton_clicked</a></td>
 <td>Private slot to select a settings file via a file selection dialog.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="DjangoCheckOptionsDialog.__init__" ID="DjangoCheckOptionsDialog.__init__"></a>
 <h4>DjangoCheckOptionsDialog (Constructor)</h4>
 <b>DjangoCheckOptionsDialog</b>(<i>python, path, apps, deployMode, parent=None</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>python</i> (str)</dt>
 <dd>
 path of the Python executable
-</dd><dt><i>path</i> (str)</dt>
+</dd>
+<dt><i>path</i> (str)</dt>
 <dd>
 site path to run the manage.py script with
-</dd><dt><i>apps</i> (list of str)</dt>
+</dd>
+<dt><i>apps</i> (list of str)</dt>
 <dd>
 list of recently used application strings
-</dd><dt><i>deployMode</i> (bool)</dt>
+</dd>
+<dt><i>deployMode</i> (bool)</dt>
 <dd>
 flag indicating to activate the deployment mode
-</dd><dt><i>parent</i> (QWidget)</dt>
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
 reference to the parent widget
 </dd>
-</dl><a NAME="DjangoCheckOptionsDialog.__moduleToPath" ID="DjangoCheckOptionsDialog.__moduleToPath"></a>
+</dl>
+<a NAME="DjangoCheckOptionsDialog.__moduleToPath" ID="DjangoCheckOptionsDialog.__moduleToPath"></a>
 <h4>DjangoCheckOptionsDialog.__moduleToPath</h4>
 <b>__moduleToPath</b>(<i>moduleName</i>)
+
 <p>
         Private method to convert a module name to an file path.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>moduleName</i> (str)</dt>
 <dd>
 module name to be converted
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 file path
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 str
 </dd>
-</dl><a NAME="DjangoCheckOptionsDialog.__pathToModule" ID="DjangoCheckOptionsDialog.__pathToModule"></a>
+</dl>
+<a NAME="DjangoCheckOptionsDialog.__pathToModule" ID="DjangoCheckOptionsDialog.__pathToModule"></a>
 <h4>DjangoCheckOptionsDialog.__pathToModule</h4>
 <b>__pathToModule</b>(<i>path</i>)
+
 <p>
         Private method to convert a file path including a .py extension to a
         module name.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>path</i> (str)</dt>
 <dd>
 file path to be converted
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 module name
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 str
 </dd>
-</dl><a NAME="DjangoCheckOptionsDialog.__populateTagsList" ID="DjangoCheckOptionsDialog.__populateTagsList"></a>
+</dl>
+<a NAME="DjangoCheckOptionsDialog.__populateTagsList" ID="DjangoCheckOptionsDialog.__populateTagsList"></a>
 <h4>DjangoCheckOptionsDialog.__populateTagsList</h4>
 <b>__populateTagsList</b>(<i>deployMode</i>)
+
 <p>
         Private slot to populate the tags list.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>deployMode</i> (bool)</dt>
 <dd>
 flag indicating the deployment mode
 </dd>
-</dl><a NAME="DjangoCheckOptionsDialog.getData" ID="DjangoCheckOptionsDialog.getData"></a>
+</dl>
+<a NAME="DjangoCheckOptionsDialog.getData" ID="DjangoCheckOptionsDialog.getData"></a>
 <h4>DjangoCheckOptionsDialog.getData</h4>
 <b>getData</b>(<i></i>)
+
 <p>
         Public method to get the options for the check operation.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 tuple containing the deployment flag, list of selected tags,
             applications string and the settings file
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 tuple of bool, list of str, str and str
 </dd>
-</dl><a NAME="DjangoCheckOptionsDialog.on_deployCheckBox_toggled" ID="DjangoCheckOptionsDialog.on_deployCheckBox_toggled"></a>
+</dl>
+<a NAME="DjangoCheckOptionsDialog.on_deployCheckBox_toggled" ID="DjangoCheckOptionsDialog.on_deployCheckBox_toggled"></a>
 <h4>DjangoCheckOptionsDialog.on_deployCheckBox_toggled</h4>
 <b>on_deployCheckBox_toggled</b>(<i>checked</i>)
+
 <p>
         Private slot handling a change of the deploy check box.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>checked</i> (bool)</dt>
 <dd>
 state of the check box
 </dd>
-</dl><a NAME="DjangoCheckOptionsDialog.on_settingsFileButton_clicked" ID="DjangoCheckOptionsDialog.on_settingsFileButton_clicked"></a>
+</dl>
+<a NAME="DjangoCheckOptionsDialog.on_settingsFileButton_clicked" ID="DjangoCheckOptionsDialog.on_settingsFileButton_clicked"></a>
 <h4>DjangoCheckOptionsDialog.on_settingsFileButton_clicked</h4>
 <b>on_settingsFileButton_clicked</b>(<i></i>)
+
 <p>
         Private slot to select a settings file via a file selection dialog.
 </p>

eric ide

mercurial