Documentation/Source/eric5.SqlBrowser.SqlConnectionWidget.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.SqlBrowser.SqlConnectionWidget.html
--- a/Documentation/Source/eric5.SqlBrowser.SqlConnectionWidget.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.SqlBrowser.SqlConnectionWidget.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.SqlBrowser.SqlConnectionWidget</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#100;&#103;&#101;&#116; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#83;&#81;&#76; &#99;&#111;&#110;&#110;&#101;&#99;&#116;&#105;&#111;&#110;&#115;.
+Module implementing a widget showing the SQL connections.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#SqlConnectionWidget">SqlConnectionWidget</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#100;&#103;&#101;&#116; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#83;&#81;&#76; &#99;&#111;&#110;&#110;&#101;&#99;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Class implementing a widget showing the SQL connections.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,18 +43,18 @@
 <a NAME="SqlConnectionWidget" ID="SqlConnectionWidget"></a>
 <h2>SqlConnectionWidget</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#100;&#103;&#101;&#116; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#83;&#81;&#76; &#99;&#111;&#110;&#110;&#101;&#99;&#116;&#105;&#111;&#110;&#115;.
+    Class implementing a widget showing the SQL connections.
 </p><h4>Signals</h4>
 <dl>
 <dt>cleared()</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100; &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#99;&#111;&#110;&#110;&#101;&#99;&#116;&#105;&#111;&#110; &#116;&#114;&#101;&#101; &#104;&#97;&#115; &#98;&#101;&#101;&#110; &#99;&#108;&#101;&#97;&#114;&#101;&#100;
+emitted after the connection tree has been cleared
 </dd><dt>schemaRequested(QString)</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#115;&#99;&#104;&#101;&#109;&#97; &#100;&#105;&#115;&#112;&#108;&#97;y &#105;&#115; &#114;&#101;&#113;&#117;&#101;&#115;&#116;&#101;&#100;
+emitted when the schema display is requested
 </dd><dt>tableActivated(QString)</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100; &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#101;&#110;&#116;&#114;y &#102;&#111;&#114; &#97; &#116;&#97;&#98;&#108;&#101; &#104;&#97;&#115; &#98;&#101;&#101;&#110; &#97;&#99;&#116;&#105;v&#97;&#116;&#101;&#100;
+emitted after the entry for a table has been activated
 </dd>
 </dl>
 <h3>Derived from</h3>
@@ -67,127 +67,127 @@
 <table>
 <tr>
 <td><a href="#SqlConnectionWidget.__init__">SqlConnectionWidget</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#SqlConnectionWidget.__currentItemChanged">__currentItemChanged</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#110;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#105;&#116;&#101;&#109;.</td>
+<td>Private slot handling a change of the current item.</td>
 </tr><tr>
 <td><a href="#SqlConnectionWidget.__dbCaption">__dbCaption</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#115;&#115;&#101;&#109;&#98;&#108;&#101; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#97;&#112;&#116;&#105;&#111;&#110;.</td>
+<td>Private method to assemble a string for the caption.</td>
 </tr><tr>
 <td><a href="#SqlConnectionWidget.__itemActivated">__itemActivated</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#99;&#116;&#105;v&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#97;&#110; &#105;&#116;&#101;&#109;.</td>
+<td>Private slot handling the activation of an item.</td>
 </tr><tr>
 <td><a href="#SqlConnectionWidget.__setActive">__setActive</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#97;&#110; &#105;&#116;&#101;&#109; &#116;&#111; &#97;&#99;&#116;&#105;v&#101;.</td>
+<td>Private slot to set an item to active.</td>
 </tr><tr>
 <td><a href="#SqlConnectionWidget.__setBold">__setBold</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#102;&#111;&#110;&#116; &#116;&#111; &#98;&#111;&#108;&#100;.</td>
+<td>Private slot to set the font to bold.</td>
 </tr><tr>
 <td><a href="#SqlConnectionWidget.currentDatabase">currentDatabase</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.</td>
+<td>Public method to get the current database.</td>
 </tr><tr>
 <td><a href="#SqlConnectionWidget.refresh">refresh</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#102;&#114;&#101;&#115;&#104; &#116;&#104;&#101; &#99;&#111;&#110;&#110;&#101;&#99;&#116;&#105;&#111;&#110; &#116;&#114;&#101;&#101;.</td>
+<td>Public slot to refresh the connection tree.</td>
 </tr><tr>
 <td><a href="#SqlConnectionWidget.showSchema">showSchema</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#115;&#99;&#104;&#101;&#109;&#97; &#100;&#97;&#116;&#97; &#111;&#102; &#97; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.</td>
