diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.SqlBrowser.SqlBrowserWidget.html --- a/eric6/Documentation/Source/eric6.SqlBrowser.SqlBrowserWidget.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.SqlBrowser.SqlBrowserWidget.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,33 +18,43 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.SqlBrowser.SqlBrowserWidget</h1> + <p> Module implementing the SQL Browser widget. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#SqlBrowserWidget">SqlBrowserWidget</a></td> <td>Class implementing the SQL Browser widget.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="SqlBrowserWidget" ID="SqlBrowserWidget"></a> <h2>SqlBrowserWidget</h2> + <p> Class implementing the SQL Browser widget. -</p><h3>Signals</h3> +</p> +<h3>Signals</h3> <dl> + <dt>statusMessage(str)</dt> <dd> emitted to show a status message @@ -53,197 +63,267 @@ <h3>Derived from</h3> QWidget, Ui_SqlBrowserWidget <h3>Class Attributes</h3> + <table> <tr><td>cCount</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#SqlBrowserWidget.__init__">SqlBrowserWidget</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.__deleteRow">__deleteRow</a></td> <td>Private slot to delete a row from the database table.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.__insertRow">__insertRow</a></td> <td>Private slot to insert a row into the database table.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.addConnection">addConnection</a></td> <td>Public method to add a database connection.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.addConnectionByDialog">addConnectionByDialog</a></td> <td>Public slot to add a database connection via an input dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.executeQuery">executeQuery</a></td> <td>Public slot to execute the entered query.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.on_clearButton_clicked">on_clearButton_clicked</a></td> <td>Private slot to clear the SQL entry widget.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.on_connections_cleared">on_connections_cleared</a></td> <td>Private slot to clear the table.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.on_connections_schemaRequested">on_connections_schemaRequested</a></td> <td>Private slot to show the schema of a table.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.on_connections_tableActivated">on_connections_tableActivated</a></td> <td>Private slot to show the contents of a table.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.on_deleteRowAction_triggered">on_deleteRowAction_triggered</a></td> <td>Private slot handling the action to delete a row.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.on_executeButton_clicked">on_executeButton_clicked</a></td> <td>Private slot to execute the entered SQL query.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.on_insertRowAction_triggered">on_insertRowAction_triggered</a></td> <td>Private slot handling the action to insert a new row.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.showSchema">showSchema</a></td> <td>Public slot to show the schema of a table.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.showTable">showTable</a></td> <td>Public slot to show the contents of a table.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SqlBrowserWidget.updateActions">updateActions</a></td> <td>Public slot to update the actions.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="SqlBrowserWidget.__init__" ID="SqlBrowserWidget.__init__"></a> <h4>SqlBrowserWidget (Constructor)</h4> <b>SqlBrowserWidget</b>(<i>parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="SqlBrowserWidget.__deleteRow" ID="SqlBrowserWidget.__deleteRow"></a> +</dl> +<a NAME="SqlBrowserWidget.__deleteRow" ID="SqlBrowserWidget.__deleteRow"></a> <h4>SqlBrowserWidget.__deleteRow</h4> <b>__deleteRow</b>(<i></i>) + <p> Private slot to delete a row from the database table. -</p><a NAME="SqlBrowserWidget.__insertRow" ID="SqlBrowserWidget.__insertRow"></a> +</p> +<a NAME="SqlBrowserWidget.__insertRow" ID="SqlBrowserWidget.__insertRow"></a> <h4>SqlBrowserWidget.__insertRow</h4> <b>__insertRow</b>(<i></i>) + <p> Private slot to insert a row into the database table. -</p><a NAME="SqlBrowserWidget.addConnection" ID="SqlBrowserWidget.addConnection"></a> +</p> +<a NAME="SqlBrowserWidget.addConnection" ID="SqlBrowserWidget.addConnection"></a> <h4>SqlBrowserWidget.addConnection</h4> <b>addConnection</b>(<i>driver, dbName, user, password, host, port</i>) + <p> Public method to add a database connection. -</p><dl> +</p> +<dl> + <dt><i>driver</i></dt> <dd> name of the Qt database driver (string) -</dd><dt><i>dbName</i></dt> +</dd> +<dt><i>dbName</i></dt> <dd> name of the database (string) -</dd><dt><i>user</i></dt> +</dd> +<dt><i>user</i></dt> <dd> user name (string) -</dd><dt><i>password</i></dt> +</dd> +<dt><i>password</i></dt> <dd> password (string) -</dd><dt><i>host</i></dt> +</dd> +<dt><i>host</i></dt> <dd> host name (string) -</dd><dt><i>port</i></dt> +</dd> +<dt><i>port</i></dt> <dd> port number (integer) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> SQL error object (QSqlError) </dd> -</dl><a NAME="SqlBrowserWidget.addConnectionByDialog" ID="SqlBrowserWidget.addConnectionByDialog"></a> +</dl> +<a NAME="SqlBrowserWidget.addConnectionByDialog" ID="SqlBrowserWidget.addConnectionByDialog"></a> <h4>SqlBrowserWidget.addConnectionByDialog</h4> <b>addConnectionByDialog</b>(<i></i>) + <p> Public slot to add a database connection via an input dialog. -</p><a NAME="SqlBrowserWidget.executeQuery" ID="SqlBrowserWidget.executeQuery"></a> +</p> +<a NAME="SqlBrowserWidget.executeQuery" ID="SqlBrowserWidget.executeQuery"></a> <h4>SqlBrowserWidget.executeQuery</h4> <b>executeQuery</b>(<i></i>) + <p> Public slot to execute the entered query. -</p><a NAME="SqlBrowserWidget.on_clearButton_clicked" ID="SqlBrowserWidget.on_clearButton_clicked"></a> +</p> +<a NAME="SqlBrowserWidget.on_clearButton_clicked" ID="SqlBrowserWidget.on_clearButton_clicked"></a> <h4>SqlBrowserWidget.on_clearButton_clicked</h4> <b>on_clearButton_clicked</b>(<i></i>) + <p> Private slot to clear the SQL entry widget. -</p><a NAME="SqlBrowserWidget.on_connections_cleared" ID="SqlBrowserWidget.on_connections_cleared"></a> +</p> +<a NAME="SqlBrowserWidget.on_connections_cleared" ID="SqlBrowserWidget.on_connections_cleared"></a> <h4>SqlBrowserWidget.on_connections_cleared</h4> <b>on_connections_cleared</b>(<i></i>) + <p> Private slot to clear the table. -</p><a NAME="SqlBrowserWidget.on_connections_schemaRequested" ID="SqlBrowserWidget.on_connections_schemaRequested"></a> +</p> +<a NAME="SqlBrowserWidget.on_connections_schemaRequested" ID="SqlBrowserWidget.on_connections_schemaRequested"></a> <h4>SqlBrowserWidget.on_connections_schemaRequested</h4> <b>on_connections_schemaRequested</b>(<i>table</i>) + <p> Private slot to show the schema of a table. -</p><dl> +</p> +<dl> + <dt><i>table</i></dt> <dd> name of the table for which to show the schema (string) </dd> -</dl><a NAME="SqlBrowserWidget.on_connections_tableActivated" ID="SqlBrowserWidget.on_connections_tableActivated"></a> +</dl> +<a NAME="SqlBrowserWidget.on_connections_tableActivated" ID="SqlBrowserWidget.on_connections_tableActivated"></a> <h4>SqlBrowserWidget.on_connections_tableActivated</h4> <b>on_connections_tableActivated</b>(<i>table</i>) + <p> Private slot to show the contents of a table. -</p><dl> +</p> +<dl> + <dt><i>table</i></dt> <dd> name of the table for which to show the contents (string) </dd> -</dl><a NAME="SqlBrowserWidget.on_deleteRowAction_triggered" ID="SqlBrowserWidget.on_deleteRowAction_triggered"></a> +</dl> +<a NAME="SqlBrowserWidget.on_deleteRowAction_triggered" ID="SqlBrowserWidget.on_deleteRowAction_triggered"></a> <h4>SqlBrowserWidget.on_deleteRowAction_triggered</h4> <b>on_deleteRowAction_triggered</b>(<i></i>) + <p> Private slot handling the action to delete a row. -</p><a NAME="SqlBrowserWidget.on_executeButton_clicked" ID="SqlBrowserWidget.on_executeButton_clicked"></a> +</p> +<a NAME="SqlBrowserWidget.on_executeButton_clicked" ID="SqlBrowserWidget.on_executeButton_clicked"></a> <h4>SqlBrowserWidget.on_executeButton_clicked</h4> <b>on_executeButton_clicked</b>(<i></i>) + <p> Private slot to execute the entered SQL query. -</p><a NAME="SqlBrowserWidget.on_insertRowAction_triggered" ID="SqlBrowserWidget.on_insertRowAction_triggered"></a> +</p> +<a NAME="SqlBrowserWidget.on_insertRowAction_triggered" ID="SqlBrowserWidget.on_insertRowAction_triggered"></a> <h4>SqlBrowserWidget.on_insertRowAction_triggered</h4> <b>on_insertRowAction_triggered</b>(<i></i>) + <p> Private slot handling the action to insert a new row. -</p><a NAME="SqlBrowserWidget.showSchema" ID="SqlBrowserWidget.showSchema"></a> +</p> +<a NAME="SqlBrowserWidget.showSchema" ID="SqlBrowserWidget.showSchema"></a> <h4>SqlBrowserWidget.showSchema</h4> <b>showSchema</b>(<i>table</i>) + <p> Public slot to show the schema of a table. -</p><dl> +</p> +<dl> + <dt><i>table</i></dt> <dd> name of the table to be shown (string) </dd> -</dl><a NAME="SqlBrowserWidget.showTable" ID="SqlBrowserWidget.showTable"></a> +</dl> +<a NAME="SqlBrowserWidget.showTable" ID="SqlBrowserWidget.showTable"></a> <h4>SqlBrowserWidget.showTable</h4> <b>showTable</b>(<i>table</i>) + <p> Public slot to show the contents of a table. -</p><dl> +</p> +<dl> + <dt><i>table</i></dt> <dd> name of the table to be shown (string) </dd> -</dl><a NAME="SqlBrowserWidget.updateActions" ID="SqlBrowserWidget.updateActions"></a> +</dl> +<a NAME="SqlBrowserWidget.updateActions" ID="SqlBrowserWidget.updateActions"></a> <h4>SqlBrowserWidget.updateActions</h4> <b>updateActions</b>(<i></i>) + <p> Public slot to update the actions. </p>