src/eric7/Documentation/Source/eric7.SqlBrowser.SqlBrowserWidget.html

branch
eric7
changeset 10479
856476537696
parent 10431
64157aeb0312
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.SqlBrowser.SqlBrowserWidget</h1> 9 <h1>eric7.SqlBrowser.SqlBrowserWidget</h1>
10
11 <p> 10 <p>
12 Module implementing the SQL Browser widget. 11 Module implementing the SQL Browser widget.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#SqlBrowserWidget">SqlBrowserWidget</a></td> 22 <td><a href="#SqlBrowserWidget">SqlBrowserWidget</a></td>
25 <td>Class implementing the SQL Browser widget.</td> 23 <td>Class implementing the SQL Browser widget.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="SqlBrowserWidget" ID="SqlBrowserWidget"></a> 34 <a NAME="SqlBrowserWidget" ID="SqlBrowserWidget"></a>
36 <h2>SqlBrowserWidget</h2> 35 <h2>SqlBrowserWidget</h2>
37
38 <p> 36 <p>
39 Class implementing the SQL Browser widget. 37 Class implementing the SQL Browser widget.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>statusMessage(str)</dt> 43 <dt>statusMessage(str)</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 QWidget, Ui_SqlBrowserWidget 49 QWidget, Ui_SqlBrowserWidget
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52
53 <table> 51 <table>
54 <tr><td>cCount</td></tr> 52 <tr><td>cCount</td></tr>
55 </table> 53 </table>
54
56 <h3>Class Methods</h3> 55 <h3>Class Methods</h3>
57
58 <table> 56 <table>
59 <tr><td>None</td></tr> 57 <tr><td>None</td></tr>
60 </table> 58 </table>
59
61 <h3>Methods</h3> 60 <h3>Methods</h3>
62 61 <table>
63 <table>
64
65 <tr> 62 <tr>
66 <td><a href="#SqlBrowserWidget.__init__">SqlBrowserWidget</a></td> 63 <td><a href="#SqlBrowserWidget.__init__">SqlBrowserWidget</a></td>
67 <td>Constructor</td> 64 <td>Constructor</td>
68 </tr> 65 </tr>
69 <tr> 66 <tr>
125 <tr> 122 <tr>
126 <td><a href="#SqlBrowserWidget.updateActions">updateActions</a></td> 123 <td><a href="#SqlBrowserWidget.updateActions">updateActions</a></td>
127 <td>Public slot to update the actions.</td> 124 <td>Public slot to update the actions.</td>
128 </tr> 125 </tr>
129 </table> 126 </table>
127
130 <h3>Static Methods</h3> 128 <h3>Static Methods</h3>
131
132 <table> 129 <table>
133 <tr><td>None</td></tr> 130 <tr><td>None</td></tr>
134 </table> 131 </table>
132
135 133
136 <a NAME="SqlBrowserWidget.__init__" ID="SqlBrowserWidget.__init__"></a> 134 <a NAME="SqlBrowserWidget.__init__" ID="SqlBrowserWidget.__init__"></a>
137 <h4>SqlBrowserWidget (Constructor)</h4> 135 <h4>SqlBrowserWidget (Constructor)</h4>
138 <b>SqlBrowserWidget</b>(<i>parent=None</i>) 136 <b>SqlBrowserWidget</b>(<i>parent=None</i>)
139
140 <p> 137 <p>
141 Constructor 138 Constructor
142 </p> 139 </p>
140
143 <dl> 141 <dl>
144 142
145 <dt><i>parent</i> (QWidget)</dt> 143 <dt><i>parent</i> (QWidget)</dt>
146 <dd> 144 <dd>
147 reference to the parent widget 145 reference to the parent widget
148 </dd> 146 </dd>
149 </dl> 147 </dl>
150 <a NAME="SqlBrowserWidget.__deleteRow" ID="SqlBrowserWidget.__deleteRow"></a> 148 <a NAME="SqlBrowserWidget.__deleteRow" ID="SqlBrowserWidget.__deleteRow"></a>
151 <h4>SqlBrowserWidget.__deleteRow</h4> 149 <h4>SqlBrowserWidget.__deleteRow</h4>
152 <b>__deleteRow</b>(<i></i>) 150 <b>__deleteRow</b>(<i></i>)
153
154 <p> 151 <p>
155 Private slot to delete a row from the database table. 152 Private slot to delete a row from the database table.
156 </p> 153 </p>
154
157 <a NAME="SqlBrowserWidget.__insertRow" ID="SqlBrowserWidget.__insertRow"></a> 155 <a NAME="SqlBrowserWidget.__insertRow" ID="SqlBrowserWidget.__insertRow"></a>
158 <h4>SqlBrowserWidget.__insertRow</h4> 156 <h4>SqlBrowserWidget.__insertRow</h4>
159 <b>__insertRow</b>(<i></i>) 157 <b>__insertRow</b>(<i></i>)
160
161 <p> 158 <p>
162 Private slot to insert a row into the database table. 159 Private slot to insert a row into the database table.
163 </p> 160 </p>
161
164 <a NAME="SqlBrowserWidget.addConnection" ID="SqlBrowserWidget.addConnection"></a> 162 <a NAME="SqlBrowserWidget.addConnection" ID="SqlBrowserWidget.addConnection"></a>
165 <h4>SqlBrowserWidget.addConnection</h4> 163 <h4>SqlBrowserWidget.addConnection</h4>
166 <b>addConnection</b>(<i>driver, dbName, user, password, host, port</i>) 164 <b>addConnection</b>(<i>driver, dbName, user, password, host, port</i>)
167
168 <p> 165 <p>
169 Public method to add a database connection. 166 Public method to add a database connection.
170 </p> 167 </p>
168
171 <dl> 169 <dl>
172 170
173 <dt><i>driver</i> (str)</dt> 171 <dt><i>driver</i> (str)</dt>
174 <dd> 172 <dd>
175 name of the Qt database driver 173 name of the Qt database driver
208 </dd> 206 </dd>
209 </dl> 207 </dl>
210 <a NAME="SqlBrowserWidget.addConnectionByDialog" ID="SqlBrowserWidget.addConnectionByDialog"></a> 208 <a NAME="SqlBrowserWidget.addConnectionByDialog" ID="SqlBrowserWidget.addConnectionByDialog"></a>
211 <h4>SqlBrowserWidget.addConnectionByDialog</h4> 209 <h4>SqlBrowserWidget.addConnectionByDialog</h4>
212 <b>addConnectionByDialog</b>(<i></i>) 210 <b>addConnectionByDialog</b>(<i></i>)
213
214 <p> 211 <p>
215 Public slot to add a database connection via an input dialog. 212 Public slot to add a database connection via an input dialog.
216 </p> 213 </p>
214
217 <a NAME="SqlBrowserWidget.executeQuery" ID="SqlBrowserWidget.executeQuery"></a> 215 <a NAME="SqlBrowserWidget.executeQuery" ID="SqlBrowserWidget.executeQuery"></a>
218 <h4>SqlBrowserWidget.executeQuery</h4> 216 <h4>SqlBrowserWidget.executeQuery</h4>
219 <b>executeQuery</b>(<i></i>) 217 <b>executeQuery</b>(<i></i>)
220
221 <p> 218 <p>
222 Public slot to execute the entered query. 219 Public slot to execute the entered query.
223 </p> 220 </p>
221
224 <a NAME="SqlBrowserWidget.on_clearButton_clicked" ID="SqlBrowserWidget.on_clearButton_clicked"></a> 222 <a NAME="SqlBrowserWidget.on_clearButton_clicked" ID="SqlBrowserWidget.on_clearButton_clicked"></a>
225 <h4>SqlBrowserWidget.on_clearButton_clicked</h4> 223 <h4>SqlBrowserWidget.on_clearButton_clicked</h4>
226 <b>on_clearButton_clicked</b>(<i></i>) 224 <b>on_clearButton_clicked</b>(<i></i>)
227
228 <p> 225 <p>
229 Private slot to clear the SQL entry widget. 226 Private slot to clear the SQL entry widget.
230 </p> 227 </p>
228
231 <a NAME="SqlBrowserWidget.on_connections_cleared" ID="SqlBrowserWidget.on_connections_cleared"></a> 229 <a NAME="SqlBrowserWidget.on_connections_cleared" ID="SqlBrowserWidget.on_connections_cleared"></a>
232 <h4>SqlBrowserWidget.on_connections_cleared</h4> 230 <h4>SqlBrowserWidget.on_connections_cleared</h4>
233 <b>on_connections_cleared</b>(<i></i>) 231 <b>on_connections_cleared</b>(<i></i>)
234
235 <p> 232 <p>
236 Private slot to clear the table. 233 Private slot to clear the table.
237 </p> 234 </p>
235
238 <a NAME="SqlBrowserWidget.on_connections_schemaRequested" ID="SqlBrowserWidget.on_connections_schemaRequested"></a> 236 <a NAME="SqlBrowserWidget.on_connections_schemaRequested" ID="SqlBrowserWidget.on_connections_schemaRequested"></a>
239 <h4>SqlBrowserWidget.on_connections_schemaRequested</h4> 237 <h4>SqlBrowserWidget.on_connections_schemaRequested</h4>
240 <b>on_connections_schemaRequested</b>(<i>table</i>) 238 <b>on_connections_schemaRequested</b>(<i>table</i>)
241
242 <p> 239 <p>
243 Private slot to show the schema of a table. 240 Private slot to show the schema of a table.
244 </p> 241 </p>
242
245 <dl> 243 <dl>
246 244
247 <dt><i>table</i> (str)</dt> 245 <dt><i>table</i> (str)</dt>
248 <dd> 246 <dd>
249 name of the table for which to show the schema 247 name of the table for which to show the schema
250 </dd> 248 </dd>
251 </dl> 249 </dl>
252 <a NAME="SqlBrowserWidget.on_connections_tableActivated" ID="SqlBrowserWidget.on_connections_tableActivated"></a> 250 <a NAME="SqlBrowserWidget.on_connections_tableActivated" ID="SqlBrowserWidget.on_connections_tableActivated"></a>
253 <h4>SqlBrowserWidget.on_connections_tableActivated</h4> 251 <h4>SqlBrowserWidget.on_connections_tableActivated</h4>
254 <b>on_connections_tableActivated</b>(<i>table</i>) 252 <b>on_connections_tableActivated</b>(<i>table</i>)
255
256 <p> 253 <p>
257 Private slot to show the contents of a table. 254 Private slot to show the contents of a table.
258 </p> 255 </p>
256
259 <dl> 257 <dl>
260 258
261 <dt><i>table</i> (str)</dt> 259 <dt><i>table</i> (str)</dt>
262 <dd> 260 <dd>
263 name of the table for which to show the contents 261 name of the table for which to show the contents
264 </dd> 262 </dd>
265 </dl> 263 </dl>
266 <a NAME="SqlBrowserWidget.on_deleteRowAction_triggered" ID="SqlBrowserWidget.on_deleteRowAction_triggered"></a> 264 <a NAME="SqlBrowserWidget.on_deleteRowAction_triggered" ID="SqlBrowserWidget.on_deleteRowAction_triggered"></a>
267 <h4>SqlBrowserWidget.on_deleteRowAction_triggered</h4> 265 <h4>SqlBrowserWidget.on_deleteRowAction_triggered</h4>
268 <b>on_deleteRowAction_triggered</b>(<i></i>) 266 <b>on_deleteRowAction_triggered</b>(<i></i>)
269
270 <p> 267 <p>
271 Private slot handling the action to delete a row. 268 Private slot handling the action to delete a row.
272 </p> 269 </p>
270
273 <a NAME="SqlBrowserWidget.on_executeButton_clicked" ID="SqlBrowserWidget.on_executeButton_clicked"></a> 271 <a NAME="SqlBrowserWidget.on_executeButton_clicked" ID="SqlBrowserWidget.on_executeButton_clicked"></a>
274 <h4>SqlBrowserWidget.on_executeButton_clicked</h4> 272 <h4>SqlBrowserWidget.on_executeButton_clicked</h4>
275 <b>on_executeButton_clicked</b>(<i></i>) 273 <b>on_executeButton_clicked</b>(<i></i>)
276
277 <p> 274 <p>
278 Private slot to execute the entered SQL query. 275 Private slot to execute the entered SQL query.
279 </p> 276 </p>
277
280 <a NAME="SqlBrowserWidget.on_insertRowAction_triggered" ID="SqlBrowserWidget.on_insertRowAction_triggered"></a> 278 <a NAME="SqlBrowserWidget.on_insertRowAction_triggered" ID="SqlBrowserWidget.on_insertRowAction_triggered"></a>
281 <h4>SqlBrowserWidget.on_insertRowAction_triggered</h4> 279 <h4>SqlBrowserWidget.on_insertRowAction_triggered</h4>
282 <b>on_insertRowAction_triggered</b>(<i></i>) 280 <b>on_insertRowAction_triggered</b>(<i></i>)
283
284 <p> 281 <p>
285 Private slot handling the action to insert a new row. 282 Private slot handling the action to insert a new row.
286 </p> 283 </p>
284
287 <a NAME="SqlBrowserWidget.showSchema" ID="SqlBrowserWidget.showSchema"></a> 285 <a NAME="SqlBrowserWidget.showSchema" ID="SqlBrowserWidget.showSchema"></a>
288 <h4>SqlBrowserWidget.showSchema</h4> 286 <h4>SqlBrowserWidget.showSchema</h4>
289 <b>showSchema</b>(<i>table</i>) 287 <b>showSchema</b>(<i>table</i>)
290
291 <p> 288 <p>
292 Public slot to show the schema of a table. 289 Public slot to show the schema of a table.
293 </p> 290 </p>
291
294 <dl> 292 <dl>
295 293
296 <dt><i>table</i> (str)</dt> 294 <dt><i>table</i> (str)</dt>
297 <dd> 295 <dd>
298 name of the table to be shown 296 name of the table to be shown
299 </dd> 297 </dd>
300 </dl> 298 </dl>
301 <a NAME="SqlBrowserWidget.showTable" ID="SqlBrowserWidget.showTable"></a> 299 <a NAME="SqlBrowserWidget.showTable" ID="SqlBrowserWidget.showTable"></a>
302 <h4>SqlBrowserWidget.showTable</h4> 300 <h4>SqlBrowserWidget.showTable</h4>
303 <b>showTable</b>(<i>table</i>) 301 <b>showTable</b>(<i>table</i>)
304
305 <p> 302 <p>
306 Public slot to show the contents of a table. 303 Public slot to show the contents of a table.
307 </p> 304 </p>
305
308 <dl> 306 <dl>
309 307
310 <dt><i>table</i> (str)</dt> 308 <dt><i>table</i> (str)</dt>
311 <dd> 309 <dd>
312 name of the table to be shown 310 name of the table to be shown
313 </dd> 311 </dd>
314 </dl> 312 </dl>
315 <a NAME="SqlBrowserWidget.updateActions" ID="SqlBrowserWidget.updateActions"></a> 313 <a NAME="SqlBrowserWidget.updateActions" ID="SqlBrowserWidget.updateActions"></a>
316 <h4>SqlBrowserWidget.updateActions</h4> 314 <h4>SqlBrowserWidget.updateActions</h4>
317 <b>updateActions</b>(<i></i>) 315 <b>updateActions</b>(<i></i>)
318
319 <p> 316 <p>
320 Public slot to update the actions. 317 Public slot to update the actions.
321 </p> 318 </p>
319
322 <div align="right"><a href="#top">Up</a></div> 320 <div align="right"><a href="#top">Up</a></div>
323 <hr /> 321 <hr />
324 </body></html> 322 </body></html>

eric ide

mercurial