ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoSquashMigrationSelectionDialog.html

changeset 83
b09e6a328c3d
child 125
d280acf98fb5
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoSquashMigrationSelectionDialog.html	Wed Dec 21 12:21:14 2016 +0100
@@ -0,0 +1,140 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Project_Django.ProjectDjango.DjangoSquashMigrationSelectionDialog</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_Django.ProjectDjango.DjangoSquashMigrationSelectionDialog</h1>
+<p>
+Module implementing a dialog to enter data needed to squash migrations.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#DjangoSquashMigrationSelectionDialog">DjangoSquashMigrationSelectionDialog</a></td>
+<td>Class implementing a dialog to enter data needed to squash migrations.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="DjangoSquashMigrationSelectionDialog" ID="DjangoSquashMigrationSelectionDialog"></a>
+<h2>DjangoSquashMigrationSelectionDialog</h2>
+<p>
+    Class implementing a dialog to enter data needed to squash migrations.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_DjangoSquashMigrationSelectionDialog
+<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="#DjangoSquashMigrationSelectionDialog.__init__">DjangoSquashMigrationSelectionDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#DjangoSquashMigrationSelectionDialog.__updateOkButton">__updateOkButton</a></td>
+<td>Private slot to set the enabled state of the OK button.</td>
+</tr><tr>
+<td><a href="#DjangoSquashMigrationSelectionDialog.getData">getData</a></td>
+<td>Public method to retrieve the data entered by the user.</td>
+</tr><tr>
+<td><a href="#DjangoSquashMigrationSelectionDialog.on_applicationComboBox_activated">on_applicationComboBox_activated</a></td>
+<td>Private slot to update the migrations combo boxes.</td>
+</tr><tr>
+<td><a href="#DjangoSquashMigrationSelectionDialog.on_endMigrationComboBox_activated">on_endMigrationComboBox_activated</a></td>
+<td>Private slot handling the selection of a migration.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="DjangoSquashMigrationSelectionDialog.__init__" ID="DjangoSquashMigrationSelectionDialog.__init__"></a>
+<h4>DjangoSquashMigrationSelectionDialog (Constructor)</h4>
+<b>DjangoSquashMigrationSelectionDialog</b>(<i>migrations, showStart, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>migrations</i> (dict)</dt>
+<dd>
+dictionary containing the available migrations
+</dd><dt><i>showStart</i> (bool)</dt>
+<dd>
+flag indicating to show the start migrations
+</dd><dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl><a NAME="DjangoSquashMigrationSelectionDialog.__updateOkButton" ID="DjangoSquashMigrationSelectionDialog.__updateOkButton"></a>
+<h4>DjangoSquashMigrationSelectionDialog.__updateOkButton</h4>
+<b>__updateOkButton</b>(<i></i>)
+<p>
+        Private slot to set the enabled state of the OK button.
+</p><a NAME="DjangoSquashMigrationSelectionDialog.getData" ID="DjangoSquashMigrationSelectionDialog.getData"></a>
+<h4>DjangoSquashMigrationSelectionDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to retrieve the data entered by the user.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing the selected app, the start migration,
+            the end migration and a flag indicating no optimization is wanted
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of three str and a bool
+</dd>
+</dl><a NAME="DjangoSquashMigrationSelectionDialog.on_applicationComboBox_activated" ID="DjangoSquashMigrationSelectionDialog.on_applicationComboBox_activated"></a>
+<h4>DjangoSquashMigrationSelectionDialog.on_applicationComboBox_activated</h4>
+<b>on_applicationComboBox_activated</b>(<i>app</i>)
+<p>
+        Private slot to update the migrations combo boxes.
+</p><dl>
+<dt><i>app</i> (str)</dt>
+<dd>
+name of the selected application
+</dd>
+</dl><a NAME="DjangoSquashMigrationSelectionDialog.on_endMigrationComboBox_activated" ID="DjangoSquashMigrationSelectionDialog.on_endMigrationComboBox_activated"></a>
+<h4>DjangoSquashMigrationSelectionDialog.on_endMigrationComboBox_activated</h4>
+<b>on_endMigrationComboBox_activated</b>(<i>migration</i>)
+<p>
+        Private slot handling the selection of a migration.
+</p><dl>
+<dt><i>migration</i> (str)</dt>
+<dd>
+name of the selected migration
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial