eric6/Documentation/Source/eric6.SqlBrowser.SqlConnectionWidget.html

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

eric ide

mercurial