diff -r e2084f0a28a2 -r 208fced62e00 ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoMigrationSelectionDialog.html --- a/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoMigrationSelectionDialog.html Sat May 23 11:14:54 2020 +0200 +++ b/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoMigrationSelectionDialog.html Mon Jun 22 19:32:12 2020 +0200 @@ -18,97 +18,130 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Django.ProjectDjango.DjangoMigrationSelectionDialog</h1> + <p> Module implementing a dialog to select an application and migration. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#DjangoMigrationSelectionDialog">DjangoMigrationSelectionDialog</a></td> <td>Class implementing a dialog to select an application and migration.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="DjangoMigrationSelectionDialog" ID="DjangoMigrationSelectionDialog"></a> <h2>DjangoMigrationSelectionDialog</h2> + <p> Class implementing a dialog to select an application and migration. </p> <h3>Derived from</h3> QDialog, Ui_DjangoMigrationSelectionDialog <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="#DjangoMigrationSelectionDialog.__init__">DjangoMigrationSelectionDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#DjangoMigrationSelectionDialog.getData">getData</a></td> <td>Public method to get the selected data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DjangoMigrationSelectionDialog.on_applicationComboBox_activated">on_applicationComboBox_activated</a></td> <td>Private slot to update the migrations combo box.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="DjangoMigrationSelectionDialog.__init__" ID="DjangoMigrationSelectionDialog.__init__"></a> <h4>DjangoMigrationSelectionDialog (Constructor)</h4> -<b>DjangoMigrationSelectionDialog</b>(<i>migrations, migrationRequired=False, parent=None</i>) +<b>DjangoMigrationSelectionDialog</b>(<i>migrations, migrationRequired=False, suffix="", parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>migrations</i> (dict)</dt> <dd> dictionary containing the available migrations -</dd><dt><i>migrationRequired</i> (bool)</dt> +</dd> +<dt><i>migrationRequired</i> (bool)</dt> <dd> flag indicating that a migration must be selected -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>suffix</i> (str)</dt> +<dd> +icon suffix +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="DjangoMigrationSelectionDialog.getData" ID="DjangoMigrationSelectionDialog.getData"></a> +</dl> +<a NAME="DjangoMigrationSelectionDialog.getData" ID="DjangoMigrationSelectionDialog.getData"></a> <h4>DjangoMigrationSelectionDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to get the selected data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple containing the selected application name and migration </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of two str </dd> -</dl><a NAME="DjangoMigrationSelectionDialog.on_applicationComboBox_activated" ID="DjangoMigrationSelectionDialog.on_applicationComboBox_activated"></a> +</dl> +<a NAME="DjangoMigrationSelectionDialog.on_applicationComboBox_activated" ID="DjangoMigrationSelectionDialog.on_applicationComboBox_activated"></a> <h4>DjangoMigrationSelectionDialog.on_applicationComboBox_activated</h4> <b>on_applicationComboBox_activated</b>(<i>app</i>) + <p> Private slot to update the migrations combo box. -</p><dl> +</p> +<dl> + <dt><i>app</i> (str)</dt> <dd> name of the selected application