Mercurial Repositories > Django Project / file comparison
comparison: ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog.html
ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog.html
- changeset 83
- b09e6a328c3d
- child 161
- 208fced62e00
equal
deleted
inserted
replaced
| 82:fc196e739797 | 83:b09e6a328c3d |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to enter the options for a check operation. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#DjangoCheckOptionsDialog">DjangoCheckOptionsDialog</a></td> | |
| 34 <td>Class implementing a dialog to enter the options for a check operation.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="DjangoCheckOptionsDialog" ID="DjangoCheckOptionsDialog"></a> | |
| 43 <h2>DjangoCheckOptionsDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to enter the options for a check operation. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_DjangoCheckOptionsDialog | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#DjangoCheckOptionsDialog.__init__">DjangoCheckOptionsDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#DjangoCheckOptionsDialog.__moduleToPath">__moduleToPath</a></td> | |
| 64 <td>Private method to convert a module name to an file path.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#DjangoCheckOptionsDialog.__pathToModule">__pathToModule</a></td> | |
| 67 <td>Private method to convert a file path including a .py extension to a module name.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#DjangoCheckOptionsDialog.__populateTagsList">__populateTagsList</a></td> | |
| 70 <td>Private slot to populate the tags list.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#DjangoCheckOptionsDialog.getData">getData</a></td> | |
| 73 <td>Public method to get the options for the check operation.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#DjangoCheckOptionsDialog.on_deployCheckBox_toggled">on_deployCheckBox_toggled</a></td> | |
| 76 <td>Private slot handling a change of the deploy check box.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#DjangoCheckOptionsDialog.on_settingsFileButton_clicked">on_settingsFileButton_clicked</a></td> | |
| 79 <td>Private slot to select a settings file via a file selection dialog.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 <table> | |
| 84 <tr><td>None</td></tr> | |
| 85 </table> | |
| 86 <a NAME="DjangoCheckOptionsDialog.__init__" ID="DjangoCheckOptionsDialog.__init__"></a> | |
| 87 <h4>DjangoCheckOptionsDialog (Constructor)</h4> | |
| 88 <b>DjangoCheckOptionsDialog</b>(<i>python, path, apps, deployMode, parent=None</i>) | |
| 89 <p> | |
| 90 Constructor | |
| 91 </p><dl> | |
| 92 <dt><i>python</i> (str)</dt> | |
| 93 <dd> | |
| 94 path of the Python executable | |
| 95 </dd><dt><i>path</i> (str)</dt> | |
| 96 <dd> | |
| 97 site path to run the manage.py script with | |
| 98 </dd><dt><i>apps</i> (list of str)</dt> | |
| 99 <dd> | |
| 100 list of recently used application strings | |
| 101 </dd><dt><i>deployMode</i> (bool)</dt> | |
| 102 <dd> | |
| 103 flag indicating to activate the deployment mode | |
| 104 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 105 <dd> | |
| 106 reference to the parent widget | |
| 107 </dd> | |
| 108 </dl><a NAME="DjangoCheckOptionsDialog.__moduleToPath" ID="DjangoCheckOptionsDialog.__moduleToPath"></a> | |
| 109 <h4>DjangoCheckOptionsDialog.__moduleToPath</h4> | |
| 110 <b>__moduleToPath</b>(<i>moduleName</i>) | |
| 111 <p> | |
| 112 Private method to convert a module name to an file path. | |
| 113 </p><dl> | |
| 114 <dt><i>moduleName</i> (str)</dt> | |
| 115 <dd> | |
| 116 module name to be converted | |
| 117 </dd> | |
| 118 </dl><dl> | |
| 119 <dt>Returns:</dt> | |
| 120 <dd> | |
| 121 file path | |
| 122 </dd> | |
| 123 </dl><dl> | |
| 124 <dt>Return Type:</dt> | |
| 125 <dd> | |
| 126 str | |
| 127 </dd> | |
| 128 </dl><a NAME="DjangoCheckOptionsDialog.__pathToModule" ID="DjangoCheckOptionsDialog.__pathToModule"></a> | |
| 129 <h4>DjangoCheckOptionsDialog.__pathToModule</h4> | |
| 130 <b>__pathToModule</b>(<i>path</i>) | |
| 131 <p> | |
| 132 Private method to convert a file path including a .py extension to a | |
| 133 module name. | |
| 134 </p><dl> | |
| 135 <dt><i>path</i> (str)</dt> | |
| 136 <dd> | |
| 137 file path to be converted | |
| 138 </dd> | |
| 139 </dl><dl> | |
| 140 <dt>Returns:</dt> | |
| 141 <dd> | |
| 142 module name | |
| 143 </dd> | |
| 144 </dl><dl> | |
| 145 <dt>Return Type:</dt> | |
| 146 <dd> | |
| 147 str | |
| 148 </dd> | |
| 149 </dl><a NAME="DjangoCheckOptionsDialog.__populateTagsList" ID="DjangoCheckOptionsDialog.__populateTagsList"></a> | |
| 150 <h4>DjangoCheckOptionsDialog.__populateTagsList</h4> | |
| 151 <b>__populateTagsList</b>(<i>deployMode</i>) | |
| 152 <p> | |
| 153 Private slot to populate the tags list. | |
| 154 </p><dl> | |
| 155 <dt><i>deployMode</i> (bool)</dt> | |
| 156 <dd> | |
| 157 flag indicating the deployment mode | |
| 158 </dd> | |
| 159 </dl><a NAME="DjangoCheckOptionsDialog.getData" ID="DjangoCheckOptionsDialog.getData"></a> | |
| 160 <h4>DjangoCheckOptionsDialog.getData</h4> | |
| 161 <b>getData</b>(<i></i>) | |
| 162 <p> | |
| 163 Public method to get the options for the check operation. | |
| 164 </p><dl> | |
| 165 <dt>Returns:</dt> | |
| 166 <dd> | |
| 167 tuple containing the deployment flag, list of selected tags, | |
| 168 applications string and the settings file | |
| 169 </dd> | |
| 170 </dl><dl> | |
| 171 <dt>Return Type:</dt> | |
| 172 <dd> | |
| 173 tuple of bool, list of str, str and str | |
| 174 </dd> | |
| 175 </dl><a NAME="DjangoCheckOptionsDialog.on_deployCheckBox_toggled" ID="DjangoCheckOptionsDialog.on_deployCheckBox_toggled"></a> | |
| 176 <h4>DjangoCheckOptionsDialog.on_deployCheckBox_toggled</h4> | |
| 177 <b>on_deployCheckBox_toggled</b>(<i>checked</i>) | |
| 178 <p> | |
| 179 Private slot handling a change of the deploy check box. | |
| 180 </p><dl> | |
| 181 <dt><i>checked</i> (bool)</dt> | |
| 182 <dd> | |
| 183 state of the check box | |
| 184 </dd> | |
| 185 </dl><a NAME="DjangoCheckOptionsDialog.on_settingsFileButton_clicked" ID="DjangoCheckOptionsDialog.on_settingsFileButton_clicked"></a> | |
| 186 <h4>DjangoCheckOptionsDialog.on_settingsFileButton_clicked</h4> | |
| 187 <b>on_settingsFileButton_clicked</b>(<i></i>) | |
| 188 <p> | |
| 189 Private slot to select a settings file via a file selection dialog. | |
| 190 </p> | |
| 191 <div align="right"><a href="#top">Up</a></div> | |
| 192 <hr /> | |
| 193 </body></html> |
