|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.SqlBrowser.SqlConnectionWidget</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.SqlBrowser.SqlConnectionWidget</h1> |
|
23 <p> |
|
24 Module implementing a widget showing the SQL connections. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#SqlConnectionWidget">SqlConnectionWidget</a></td> |
|
34 <td>Class implementing a widget showing the SQL connections.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="SqlConnectionWidget" ID="SqlConnectionWidget"></a> |
|
43 <h2>SqlConnectionWidget</h2> |
|
44 <p> |
|
45 Class implementing a widget showing the SQL connections. |
|
46 </p><h3>Signals</h3> |
|
47 <dl> |
|
48 <dt>cleared()</dt> |
|
49 <dd> |
|
50 emitted after the connection tree has been cleared |
|
51 </dd><dt>schemaRequested(str)</dt> |
|
52 <dd> |
|
53 emitted when the schema display is requested |
|
54 </dd><dt>tableActivated(str)</dt> |
|
55 <dd> |
|
56 emitted after the entry for a table has been |
|
57 activated |
|
58 </dd> |
|
59 </dl> |
|
60 <h3>Derived from</h3> |
|
61 QWidget |
|
62 <h3>Class Attributes</h3> |
|
63 <table> |
|
64 <tr><td>None</td></tr> |
|
65 </table> |
|
66 <h3>Class Methods</h3> |
|
67 <table> |
|
68 <tr><td>None</td></tr> |
|
69 </table> |
|
70 <h3>Methods</h3> |
|
71 <table> |
|
72 <tr> |
|
73 <td><a href="#SqlConnectionWidget.__init__">SqlConnectionWidget</a></td> |
|
74 <td>Constructor</td> |
|
75 </tr><tr> |
|
76 <td><a href="#SqlConnectionWidget.__currentItemChanged">__currentItemChanged</a></td> |
|
77 <td>Private slot handling a change of the current item.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#SqlConnectionWidget.__dbCaption">__dbCaption</a></td> |
|
80 <td>Private method to assemble a string for the caption.</td> |
|
81 </tr><tr> |
|
82 <td><a href="#SqlConnectionWidget.__itemActivated">__itemActivated</a></td> |
|
83 <td>Private slot handling the activation of an item.</td> |
|
84 </tr><tr> |
|
85 <td><a href="#SqlConnectionWidget.__setActive">__setActive</a></td> |
|
86 <td>Private slot to set an item to active.</td> |
|
87 </tr><tr> |
|
88 <td><a href="#SqlConnectionWidget.__setBold">__setBold</a></td> |
|
89 <td>Private slot to set the font to bold.</td> |
|
90 </tr><tr> |
|
91 <td><a href="#SqlConnectionWidget.currentDatabase">currentDatabase</a></td> |
|
92 <td>Public method to get the current database.</td> |
|
93 </tr><tr> |
|
94 <td><a href="#SqlConnectionWidget.refresh">refresh</a></td> |
|
95 <td>Public slot to refresh the connection tree.</td> |
|
96 </tr><tr> |
|
97 <td><a href="#SqlConnectionWidget.showSchema">showSchema</a></td> |
|
98 <td>Public slot to show schema data of a database.</td> |
|
99 </tr> |
|
100 </table> |
|
101 <h3>Static Methods</h3> |
|
102 <table> |
|
103 <tr><td>None</td></tr> |
|
104 </table> |
|
105 <a NAME="SqlConnectionWidget.__init__" ID="SqlConnectionWidget.__init__"></a> |
|
106 <h4>SqlConnectionWidget (Constructor)</h4> |
|
107 <b>SqlConnectionWidget</b>(<i>parent=None</i>) |
|
108 <p> |
|
109 Constructor |
|
110 </p><dl> |
|
111 <dt><i>parent</i></dt> |
|
112 <dd> |
|
113 reference to the parent widget (QWidget) |
|
114 </dd> |
|
115 </dl><a NAME="SqlConnectionWidget.__currentItemChanged" ID="SqlConnectionWidget.__currentItemChanged"></a> |
|
116 <h4>SqlConnectionWidget.__currentItemChanged</h4> |
|
117 <b>__currentItemChanged</b>(<i>current, previous</i>) |
|
118 <p> |
|
119 Private slot handling a change of the current item. |
|
120 </p><dl> |
|
121 <dt><i>current</i></dt> |
|
122 <dd> |
|
123 reference to the new current item (QTreeWidgetItem) |
|
124 </dd><dt><i>previous</i></dt> |
|
125 <dd> |
|
126 reference to the previous current item |
|
127 (QTreeWidgetItem) |
|
128 </dd> |
|
129 </dl><a NAME="SqlConnectionWidget.__dbCaption" ID="SqlConnectionWidget.__dbCaption"></a> |
|
130 <h4>SqlConnectionWidget.__dbCaption</h4> |
|
131 <b>__dbCaption</b>(<i>db</i>) |
|
132 <p> |
|
133 Private method to assemble a string for the caption. |
|
134 </p><dl> |
|
135 <dt><i>db</i></dt> |
|
136 <dd> |
|
137 reference to the database object (QSqlDatabase) |
|
138 </dd> |
|
139 </dl><dl> |
|
140 <dt>Returns:</dt> |
|
141 <dd> |
|
142 caption string (string) |
|
143 </dd> |
|
144 </dl><a NAME="SqlConnectionWidget.__itemActivated" ID="SqlConnectionWidget.__itemActivated"></a> |
|
145 <h4>SqlConnectionWidget.__itemActivated</h4> |
|
146 <b>__itemActivated</b>(<i>itm, column</i>) |
|
147 <p> |
|
148 Private slot handling the activation of an item. |
|
149 </p><dl> |
|
150 <dt><i>itm</i></dt> |
|
151 <dd> |
|
152 reference to the item (QTreeWidgetItem) |
|
153 </dd><dt><i>column</i></dt> |
|
154 <dd> |
|
155 column that was activated (integer) |
|
156 </dd> |
|
157 </dl><a NAME="SqlConnectionWidget.__setActive" ID="SqlConnectionWidget.__setActive"></a> |
|
158 <h4>SqlConnectionWidget.__setActive</h4> |
|
159 <b>__setActive</b>(<i>itm</i>) |
|
160 <p> |
|
161 Private slot to set an item to active. |
|
162 </p><dl> |
|
163 <dt><i>itm</i></dt> |
|
164 <dd> |
|
165 reference to the item to set as the active item |
|
166 (QTreeWidgetItem) |
|
167 </dd> |
|
168 </dl><a NAME="SqlConnectionWidget.__setBold" ID="SqlConnectionWidget.__setBold"></a> |
|
169 <h4>SqlConnectionWidget.__setBold</h4> |
|
170 <b>__setBold</b>(<i>itm, bold</i>) |
|
171 <p> |
|
172 Private slot to set the font to bold. |
|
173 </p><dl> |
|
174 <dt><i>itm</i></dt> |
|
175 <dd> |
|
176 reference to the item to be changed (QTreeWidgetItem) |
|
177 </dd><dt><i>bold</i></dt> |
|
178 <dd> |
|
179 flag indicating bold (boolean) |
|
180 </dd> |
|
181 </dl><a NAME="SqlConnectionWidget.currentDatabase" ID="SqlConnectionWidget.currentDatabase"></a> |
|
182 <h4>SqlConnectionWidget.currentDatabase</h4> |
|
183 <b>currentDatabase</b>(<i></i>) |
|
184 <p> |
|
185 Public method to get the current database. |
|
186 </p><dl> |
|
187 <dt>Returns:</dt> |
|
188 <dd> |
|
189 reference to the current database (QSqlDatabase) |
|
190 </dd> |
|
191 </dl><a NAME="SqlConnectionWidget.refresh" ID="SqlConnectionWidget.refresh"></a> |
|
192 <h4>SqlConnectionWidget.refresh</h4> |
|
193 <b>refresh</b>(<i></i>) |
|
194 <p> |
|
195 Public slot to refresh the connection tree. |
|
196 </p><a NAME="SqlConnectionWidget.showSchema" ID="SqlConnectionWidget.showSchema"></a> |
|
197 <h4>SqlConnectionWidget.showSchema</h4> |
|
198 <b>showSchema</b>(<i></i>) |
|
199 <p> |
|
200 Public slot to show schema data of a database. |
|
201 </p> |
|
202 <div align="right"><a href="#top">Up</a></div> |
|
203 <hr /> |
|
204 </body></html> |