+<td>Public slot to show schema data of a database.</td>
 </tr>
 </table>
 <a NAME="SqlConnectionWidget.__init__" ID="SqlConnectionWidget.__init__"></a>
 <h4>SqlConnectionWidget (Constructor)</h4>
 <b>SqlConnectionWidget</b>(<i>parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to the parent widget (QWidget)
 </dd>
 </dl><a NAME="SqlConnectionWidget.__currentItemChanged" ID="SqlConnectionWidget.__currentItemChanged"></a>
 <h4>SqlConnectionWidget.__currentItemChanged</h4>
 <b>__currentItemChanged</b>(<i>current, previous</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#110;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#105;&#116;&#101;&#109;.
+        Private slot handling a change of the current item.
 </p><dl>
 <dt><i>current</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#110;&#101;w &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#105;&#116;&#101;&#109; (&#81;&#84;&#114;&#101;&#101;&#87;&#105;&#100;&#103;&#101;&#116;&#73;&#116;&#101;&#109;)
+reference to the new current item (QTreeWidgetItem)
 </dd><dt><i>previous</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#101;v&#105;&#111;&#117;&#115; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#105;&#116;&#101;&#109; (&#81;&#84;&#114;&#101;&#101;&#87;&#105;&#100;&#103;&#101;&#116;&#73;&#116;&#101;&#109;)
+reference to the previous current item (QTreeWidgetItem)
 </dd>
 </dl><a NAME="SqlConnectionWidget.__dbCaption" ID="SqlConnectionWidget.__dbCaption"></a>
 <h4>SqlConnectionWidget.__dbCaption</h4>
 <b>__dbCaption</b>(<i>db</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#115;&#115;&#101;&#109;&#98;&#108;&#101; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#97;&#112;&#116;&#105;&#111;&#110;.
+        Private method to assemble a string for the caption.
 </p><dl>
 <dt><i>db</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#83;&#113;&#108;&#68;&#97;&#116;&#97;&#98;&#97;&#115;&#101;)
+reference to the database object (QSqlDatabase)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#99;&#97;&#112;&#116;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;)
+caption string (string)
 </dd>
 </dl><a NAME="SqlConnectionWidget.__itemActivated" ID="SqlConnectionWidget.__itemActivated"></a>
 <h4>SqlConnectionWidget.__itemActivated</h4>
 <b>__itemActivated</b>(<i>itm, column</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#99;&#116;&#105;v&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#97;&#110; &#105;&#116;&#101;&#109;.
+        Private slot handling the activation of an item.
 </p><dl>
 <dt><i>itm</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#105;&#116;&#101;&#109; (&#81;&#84;&#114;&#101;&#101;&#87;&#105;&#100;&#103;&#101;&#116;&#73;&#116;&#101;&#109;)
+reference to the item (QTreeWidgetItem)
 </dd><dt><i>column</i></dt>
 <dd>
-&#99;&#111;&#108;&#117;&#109;&#110; &#116;&#104;&#97;&#116; w&#97;&#115; &#97;&#99;&#116;&#105;v&#97;&#116;&#101;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+column that was activated (integer)
 </dd>
 </dl><a NAME="SqlConnectionWidget.__setActive" ID="SqlConnectionWidget.__setActive"></a>
 <h4>SqlConnectionWidget.__setActive</h4>
 <b>__setActive</b>(<i>itm</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#97;&#110; &#105;&#116;&#101;&#109; &#116;&#111; &#97;&#99;&#116;&#105;v&#101;.
+        Private slot to set an item to active.
 </p><dl>
 <dt><i>itm</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#105;&#116;&#101;&#109; &#116;&#111; &#115;&#101;&#116; &#97;&#115; &#116;&#104;&#101; &#97;&#99;&#116;&#105;v&#101; &#105;&#116;&#101;&#109; (&#81;&#84;&#114;&#101;&#101;&#87;&#105;&#100;&#103;&#101;&#116;&#73;&#116;&#101;&#109;)
+reference to the item to set as the active item (QTreeWidgetItem)
 </dd>
 </dl><a NAME="SqlConnectionWidget.__setBold" ID="SqlConnectionWidget.__setBold"></a>
 <h4>SqlConnectionWidget.__setBold</h4>
 <b>__setBold</b>(<i>itm, bold</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#102;&#111;&#110;&#116; &#116;&#111; &#98;&#111;&#108;&#100;.
+        Private slot to set the font to bold.
 </p><dl>
 <dt><i>itm</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#105;&#116;&#101;&#109; &#116;&#111; &#98;&#101; &#99;&#104;&#97;&#110;&#103;&#101;&#100; (&#81;&#84;&#114;&#101;&#101;&#87;&#105;&#100;&#103;&#101;&#116;&#73;&#116;&#101;&#109;)
+reference to the item to be changed (QTreeWidgetItem)
 </dd><dt><i>bold</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#98;&#111;&#108;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating bold (boolean)
 </dd>
 </dl><a NAME="SqlConnectionWidget.currentDatabase" ID="SqlConnectionWidget.currentDatabase"></a>
 <h4>SqlConnectionWidget.currentDatabase</h4>
 <b>currentDatabase</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.
+        Public method to get the current database.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101; (&#81;&#83;&#113;&#108;&#68;&#97;&#116;&#97;&#98;&#97;&#115;&#101;)
+reference to the current database (QSqlDatabase)
 </dd>
 </dl><a NAME="SqlConnectionWidget.refresh" ID="SqlConnectionWidget.refresh"></a>
 <h4>SqlConnectionWidget.refresh</h4>
 <b>refresh</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#102;&#114;&#101;&#115;&#104; &#116;&#104;&#101; &#99;&#111;&#110;&#110;&#101;&#99;&#116;&#105;&#111;&#110; &#116;&#114;&#101;&#101;.
+        Public slot to refresh the connection tree.
 </p><a NAME="SqlConnectionWidget.showSchema" ID="SqlConnectionWidget.showSchema"></a>
 <h4>SqlConnectionWidget.showSchema</h4>
 <b>showSchema</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#115;&#99;&#104;&#101;&#109;&#97; &#100;&#97;&#116;&#97; &#111;&#102; &#97; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.
+        Public slot to show schema data of a database.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial