Mercurial Repositories > Flask Project / file comparison
comparison: ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.RoutesDialog.html
ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.RoutesDialog.html
- changeset 19
- f8e3c1676f9b
- child 61
- fe1e8783a95f
equal
deleted
inserted
replaced
| 18:d76a0939be6a | 19:f8e3c1676f9b |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Project_Flask.ProjectFlask.RoutesDialog</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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>Plugin_Project_Flask.ProjectFlask.RoutesDialog</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a dialog to show the application routes. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#RoutesDialog">RoutesDialog</a></td> | |
| 39 <td>Class implementing a dialog to show the application routes.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="RoutesDialog" ID="RoutesDialog"></a> | |
| 50 <h2>RoutesDialog</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing a dialog to show the application routes. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 QDialog, Ui_RoutesDialog | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 | |
| 71 <tr> | |
| 72 <td><a href="#RoutesDialog.__init__">RoutesDialog</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#RoutesDialog.__processOutput">__processOutput</a></td> | |
| 77 <td>Private method to process the flask output and populate the routes list.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#RoutesDialog.on_allMethodsCheckBox_toggled">on_allMethodsCheckBox_toggled</a></td> | |
| 81 <td>Private slot handling the selection to show all methods.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#RoutesDialog.on_endpointButton_toggled">on_endpointButton_toggled</a></td> | |
| 85 <td>Private slot handling the selection of the 'endpoint' sort order.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#RoutesDialog.on_matchButton_toggled">on_matchButton_toggled</a></td> | |
| 89 <td>Private slot handling the selection of the 'match' sort order.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#RoutesDialog.on_methodsButton_toggled">on_methodsButton_toggled</a></td> | |
| 93 <td>Private slot handling the selection of the 'methods' sort order.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#RoutesDialog.on_ruleButton_toggled">on_ruleButton_toggled</a></td> | |
| 97 <td>Private slot handling the selection of the 'rule' sort order.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#RoutesDialog.showRoutes">showRoutes</a></td> | |
| 101 <td>Public method to show the list of routes.</td> | |
| 102 </tr> | |
| 103 </table> | |
| 104 <h3>Static Methods</h3> | |
| 105 | |
| 106 <table> | |
| 107 <tr><td>None</td></tr> | |
| 108 </table> | |
| 109 | |
| 110 <a NAME="RoutesDialog.__init__" ID="RoutesDialog.__init__"></a> | |
| 111 <h4>RoutesDialog (Constructor)</h4> | |
| 112 <b>RoutesDialog</b>(<i>project, parent=None</i>) | |
| 113 | |
| 114 <p> | |
| 115 Constructor | |
| 116 </p> | |
| 117 <dl> | |
| 118 | |
| 119 <dt><i>project</i> (Project)</dt> | |
| 120 <dd> | |
| 121 reference to the project object | |
| 122 </dd> | |
| 123 <dt><i>parent</i> (QWidget)</dt> | |
| 124 <dd> | |
| 125 reference to the parent widget | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <a NAME="RoutesDialog.__processOutput" ID="RoutesDialog.__processOutput"></a> | |
| 129 <h4>RoutesDialog.__processOutput</h4> | |
| 130 <b>__processOutput</b>(<i>output</i>) | |
| 131 | |
| 132 <p> | |
| 133 Private method to process the flask output and populate the routes | |
| 134 list. | |
| 135 </p> | |
| 136 <dl> | |
| 137 | |
| 138 <dt><i>output</i> (str)</dt> | |
| 139 <dd> | |
| 140 output of the flask process | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <a NAME="RoutesDialog.on_allMethodsCheckBox_toggled" ID="RoutesDialog.on_allMethodsCheckBox_toggled"></a> | |
| 144 <h4>RoutesDialog.on_allMethodsCheckBox_toggled</h4> | |
| 145 <b>on_allMethodsCheckBox_toggled</b>(<i>checked</i>) | |
| 146 | |
| 147 <p> | |
| 148 Private slot handling the selection to show all methods. | |
| 149 </p> | |
| 150 <dl> | |
| 151 | |
| 152 <dt><i>checked</i> (bool)</dt> | |
| 153 <dd> | |
| 154 state of the button | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <a NAME="RoutesDialog.on_endpointButton_toggled" ID="RoutesDialog.on_endpointButton_toggled"></a> | |
| 158 <h4>RoutesDialog.on_endpointButton_toggled</h4> | |
| 159 <b>on_endpointButton_toggled</b>(<i>checked</i>) | |
| 160 | |
| 161 <p> | |
| 162 Private slot handling the selection of the 'endpoint' sort order. | |
| 163 </p> | |
| 164 <dl> | |
| 165 | |
| 166 <dt><i>checked</i> (bool)</dt> | |
| 167 <dd> | |
| 168 state of the button | |
| 169 </dd> | |
| 170 </dl> | |
| 171 <a NAME="RoutesDialog.on_matchButton_toggled" ID="RoutesDialog.on_matchButton_toggled"></a> | |
| 172 <h4>RoutesDialog.on_matchButton_toggled</h4> | |
| 173 <b>on_matchButton_toggled</b>(<i>checked</i>) | |
| 174 | |
| 175 <p> | |
| 176 Private slot handling the selection of the 'match' sort order. | |
| 177 </p> | |
| 178 <dl> | |
| 179 | |
| 180 <dt><i>checked</i> (bool)</dt> | |
| 181 <dd> | |
| 182 state of the button | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <a NAME="RoutesDialog.on_methodsButton_toggled" ID="RoutesDialog.on_methodsButton_toggled"></a> | |
| 186 <h4>RoutesDialog.on_methodsButton_toggled</h4> | |
| 187 <b>on_methodsButton_toggled</b>(<i>checked</i>) | |
| 188 | |
| 189 <p> | |
| 190 Private slot handling the selection of the 'methods' sort order. | |
| 191 </p> | |
| 192 <dl> | |
| 193 | |
| 194 <dt><i>checked</i> (bool)</dt> | |
| 195 <dd> | |
| 196 state of the button | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <a NAME="RoutesDialog.on_ruleButton_toggled" ID="RoutesDialog.on_ruleButton_toggled"></a> | |
| 200 <h4>RoutesDialog.on_ruleButton_toggled</h4> | |
| 201 <b>on_ruleButton_toggled</b>(<i>checked</i>) | |
| 202 | |
| 203 <p> | |
| 204 Private slot handling the selection of the 'rule' sort order. | |
| 205 </p> | |
| 206 <dl> | |
| 207 | |
| 208 <dt><i>checked</i> (bool)</dt> | |
| 209 <dd> | |
| 210 state of the button | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <a NAME="RoutesDialog.showRoutes" ID="RoutesDialog.showRoutes"></a> | |
| 214 <h4>RoutesDialog.showRoutes</h4> | |
| 215 <b>showRoutes</b>(<i></i>) | |
| 216 | |
| 217 <p> | |
| 218 Public method to show the list of routes. | |
| 219 </p> | |
| 220 <dl> | |
| 221 <dt>Returns:</dt> | |
| 222 <dd> | |
| 223 flag indicating success | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <dl> | |
| 227 <dt>Return Type:</dt> | |
| 228 <dd> | |
| 229 bool | |
| 230 </dd> | |
| 231 </dl> | |
| 232 <div align="right"><a href="#top">Up</a></div> | |
| 233 <hr /> | |
| 234 </body></html> |
