Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.SqlBrowser.SqlBrowserWidget.html
src/eric7/Documentation/Source/eric7.SqlBrowser.SqlBrowserWidget.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10431
- 64157aeb0312
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.SqlBrowser.SqlBrowserWidget</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.SqlBrowser.SqlBrowserWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the SQL Browser widget. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#SqlBrowserWidget">SqlBrowserWidget</a></td> | |
| 25 <td>Class implementing the SQL Browser widget.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="SqlBrowserWidget" ID="SqlBrowserWidget"></a> | |
| 36 <h2>SqlBrowserWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the SQL Browser widget. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>statusMessage(str)</dt> | |
| 45 <dd> | |
| 46 emitted to show a status message | |
| 47 </dd> | |
| 48 </dl> | |
| 49 <h3>Derived from</h3> | |
| 50 QWidget, Ui_SqlBrowserWidget | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>cCount</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#SqlBrowserWidget.__init__">SqlBrowserWidget</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#SqlBrowserWidget.__deleteRow">__deleteRow</a></td> | |
| 71 <td>Private slot to delete a row from the database table.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#SqlBrowserWidget.__insertRow">__insertRow</a></td> | |
| 75 <td>Private slot to insert a row into the database table.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#SqlBrowserWidget.addConnection">addConnection</a></td> | |
| 79 <td>Public method to add a database connection.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#SqlBrowserWidget.addConnectionByDialog">addConnectionByDialog</a></td> | |
| 83 <td>Public slot to add a database connection via an input dialog.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#SqlBrowserWidget.executeQuery">executeQuery</a></td> | |
| 87 <td>Public slot to execute the entered query.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#SqlBrowserWidget.on_clearButton_clicked">on_clearButton_clicked</a></td> | |
| 91 <td>Private slot to clear the SQL entry widget.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#SqlBrowserWidget.on_connections_cleared">on_connections_cleared</a></td> | |
| 95 <td>Private slot to clear the table.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#SqlBrowserWidget.on_connections_schemaRequested">on_connections_schemaRequested</a></td> | |
| 99 <td>Private slot to show the schema of a table.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#SqlBrowserWidget.on_connections_tableActivated">on_connections_tableActivated</a></td> | |
| 103 <td>Private slot to show the contents of a table.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#SqlBrowserWidget.on_deleteRowAction_triggered">on_deleteRowAction_triggered</a></td> | |
| 107 <td>Private slot handling the action to delete a row.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#SqlBrowserWidget.on_executeButton_clicked">on_executeButton_clicked</a></td> | |
| 111 <td>Private slot to execute the entered SQL query.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#SqlBrowserWidget.on_insertRowAction_triggered">on_insertRowAction_triggered</a></td> | |
| 115 <td>Private slot handling the action to insert a new row.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#SqlBrowserWidget.showSchema">showSchema</a></td> | |
| 119 <td>Public slot to show the schema of a table.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#SqlBrowserWidget.showTable">showTable</a></td> | |
| 123 <td>Public slot to show the contents of a table.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#SqlBrowserWidget.updateActions">updateActions</a></td> | |
| 127 <td>Public slot to update the actions.</td> | |
| 128 </tr> | |
| 129 </table> | |
| 130 <h3>Static Methods</h3> | |
| 131 | |
| 132 <table> | |
| 133 <tr><td>None</td></tr> | |
| 134 </table> | |
| 135 | |
| 136 <a NAME="SqlBrowserWidget.__init__" ID="SqlBrowserWidget.__init__"></a> | |
| 137 <h4>SqlBrowserWidget (Constructor)</h4> | |
| 138 <b>SqlBrowserWidget</b>(<i>parent=None</i>) | |
| 139 | |
| 140 <p> | |
| 141 Constructor | |
| 142 </p> | |
| 143 <dl> | |
| 144 | |
| 145 <dt><i>parent</i></dt> | |
| 146 <dd> | |
| 147 reference to the parent widget (QWidget) | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <a NAME="SqlBrowserWidget.__deleteRow" ID="SqlBrowserWidget.__deleteRow"></a> | |
| 151 <h4>SqlBrowserWidget.__deleteRow</h4> | |
| 152 <b>__deleteRow</b>(<i></i>) | |
| 153 | |
| 154 <p> | |
| 155 Private slot to delete a row from the database table. | |
| 156 </p> | |
| 157 <a NAME="SqlBrowserWidget.__insertRow" ID="SqlBrowserWidget.__insertRow"></a> | |
| 158 <h4>SqlBrowserWidget.__insertRow</h4> | |
| 159 <b>__insertRow</b>(<i></i>) | |
| 160 | |
| 161 <p> | |
| 162 Private slot to insert a row into the database table. | |
| 163 </p> | |
| 164 <a NAME="SqlBrowserWidget.addConnection" ID="SqlBrowserWidget.addConnection"></a> | |
| 165 <h4>SqlBrowserWidget.addConnection</h4> | |
| 166 <b>addConnection</b>(<i>driver, dbName, user, password, host, port</i>) | |
| 167 | |
| 168 <p> | |
| 169 Public method to add a database connection. | |
| 170 </p> | |
| 171 <dl> | |
| 172 | |
| 173 <dt><i>driver</i></dt> | |
| 174 <dd> | |
| 175 name of the Qt database driver (string) | |
| 176 </dd> | |
| 177 <dt><i>dbName</i></dt> | |
| 178 <dd> | |
| 179 name of the database (string) | |
| 180 </dd> | |
| 181 <dt><i>user</i></dt> | |
| 182 <dd> | |
| 183 user name (string) | |
| 184 </dd> | |
| 185 <dt><i>password</i></dt> | |
| 186 <dd> | |
| 187 password (string) | |
| 188 </dd> | |
| 189 <dt><i>host</i></dt> | |
| 190 <dd> | |
| 191 host name (string) | |
| 192 </dd> | |
| 193 <dt><i>port</i></dt> | |
| 194 <dd> | |
| 195 port number (integer) | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <dl> | |
| 199 <dt>Return:</dt> | |
| 200 <dd> | |
| 201 SQL error object (QSqlError) | |
| 202 </dd> | |
| 203 </dl> | |
| 204 <a NAME="SqlBrowserWidget.addConnectionByDialog" ID="SqlBrowserWidget.addConnectionByDialog"></a> | |
| 205 <h4>SqlBrowserWidget.addConnectionByDialog</h4> | |
| 206 <b>addConnectionByDialog</b>(<i></i>) | |
| 207 | |
| 208 <p> | |
| 209 Public slot to add a database connection via an input dialog. | |
| 210 </p> | |
| 211 <a NAME="SqlBrowserWidget.executeQuery" ID="SqlBrowserWidget.executeQuery"></a> | |
| 212 <h4>SqlBrowserWidget.executeQuery</h4> | |
| 213 <b>executeQuery</b>(<i></i>) | |
| 214 | |
| 215 <p> | |
| 216 Public slot to execute the entered query. | |
| 217 </p> | |
| 218 <a NAME="SqlBrowserWidget.on_clearButton_clicked" ID="SqlBrowserWidget.on_clearButton_clicked"></a> | |
| 219 <h4>SqlBrowserWidget.on_clearButton_clicked</h4> | |
| 220 <b>on_clearButton_clicked</b>(<i></i>) | |
| 221 | |
| 222 <p> | |
| 223 Private slot to clear the SQL entry widget. | |
| 224 </p> | |
| 225 <a NAME="SqlBrowserWidget.on_connections_cleared" ID="SqlBrowserWidget.on_connections_cleared"></a> | |
| 226 <h4>SqlBrowserWidget.on_connections_cleared</h4> | |
| 227 <b>on_connections_cleared</b>(<i></i>) | |
| 228 | |
| 229 <p> | |
| 230 Private slot to clear the table. | |
| 231 </p> | |
| 232 <a NAME="SqlBrowserWidget.on_connections_schemaRequested" ID="SqlBrowserWidget.on_connections_schemaRequested"></a> | |
| 233 <h4>SqlBrowserWidget.on_connections_schemaRequested</h4> | |
| 234 <b>on_connections_schemaRequested</b>(<i>table</i>) | |
| 235 | |
| 236 <p> | |
| 237 Private slot to show the schema of a table. | |
| 238 </p> | |
| 239 <dl> | |
| 240 | |
| 241 <dt><i>table</i></dt> | |
| 242 <dd> | |
| 243 name of the table for which to show the schema (string) | |
| 244 </dd> | |
| 245 </dl> | |
| 246 <a NAME="SqlBrowserWidget.on_connections_tableActivated" ID="SqlBrowserWidget.on_connections_tableActivated"></a> | |
| 247 <h4>SqlBrowserWidget.on_connections_tableActivated</h4> | |
| 248 <b>on_connections_tableActivated</b>(<i>table</i>) | |
| 249 | |
| 250 <p> | |
| 251 Private slot to show the contents of a table. | |
| 252 </p> | |
| 253 <dl> | |
| 254 | |
| 255 <dt><i>table</i></dt> | |
| 256 <dd> | |
| 257 name of the table for which to show the contents (string) | |
| 258 </dd> | |
| 259 </dl> | |
| 260 <a NAME="SqlBrowserWidget.on_deleteRowAction_triggered" ID="SqlBrowserWidget.on_deleteRowAction_triggered"></a> | |
| 261 <h4>SqlBrowserWidget.on_deleteRowAction_triggered</h4> | |
| 262 <b>on_deleteRowAction_triggered</b>(<i></i>) | |
| 263 | |
| 264 <p> | |
| 265 Private slot handling the action to delete a row. | |
| 266 </p> | |
| 267 <a NAME="SqlBrowserWidget.on_executeButton_clicked" ID="SqlBrowserWidget.on_executeButton_clicked"></a> | |
| 268 <h4>SqlBrowserWidget.on_executeButton_clicked</h4> | |
| 269 <b>on_executeButton_clicked</b>(<i></i>) | |
| 270 | |
| 271 <p> | |
| 272 Private slot to execute the entered SQL query. | |
| 273 </p> | |
| 274 <a NAME="SqlBrowserWidget.on_insertRowAction_triggered" ID="SqlBrowserWidget.on_insertRowAction_triggered"></a> | |
| 275 <h4>SqlBrowserWidget.on_insertRowAction_triggered</h4> | |
| 276 <b>on_insertRowAction_triggered</b>(<i></i>) | |
| 277 | |
| 278 <p> | |
| 279 Private slot handling the action to insert a new row. | |
| 280 </p> | |
| 281 <a NAME="SqlBrowserWidget.showSchema" ID="SqlBrowserWidget.showSchema"></a> | |
| 282 <h4>SqlBrowserWidget.showSchema</h4> | |
| 283 <b>showSchema</b>(<i>table</i>) | |
| 284 | |
| 285 <p> | |
| 286 Public slot to show the schema of a table. | |
| 287 </p> | |
| 288 <dl> | |
| 289 | |
| 290 <dt><i>table</i></dt> | |
| 291 <dd> | |
| 292 name of the table to be shown (string) | |
| 293 </dd> | |
| 294 </dl> | |
| 295 <a NAME="SqlBrowserWidget.showTable" ID="SqlBrowserWidget.showTable"></a> | |
| 296 <h4>SqlBrowserWidget.showTable</h4> | |
| 297 <b>showTable</b>(<i>table</i>) | |
| 298 | |
| 299 <p> | |
| 300 Public slot to show the contents of a table. | |
| 301 </p> | |
| 302 <dl> | |
| 303 | |
| 304 <dt><i>table</i></dt> | |
| 305 <dd> | |
| 306 name of the table to be shown (string) | |
| 307 </dd> | |
| 308 </dl> | |
| 309 <a NAME="SqlBrowserWidget.updateActions" ID="SqlBrowserWidget.updateActions"></a> | |
| 310 <h4>SqlBrowserWidget.updateActions</h4> | |
| 311 <b>updateActions</b>(<i></i>) | |
| 312 | |
| 313 <p> | |
| 314 Public slot to update the actions. | |
| 315 </p> | |
| 316 <div align="right"><a href="#top">Up</a></div> | |
| 317 <hr /> | |
| 318 </body></html> |
