Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.SqlBrowser.SqlBrowserWidget.html
Documentation/Source/eric5.SqlBrowser.SqlBrowserWidget.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.SqlBrowser.SqlBrowserWidget</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.SqlBrowser.SqlBrowserWidget</h1> | |
| 12 <p> | |
| 13 Module implementing the SQL Browser widget. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#SqlBrowserWidget">SqlBrowserWidget</a></td> | |
| 23 <td>Class implementing the SQL Browser widget.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="SqlBrowserWidget" ID="SqlBrowserWidget"></a> | |
| 32 <h2>SqlBrowserWidget</h2> | |
| 33 <p> | |
| 34 Class implementing the SQL Browser widget. | |
| 35 </p><h4>Signals</h4> | |
| 36 <dl> | |
| 37 <dt>statusMessage(string)</dt> | |
| 38 <dd> | |
| 39 emitted to show a status message | |
| 40 </dd> | |
| 41 </dl> | |
| 42 <h3>Derived from</h3> | |
| 43 QWidget, Ui_SqlBrowserWidget | |
| 44 <h3>Class Attributes</h3> | |
| 45 <table> | |
| 46 <tr><td>cCount</td></tr> | |
| 47 </table> | |
| 48 <h3>Methods</h3> | |
| 49 <table> | |
| 50 <tr> | |
| 51 <td><a href="#SqlBrowserWidget.__init__">SqlBrowserWidget</a></td> | |
| 52 <td>Constructor</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#SqlBrowserWidget.__deleteRow">__deleteRow</a></td> | |
| 55 <td>Privat slot to delete a row from the database table.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#SqlBrowserWidget.__insertRow">__insertRow</a></td> | |
| 58 <td>Privat slot to insert a row into the database table.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#SqlBrowserWidget.addConnection">addConnection</a></td> | |
| 61 <td>Public method to add a database connection.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#SqlBrowserWidget.addConnectionByDialog">addConnectionByDialog</a></td> | |
| 64 <td>Public slot to add a database connection via an input dialog.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#SqlBrowserWidget.executeQuery">executeQuery</a></td> | |
| 67 <td>Public slot to execute the entered query.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#SqlBrowserWidget.on_clearButton_clicked">on_clearButton_clicked</a></td> | |
| 70 <td>Private slot to clear the SQL entry widget.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#SqlBrowserWidget.on_connections_cleared">on_connections_cleared</a></td> | |
| 73 <td>Private slot to clear the table.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#SqlBrowserWidget.on_connections_schemaRequested">on_connections_schemaRequested</a></td> | |
| 76 <td>Private slot to show the schema of a table.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#SqlBrowserWidget.on_connections_tableActivated">on_connections_tableActivated</a></td> | |
| 79 <td>Private slot to show the contents of a table.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#SqlBrowserWidget.on_deleteRowAction_triggered">on_deleteRowAction_triggered</a></td> | |
| 82 <td>Private slot handling the action to delete a row.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#SqlBrowserWidget.on_executeButton_clicked">on_executeButton_clicked</a></td> | |
| 85 <td>Private slot to execute the entered SQL query.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#SqlBrowserWidget.on_insertRowAction_triggered">on_insertRowAction_triggered</a></td> | |
| 88 <td>Private slot handling the action to insert a new row.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#SqlBrowserWidget.showSchema">showSchema</a></td> | |
| 91 <td>Public slot to show the schema of a table.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#SqlBrowserWidget.showTable">showTable</a></td> | |
| 94 <td>Public slot to show the contents of a table.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#SqlBrowserWidget.updateActions">updateActions</a></td> | |
| 97 <td>Public slot to update the actions.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <a NAME="SqlBrowserWidget.__init__" ID="SqlBrowserWidget.__init__"></a> | |
| 101 <h4>SqlBrowserWidget (Constructor)</h4> | |
| 102 <b>SqlBrowserWidget</b>(<i>parent = None</i>) | |
| 103 <p> | |
| 104 Constructor | |
| 105 </p><dl> | |
| 106 <dt><i>parent</i></dt> | |
| 107 <dd> | |
| 108 reference to the parent widget (QWidget) | |
| 109 </dd> | |
| 110 </dl><a NAME="SqlBrowserWidget.__deleteRow" ID="SqlBrowserWidget.__deleteRow"></a> | |
| 111 <h4>SqlBrowserWidget.__deleteRow</h4> | |
| 112 <b>__deleteRow</b>(<i></i>) | |
| 113 <p> | |
| 114 Privat slot to delete a row from the database table. | |
| 115 </p><a NAME="SqlBrowserWidget.__insertRow" ID="SqlBrowserWidget.__insertRow"></a> | |
| 116 <h4>SqlBrowserWidget.__insertRow</h4> | |
| 117 <b>__insertRow</b>(<i></i>) | |
| 118 <p> | |
| 119 Privat slot to insert a row into the database table. | |
| 120 </p><a NAME="SqlBrowserWidget.addConnection" ID="SqlBrowserWidget.addConnection"></a> | |
| 121 <h4>SqlBrowserWidget.addConnection</h4> | |
| 122 <b>addConnection</b>(<i>driver, dbName, user, password, host, port</i>) | |
| 123 <p> | |
| 124 Public method to add a database connection. | |
| 125 </p><dl> | |
| 126 <dt><i>driver</i></dt> | |
| 127 <dd> | |
| 128 name of the Qt database driver (string) | |
| 129 </dd><dt><i>dbName</i></dt> | |
| 130 <dd> | |
| 131 name of the database (string) | |
| 132 </dd><dt><i>user</i></dt> | |
| 133 <dd> | |
| 134 user name (string) | |
| 135 </dd><dt><i>password</i></dt> | |
| 136 <dd> | |
| 137 password (string) | |
| 138 </dd><dt><i>host</i></dt> | |
| 139 <dd> | |
| 140 host name (string) | |
| 141 </dd><dt><i>port</i></dt> | |
| 142 <dd> | |
| 143 port number (integer) | |
| 144 </dd> | |
| 145 </dl><a NAME="SqlBrowserWidget.addConnectionByDialog" ID="SqlBrowserWidget.addConnectionByDialog"></a> | |
| 146 <h4>SqlBrowserWidget.addConnectionByDialog</h4> | |
| 147 <b>addConnectionByDialog</b>(<i></i>) | |
| 148 <p> | |
| 149 Public slot to add a database connection via an input dialog. | |
| 150 </p><a NAME="SqlBrowserWidget.executeQuery" ID="SqlBrowserWidget.executeQuery"></a> | |
| 151 <h4>SqlBrowserWidget.executeQuery</h4> | |
| 152 <b>executeQuery</b>(<i></i>) | |
| 153 <p> | |
| 154 Public slot to execute the entered query. | |
| 155 </p><a NAME="SqlBrowserWidget.on_clearButton_clicked" ID="SqlBrowserWidget.on_clearButton_clicked"></a> | |
| 156 <h4>SqlBrowserWidget.on_clearButton_clicked</h4> | |
| 157 <b>on_clearButton_clicked</b>(<i></i>) | |
| 158 <p> | |
| 159 Private slot to clear the SQL entry widget. | |
| 160 </p><a NAME="SqlBrowserWidget.on_connections_cleared" ID="SqlBrowserWidget.on_connections_cleared"></a> | |
| 161 <h4>SqlBrowserWidget.on_connections_cleared</h4> | |
| 162 <b>on_connections_cleared</b>(<i></i>) | |
| 163 <p> | |
| 164 Private slot to clear the table. | |
| 165 </p><a NAME="SqlBrowserWidget.on_connections_schemaRequested" ID="SqlBrowserWidget.on_connections_schemaRequested"></a> | |
| 166 <h4>SqlBrowserWidget.on_connections_schemaRequested</h4> | |
| 167 <b>on_connections_schemaRequested</b>(<i>table</i>) | |
| 168 <p> | |
| 169 Private slot to show the schema of a table. | |
| 170 </p><dl> | |
| 171 <dt><i>table</i></dt> | |
| 172 <dd> | |
| 173 name of the table for which to show the schema (string) | |
| 174 </dd> | |
| 175 </dl><a NAME="SqlBrowserWidget.on_connections_tableActivated" ID="SqlBrowserWidget.on_connections_tableActivated"></a> | |
| 176 <h4>SqlBrowserWidget.on_connections_tableActivated</h4> | |
| 177 <b>on_connections_tableActivated</b>(<i>table</i>) | |
| 178 <p> | |
| 179 Private slot to show the contents of a table. | |
| 180 </p><dl> | |
| 181 <dt><i>table</i></dt> | |
| 182 <dd> | |
| 183 name of the table for which to show the contents (string) | |
| 184 </dd> | |
| 185 </dl><a NAME="SqlBrowserWidget.on_deleteRowAction_triggered" ID="SqlBrowserWidget.on_deleteRowAction_triggered"></a> | |
| 186 <h4>SqlBrowserWidget.on_deleteRowAction_triggered</h4> | |
| 187 <b>on_deleteRowAction_triggered</b>(<i></i>) | |
| 188 <p> | |
| 189 Private slot handling the action to delete a row. | |
| 190 </p><a NAME="SqlBrowserWidget.on_executeButton_clicked" ID="SqlBrowserWidget.on_executeButton_clicked"></a> | |
| 191 <h4>SqlBrowserWidget.on_executeButton_clicked</h4> | |
| 192 <b>on_executeButton_clicked</b>(<i></i>) | |
| 193 <p> | |
| 194 Private slot to execute the entered SQL query. | |
| 195 </p><a NAME="SqlBrowserWidget.on_insertRowAction_triggered" ID="SqlBrowserWidget.on_insertRowAction_triggered"></a> | |
| 196 <h4>SqlBrowserWidget.on_insertRowAction_triggered</h4> | |
| 197 <b>on_insertRowAction_triggered</b>(<i></i>) | |
| 198 <p> | |
| 199 Private slot handling the action to insert a new row. | |
| 200 </p><a NAME="SqlBrowserWidget.showSchema" ID="SqlBrowserWidget.showSchema"></a> | |
| 201 <h4>SqlBrowserWidget.showSchema</h4> | |
| 202 <b>showSchema</b>(<i>table</i>) | |
| 203 <p> | |
| 204 Public slot to show the schema of a table. | |
| 205 </p><dl> | |
| 206 <dt><i>table</i></dt> | |
| 207 <dd> | |
| 208 name of the table to be shown (string) | |
| 209 </dd> | |
| 210 </dl><a NAME="SqlBrowserWidget.showTable" ID="SqlBrowserWidget.showTable"></a> | |
| 211 <h4>SqlBrowserWidget.showTable</h4> | |
| 212 <b>showTable</b>(<i>table</i>) | |
| 213 <p> | |
| 214 Public slot to show the contents of a table. | |
| 215 </p><dl> | |
| 216 <dt><i>table</i></dt> | |
| 217 <dd> | |
| 218 name of the table to be shown (string) | |
| 219 </dd> | |
| 220 </dl><a NAME="SqlBrowserWidget.updateActions" ID="SqlBrowserWidget.updateActions"></a> | |
| 221 <h4>SqlBrowserWidget.updateActions</h4> | |
| 222 <b>updateActions</b>(<i></i>) | |
| 223 <p> | |
| 224 Public slot to update the actions. | |
| 225 </p> | |
| 226 <div align="right"><a href="#top">Up</a></div> | |
| 227 <hr /> | |
| 228 </body></html> |
