ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcNetworkListDialog.html

changeset 3
51c2c37bde76
equal deleted inserted replaced
2:5b635dc8895f 3:51c2c37bde76
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkListDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkListDialog</h1>
10 <p>
11 Module implementing a dialog to list the configured IRC networks.
12 </p>
13
14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>None</td></tr>
17 </table>
18
19 <h3>Classes</h3>
20 <table>
21 <tr>
22 <td><a href="#IrcNetworkListDialog">IrcNetworkListDialog</a></td>
23 <td>Class implementing a dialog to list the configured IRC networks.</td>
24 </tr>
25 </table>
26
27 <h3>Functions</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31
32 <hr />
33 <hr />
34 <a NAME="IrcNetworkListDialog" ID="IrcNetworkListDialog"></a>
35 <h2>IrcNetworkListDialog</h2>
36 <p>
37 Class implementing a dialog to list the configured IRC networks.
38 </p>
39
40 <h3>Derived from</h3>
41 QDialog, Ui_IrcNetworkListDialog
42 <h3>Class Attributes</h3>
43 <table>
44 <tr><td>None</td></tr>
45 </table>
46
47 <h3>Class Methods</h3>
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51
52 <h3>Methods</h3>
53 <table>
54 <tr>
55 <td><a href="#IrcNetworkListDialog.__init__">IrcNetworkListDialog</a></td>
56 <td>Constructor</td>
57 </tr>
58 <tr>
59 <td><a href="#IrcNetworkListDialog.__checkButtons">__checkButtons</a></td>
60 <td>Private slot to set the enabled state of the buttons.</td>
61 </tr>
62 <tr>
63 <td><a href="#IrcNetworkListDialog.__refreshNetworkEntry">__refreshNetworkEntry</a></td>
64 <td>Private method to (re-)set the data of a network entry.</td>
65 </tr>
66 <tr>
67 <td><a href="#IrcNetworkListDialog.__refreshNetworksList">__refreshNetworksList</a></td>
68 <td>Private method to refresh the complete networks list.</td>
69 </tr>
70 <tr>
71 <td><a href="#IrcNetworkListDialog.__resizeColumns">__resizeColumns</a></td>
72 <td>Private slot to resize all columns to their contents.</td>
73 </tr>
74 <tr>
75 <td><a href="#IrcNetworkListDialog.__setAutoConnectEntry">__setAutoConnectEntry</a></td>
76 <td>Private method to set the auto-connect entry of a network item.</td>
77 </tr>
78 <tr>
79 <td><a href="#IrcNetworkListDialog.on_autoConnectButton_clicked">on_autoConnectButton_clicked</a></td>
80 <td>Private slot handling the auto-connect selection.</td>
81 </tr>
82 <tr>
83 <td><a href="#IrcNetworkListDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
84 <td>Private slot to delete the selected entry.</td>
85 </tr>
86 <tr>
87 <td><a href="#IrcNetworkListDialog.on_editButton_clicked">on_editButton_clicked</a></td>
88 <td>Private slot to edit the selected network.</td>
89 </tr>
90 <tr>
91 <td><a href="#IrcNetworkListDialog.on_editIdentitiesButton_clicked">on_editIdentitiesButton_clicked</a></td>
92 <td>Private slot to edit the identities.</td>
93 </tr>
94 <tr>
95 <td><a href="#IrcNetworkListDialog.on_networksList_itemCollapsed">on_networksList_itemCollapsed</a></td>
96 <td>Private slot handling the collapse of a top level item.</td>
97 </tr>
98 <tr>
99 <td><a href="#IrcNetworkListDialog.on_networksList_itemExpanded">on_networksList_itemExpanded</a></td>
100 <td>Private slot handling the expansion of a top level item.</td>
101 </tr>
102 <tr>
103 <td><a href="#IrcNetworkListDialog.on_networksList_itemSelectionChanged">on_networksList_itemSelectionChanged</a></td>
104 <td>Private slot to handle changes of the selection of networks.</td>
105 </tr>
106 <tr>
107 <td><a href="#IrcNetworkListDialog.on_newButton_clicked">on_newButton_clicked</a></td>
108 <td>Private slot to add a new network entry.</td>
109 </tr>
110 </table>
111
112 <h3>Static Methods</h3>
113 <table>
114 <tr><td>None</td></tr>
115 </table>
116
117
118 <a NAME="IrcNetworkListDialog.__init__" ID="IrcNetworkListDialog.__init__"></a>
119 <h4>IrcNetworkListDialog (Constructor)</h4>
120 <b>IrcNetworkListDialog</b>(<i>manager, parent=None</i>)
121 <p>
122 Constructor
123 </p>
124
125 <dl>
126
127 <dt><i>manager</i> (IrcNetworkManager)</dt>
128 <dd>
129 reference to the IRC network manager
130 </dd>
131 <dt><i>parent</i> (QWidget)</dt>
132 <dd>
133 reference to the parent widget
134 </dd>
135 </dl>
136 <a NAME="IrcNetworkListDialog.__checkButtons" ID="IrcNetworkListDialog.__checkButtons"></a>
137 <h4>IrcNetworkListDialog.__checkButtons</h4>
138 <b>__checkButtons</b>(<i></i>)
139 <p>
140 Private slot to set the enabled state of the buttons.
141 </p>
142
143 <a NAME="IrcNetworkListDialog.__refreshNetworkEntry" ID="IrcNetworkListDialog.__refreshNetworkEntry"></a>
144 <h4>IrcNetworkListDialog.__refreshNetworkEntry</h4>
145 <b>__refreshNetworkEntry</b>(<i>itm</i>)
146 <p>
147 Private method to (re-)set the data of a network entry.
148 </p>
149
150 <dl>
151
152 <dt><i>itm</i> (QTreeWidgetItem)</dt>
153 <dd>
154 reference to the network entry
155 </dd>
156 </dl>
157 <a NAME="IrcNetworkListDialog.__refreshNetworksList" ID="IrcNetworkListDialog.__refreshNetworksList"></a>
158 <h4>IrcNetworkListDialog.__refreshNetworksList</h4>
159 <b>__refreshNetworksList</b>(<i></i>)
160 <p>
161 Private method to refresh the complete networks list.
162 </p>
163
164 <a NAME="IrcNetworkListDialog.__resizeColumns" ID="IrcNetworkListDialog.__resizeColumns"></a>
165 <h4>IrcNetworkListDialog.__resizeColumns</h4>
166 <b>__resizeColumns</b>(<i></i>)
167 <p>
168 Private slot to resize all columns to their contents.
169 </p>
170
171 <a NAME="IrcNetworkListDialog.__setAutoConnectEntry" ID="IrcNetworkListDialog.__setAutoConnectEntry"></a>
172 <h4>IrcNetworkListDialog.__setAutoConnectEntry</h4>
173 <b>__setAutoConnectEntry</b>(<i>itm, on</i>)
174 <p>
175 Private method to set the auto-connect entry of a network item.
176 </p>
177
178 <dl>
179
180 <dt><i>itm</i> (QTreeWidgetItem)</dt>
181 <dd>
182 reference to the network item
183 </dd>
184 <dt><i>on</i> (bool)</dt>
185 <dd>
186 flag indicating the auto-connect state
187 </dd>
188 </dl>
189 <a NAME="IrcNetworkListDialog.on_autoConnectButton_clicked" ID="IrcNetworkListDialog.on_autoConnectButton_clicked"></a>
190 <h4>IrcNetworkListDialog.on_autoConnectButton_clicked</h4>
191 <b>on_autoConnectButton_clicked</b>(<i>checked</i>)
192 <p>
193 Private slot handling the auto-connect selection.
194 </p>
195
196 <dl>
197
198 <dt><i>checked</i> (bool)</dt>
199 <dd>
200 flag indicating the state of the button
201 </dd>
202 </dl>
203 <a NAME="IrcNetworkListDialog.on_deleteButton_clicked" ID="IrcNetworkListDialog.on_deleteButton_clicked"></a>
204 <h4>IrcNetworkListDialog.on_deleteButton_clicked</h4>
205 <b>on_deleteButton_clicked</b>(<i></i>)
206 <p>
207 Private slot to delete the selected entry.
208 </p>
209
210 <a NAME="IrcNetworkListDialog.on_editButton_clicked" ID="IrcNetworkListDialog.on_editButton_clicked"></a>
211 <h4>IrcNetworkListDialog.on_editButton_clicked</h4>
212 <b>on_editButton_clicked</b>(<i></i>)
213 <p>
214 Private slot to edit the selected network.
215 </p>
216
217 <a NAME="IrcNetworkListDialog.on_editIdentitiesButton_clicked" ID="IrcNetworkListDialog.on_editIdentitiesButton_clicked"></a>
218 <h4>IrcNetworkListDialog.on_editIdentitiesButton_clicked</h4>
219 <b>on_editIdentitiesButton_clicked</b>(<i></i>)
220 <p>
221 Private slot to edit the identities.
222 </p>
223
224 <a NAME="IrcNetworkListDialog.on_networksList_itemCollapsed" ID="IrcNetworkListDialog.on_networksList_itemCollapsed"></a>
225 <h4>IrcNetworkListDialog.on_networksList_itemCollapsed</h4>
226 <b>on_networksList_itemCollapsed</b>(<i>_item</i>)
227 <p>
228 Private slot handling the collapse of a top level item.
229 </p>
230
231 <dl>
232
233 <dt><i>_item</i> (QTreeWidgetItem)</dt>
234 <dd>
235 reference to the collapsed item (unused)
236 </dd>
237 </dl>
238 <a NAME="IrcNetworkListDialog.on_networksList_itemExpanded" ID="IrcNetworkListDialog.on_networksList_itemExpanded"></a>
239 <h4>IrcNetworkListDialog.on_networksList_itemExpanded</h4>
240 <b>on_networksList_itemExpanded</b>(<i>_item</i>)
241 <p>
242 Private slot handling the expansion of a top level item.
243 </p>
244
245 <dl>
246
247 <dt><i>_item</i> (QTreeWidgetItem)</dt>
248 <dd>
249 reference to the expanded item (unused)
250 </dd>
251 </dl>
252 <a NAME="IrcNetworkListDialog.on_networksList_itemSelectionChanged" ID="IrcNetworkListDialog.on_networksList_itemSelectionChanged"></a>
253 <h4>IrcNetworkListDialog.on_networksList_itemSelectionChanged</h4>
254 <b>on_networksList_itemSelectionChanged</b>(<i></i>)
255 <p>
256 Private slot to handle changes of the selection of networks.
257 </p>
258
259 <a NAME="IrcNetworkListDialog.on_newButton_clicked" ID="IrcNetworkListDialog.on_newButton_clicked"></a>
260 <h4>IrcNetworkListDialog.on_newButton_clicked</h4>
261 <b>on_newButton_clicked</b>(<i></i>)
262 <p>
263 Private slot to add a new network entry.
264 </p>
265
266 <div align="right"><a href="#top">Up</a></div>
267 <hr />
268 </body></html>

eric ide

mercurial