Mercurial Repositories > Pyramid Project / file comparison
comparison: ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html
ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html
- changeset 133
- 8f183975895d
- parent 95
- 2b0933087db9
- child 144
- 5c3684ee818e
equal
deleted
inserted
replaced
| 132:c0d53fb9a0e0 | 133:8f183975895d |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog</h1> | 23 <h1>Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a dialog for entering the create parameters. | 26 Module implementing a dialog for entering the create parameters. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#CreateParametersDialog">CreateParametersDialog</a></td> | 38 <td><a href="#CreateParametersDialog">CreateParametersDialog</a></td> |
| 34 <td>Class implementing a dialog for entering the create parameters.</td> | 39 <td>Class implementing a dialog for entering the create parameters.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="CreateParametersDialog" ID="CreateParametersDialog"></a> | 49 <a NAME="CreateParametersDialog" ID="CreateParametersDialog"></a> |
| 43 <h2>CreateParametersDialog</h2> | 50 <h2>CreateParametersDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a dialog for entering the create parameters. | 53 Class implementing a dialog for entering the create parameters. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QDialog, Ui_CreateParametersDialog | 56 QDialog, Ui_CreateParametersDialog |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#CreateParametersDialog.__init__">CreateParametersDialog</a></td> | 72 <td><a href="#CreateParametersDialog.__init__">CreateParametersDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#CreateParametersDialog.__prepareScaffoldString">__prepareScaffoldString</a></td> | 76 <td><a href="#CreateParametersDialog.__prepareScaffoldString">__prepareScaffoldString</a></td> |
| 64 <td>Private method to prepare a scaffold string for the combo box.</td> | 77 <td>Private method to prepare a scaffold string for the combo box.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#CreateParametersDialog.__updateUi">__updateUi</a></td> | 80 <td><a href="#CreateParametersDialog.__updateUi">__updateUi</a></td> |
| 67 <td>Private slot to update the dialog.</td> | 81 <td>Private slot to update the dialog.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#CreateParametersDialog.getData">getData</a></td> | 84 <td><a href="#CreateParametersDialog.getData">getData</a></td> |
| 70 <td>Public method to get the data.</td> | 85 <td>Public method to get the data.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#CreateParametersDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> | 88 <td><a href="#CreateParametersDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> |
| 73 <td>Private slot to handle changes of the site name.</td> | 89 <td>Private slot to handle changes of the site name.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#CreateParametersDialog.on_scaffoldCombo_currentIndexChanged">on_scaffoldCombo_currentIndexChanged</a></td> | 92 <td><a href="#CreateParametersDialog.on_scaffoldCombo_currentIndexChanged">on_scaffoldCombo_currentIndexChanged</a></td> |
| 76 <td>Private slot to handle changes of the selected scaffold.</td> | 93 <td>Private slot to handle changes of the selected scaffold.</td> |
| 77 </tr> | 94 </tr> |
| 78 </table> | 95 </table> |
| 79 <h3>Static Methods</h3> | 96 <h3>Static Methods</h3> |
| 97 | |
| 80 <table> | 98 <table> |
| 81 <tr><td>None</td></tr> | 99 <tr><td>None</td></tr> |
| 82 </table> | 100 </table> |
| 101 | |
| 83 <a NAME="CreateParametersDialog.__init__" ID="CreateParametersDialog.__init__"></a> | 102 <a NAME="CreateParametersDialog.__init__" ID="CreateParametersDialog.__init__"></a> |
| 84 <h4>CreateParametersDialog (Constructor)</h4> | 103 <h4>CreateParametersDialog (Constructor)</h4> |
| 85 <b>CreateParametersDialog</b>(<i>project, parent=None</i>) | 104 <b>CreateParametersDialog</b>(<i>project, parent=None</i>) |
| 105 | |
| 86 <p> | 106 <p> |
| 87 Constructor | 107 Constructor |
| 88 </p><dl> | 108 </p> |
| 109 <dl> | |
| 110 | |
| 89 <dt><i>project</i></dt> | 111 <dt><i>project</i></dt> |
| 90 <dd> | 112 <dd> |
| 91 reference to the project object (Project) | 113 reference to the project object (Project) |
| 92 </dd><dt><i>parent</i></dt> | 114 </dd> |
| 115 <dt><i>parent</i></dt> | |
| 93 <dd> | 116 <dd> |
| 94 reference to the parent widget (QWidget) | 117 reference to the parent widget (QWidget) |
| 95 </dd> | 118 </dd> |
| 96 </dl><a NAME="CreateParametersDialog.__prepareScaffoldString" ID="CreateParametersDialog.__prepareScaffoldString"></a> | 119 </dl> |
| 120 <a NAME="CreateParametersDialog.__prepareScaffoldString" ID="CreateParametersDialog.__prepareScaffoldString"></a> | |
| 97 <h4>CreateParametersDialog.__prepareScaffoldString</h4> | 121 <h4>CreateParametersDialog.__prepareScaffoldString</h4> |
| 98 <b>__prepareScaffoldString</b>(<i>line</i>) | 122 <b>__prepareScaffoldString</b>(<i>line</i>) |
| 123 | |
| 99 <p> | 124 <p> |
| 100 Private method to prepare a scaffold string for the combo box. | 125 Private method to prepare a scaffold string for the combo box. |
| 101 </p><dl> | 126 </p> |
| 127 <dl> | |
| 128 | |
| 102 <dt><i>line</i> (str)</dt> | 129 <dt><i>line</i> (str)</dt> |
| 103 <dd> | 130 <dd> |
| 104 output line containing the scaffold name and some | 131 output line containing the scaffold name and some |
| 105 explanatory text | 132 explanatory text |
| 106 </dd> | 133 </dd> |
| 107 </dl><dl> | 134 </dl> |
| 135 <dl> | |
| 108 <dt>Returns:</dt> | 136 <dt>Returns:</dt> |
| 109 <dd> | 137 <dd> |
| 110 prepared scaffold text | 138 prepared scaffold text |
| 111 </dd> | 139 </dd> |
| 112 </dl><dl> | 140 </dl> |
| 141 <dl> | |
| 113 <dt>Return Type:</dt> | 142 <dt>Return Type:</dt> |
| 114 <dd> | 143 <dd> |
| 115 str | 144 str |
| 116 </dd> | 145 </dd> |
| 117 </dl><a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a> | 146 </dl> |
| 147 <a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a> | |
| 118 <h4>CreateParametersDialog.__updateUi</h4> | 148 <h4>CreateParametersDialog.__updateUi</h4> |
| 119 <b>__updateUi</b>(<i></i>) | 149 <b>__updateUi</b>(<i></i>) |
| 150 | |
| 120 <p> | 151 <p> |
| 121 Private slot to update the dialog. | 152 Private slot to update the dialog. |
| 122 </p><a NAME="CreateParametersDialog.getData" ID="CreateParametersDialog.getData"></a> | 153 </p> |
| 154 <a NAME="CreateParametersDialog.getData" ID="CreateParametersDialog.getData"></a> | |
| 123 <h4>CreateParametersDialog.getData</h4> | 155 <h4>CreateParametersDialog.getData</h4> |
| 124 <b>getData</b>(<i></i>) | 156 <b>getData</b>(<i></i>) |
| 157 | |
| 125 <p> | 158 <p> |
| 126 Public method to get the data. | 159 Public method to get the data. |
| 127 </p><dl> | 160 </p> |
| 161 <dl> | |
| 128 <dt>Returns:</dt> | 162 <dt>Returns:</dt> |
| 129 <dd> | 163 <dd> |
| 130 tuple giving the scaffold (string), the project name (string), | 164 tuple giving the scaffold (string), the project name (string), |
| 131 a flag indicating to overwrite existing files (boolean) and a flag | 165 a flag indicating to overwrite existing files (boolean) and a flag |
| 132 indicating to simulate the creation (boolean) | 166 indicating to simulate the creation (boolean) |
| 133 </dd> | 167 </dd> |
| 134 </dl><a NAME="CreateParametersDialog.on_nameEdit_textChanged" ID="CreateParametersDialog.on_nameEdit_textChanged"></a> | 168 </dl> |
| 169 <a NAME="CreateParametersDialog.on_nameEdit_textChanged" ID="CreateParametersDialog.on_nameEdit_textChanged"></a> | |
| 135 <h4>CreateParametersDialog.on_nameEdit_textChanged</h4> | 170 <h4>CreateParametersDialog.on_nameEdit_textChanged</h4> |
| 136 <b>on_nameEdit_textChanged</b>(<i>text</i>) | 171 <b>on_nameEdit_textChanged</b>(<i>text</i>) |
| 172 | |
| 137 <p> | 173 <p> |
| 138 Private slot to handle changes of the site name. | 174 Private slot to handle changes of the site name. |
| 139 </p><dl> | 175 </p> |
| 176 <dl> | |
| 177 | |
| 140 <dt><i>text</i></dt> | 178 <dt><i>text</i></dt> |
| 141 <dd> | 179 <dd> |
| 142 text of the site entry (string) | 180 text of the site entry (string) |
| 143 </dd> | 181 </dd> |
| 144 </dl><a NAME="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged" ID="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged"></a> | 182 </dl> |
| 183 <a NAME="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged" ID="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged"></a> | |
| 145 <h4>CreateParametersDialog.on_scaffoldCombo_currentIndexChanged</h4> | 184 <h4>CreateParametersDialog.on_scaffoldCombo_currentIndexChanged</h4> |
| 146 <b>on_scaffoldCombo_currentIndexChanged</b>(<i>text</i>) | 185 <b>on_scaffoldCombo_currentIndexChanged</b>(<i>text</i>) |
| 186 | |
| 147 <p> | 187 <p> |
| 148 Private slot to handle changes of the selected scaffold. | 188 Private slot to handle changes of the selected scaffold. |
| 149 </p><dl> | 189 </p> |
| 190 <dl> | |
| 191 | |
| 150 <dt><i>text</i></dt> | 192 <dt><i>text</i></dt> |
| 151 <dd> | 193 <dd> |
| 152 text of the combo box (string) | 194 text of the combo box (string) |
| 153 </dd> | 195 </dd> |
| 154 </dl> | 196 </dl> |
