eric7/Documentation/Source/eric7.SqlBrowser.SqlConnectionWidget.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.SqlBrowser.SqlConnectionWidget</h1>
24
25 <p>
26 Module implementing a widget showing the SQL connections.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#SqlConnectionWidget">SqlConnectionWidget</a></td>
39 <td>Class implementing a widget showing the SQL connections.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="SqlConnectionWidget" ID="SqlConnectionWidget"></a>
50 <h2>SqlConnectionWidget</h2>
51
52 <p>
53 Class implementing a widget showing the SQL connections.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>cleared()</dt>
59 <dd>
60 emitted after the connection tree has been cleared
61 </dd>
62 <dt>schemaRequested(str)</dt>
63 <dd>
64 emitted when the schema display is requested
65 </dd>
66 <dt>tableActivated(str)</dt>
67 <dd>
68 emitted after the entry for a table has been
69 activated
70 </dd>
71 </dl>
72 <h3>Derived from</h3>
73 QWidget
74 <h3>Class Attributes</h3>
75
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79 <h3>Class Methods</h3>
80
81 <table>
82 <tr><td>None</td></tr>
83 </table>
84 <h3>Methods</h3>
85
86 <table>
87
88 <tr>
89 <td><a href="#SqlConnectionWidget.__init__">SqlConnectionWidget</a></td>
90 <td>Constructor</td>
91 </tr>
92 <tr>
93 <td><a href="#SqlConnectionWidget.__currentItemChanged">__currentItemChanged</a></td>
94 <td>Private slot handling a change of the current item.</td>
95 </tr>
96 <tr>
97 <td><a href="#SqlConnectionWidget.__dbCaption">__dbCaption</a></td>
98 <td>Private method to assemble a string for the caption.</td>
99 </tr>
100 <tr>
101 <td><a href="#SqlConnectionWidget.__itemActivated">__itemActivated</a></td>
102 <td>Private slot handling the activation of an item.</td>
103 </tr>
104 <tr>
105 <td><a href="#SqlConnectionWidget.__setActive">__setActive</a></td>
106 <td>Private slot to set an item to active.</td>
107 </tr>
108 <tr>
109 <td><a href="#SqlConnectionWidget.__setBold">__setBold</a></td>
110 <td>Private slot to set the font to bold.</td>
111 </tr>
112 <tr>
113 <td><a href="#SqlConnectionWidget.currentDatabase">currentDatabase</a></td>
114 <td>Public method to get the current database.</td>
115 </tr>
116 <tr>
117 <td><a href="#SqlConnectionWidget.refresh">refresh</a></td>
118 <td>Public slot to refresh the connection tree.</td>
119 </tr>
120 <tr>
121 <td><a href="#SqlConnectionWidget.showSchema">showSchema</a></td>
122 <td>Public slot to show schema data of a database.</td>
123 </tr>
124 </table>
125 <h3>Static Methods</h3>
126
127 <table>
128 <tr><td>None</td></tr>
129 </table>
130
131 <a NAME="SqlConnectionWidget.__init__" ID="SqlConnectionWidget.__init__"></a>
132 <h4>SqlConnectionWidget (Constructor)</h4>
133 <b>SqlConnectionWidget</b>(<i>parent=None</i>)
134
135 <p>
136 Constructor
137 </p>
138 <dl>
139
140 <dt><i>parent</i></dt>
141 <dd>
142 reference to the parent widget (QWidget)
143 </dd>
144 </dl>
145 <a NAME="SqlConnectionWidget.__currentItemChanged" ID="SqlConnectionWidget.__currentItemChanged"></a>
146 <h4>SqlConnectionWidget.__currentItemChanged</h4>
147 <b>__currentItemChanged</b>(<i>current, previous</i>)
148
149 <p>
150 Private slot handling a change of the current item.
151 </p>
152 <dl>
153
154 <dt><i>current</i></dt>
155 <dd>
156 reference to the new current item (QTreeWidgetItem)
157 </dd>
158 <dt><i>previous</i></dt>
159 <dd>
160 reference to the previous current item
161 (QTreeWidgetItem)
162 </dd>
163 </dl>
164 <a NAME="SqlConnectionWidget.__dbCaption" ID="SqlConnectionWidget.__dbCaption"></a>
165 <h4>SqlConnectionWidget.__dbCaption</h4>
166 <b>__dbCaption</b>(<i>db</i>)
167
168 <p>
169 Private method to assemble a string for the caption.
170 </p>
171 <dl>
172
173 <dt><i>db</i></dt>
174 <dd>
175 reference to the database object (QSqlDatabase)
176 </dd>
177 </dl>
178 <dl>
179 <dt>Return:</dt>
180 <dd>
181 caption string (string)
182 </dd>
183 </dl>
184 <a NAME="SqlConnectionWidget.__itemActivated" ID="SqlConnectionWidget.__itemActivated"></a>
185 <h4>SqlConnectionWidget.__itemActivated</h4>
186 <b>__itemActivated</b>(<i>itm, column</i>)
187
188 <p>
189 Private slot handling the activation of an item.
190 </p>
191 <dl>
192
193 <dt><i>itm</i></dt>
194 <dd>
195 reference to the item (QTreeWidgetItem)
196 </dd>
197 <dt><i>column</i></dt>
198 <dd>
199 column that was activated (integer)
200 </dd>
201 </dl>
202 <a NAME="SqlConnectionWidget.__setActive" ID="SqlConnectionWidget.__setActive"></a>
203 <h4>SqlConnectionWidget.__setActive</h4>
204 <b>__setActive</b>(<i>itm</i>)
205
206 <p>
207 Private slot to set an item to active.
208 </p>
209 <dl>
210
211 <dt><i>itm</i></dt>
212 <dd>
213 reference to the item to set as the active item
214 (QTreeWidgetItem)
215 </dd>
216 </dl>
217 <a NAME="SqlConnectionWidget.__setBold" ID="SqlConnectionWidget.__setBold"></a>
218 <h4>SqlConnectionWidget.__setBold</h4>
219 <b>__setBold</b>(<i>itm, bold</i>)
220
221 <p>
222 Private slot to set the font to bold.
223 </p>
224 <dl>
225
226 <dt><i>itm</i></dt>
227 <dd>
228 reference to the item to be changed (QTreeWidgetItem)
229 </dd>
230 <dt><i>bold</i></dt>
231 <dd>
232 flag indicating bold (boolean)
233 </dd>
234 </dl>
235 <a NAME="SqlConnectionWidget.currentDatabase" ID="SqlConnectionWidget.currentDatabase"></a>
236 <h4>SqlConnectionWidget.currentDatabase</h4>
237 <b>currentDatabase</b>(<i></i>)
238
239 <p>
240 Public method to get the current database.
241 </p>
242 <dl>
243 <dt>Return:</dt>
244 <dd>
245 reference to the current database (QSqlDatabase)
246 </dd>
247 </dl>
248 <a NAME="SqlConnectionWidget.refresh" ID="SqlConnectionWidget.refresh"></a>
249 <h4>SqlConnectionWidget.refresh</h4>
250 <b>refresh</b>(<i></i>)
251
252 <p>
253 Public slot to refresh the connection tree.
254 </p>
255 <a NAME="SqlConnectionWidget.showSchema" ID="SqlConnectionWidget.showSchema"></a>
256 <h4>SqlConnectionWidget.showSchema</h4>
257 <b>showSchema</b>(<i></i>)
258
259 <p>
260 Public slot to show schema data of a database.
261 </p>
262 <div align="right"><a href="#top">Up</a></div>
263 <hr />
264 </body></html>

eric ide

mercurial