ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcNetworkEditDialog.html

changeset 3
51c2c37bde76
equal deleted inserted replaced
2:5b635dc8895f 3:51c2c37bde76
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkEditDialog</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.IrcNetworkEditDialog</h1>
10 <p>
11 Module implementing a dialog for editing IRC network definitions.
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="#IrcNetworkEditDialog">IrcNetworkEditDialog</a></td>
23 <td>Class implementing a dialog for editing IRC network definitions.</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="IrcNetworkEditDialog" ID="IrcNetworkEditDialog"></a>
35 <h2>IrcNetworkEditDialog</h2>
36 <p>
37 Class implementing a dialog for editing IRC network definitions.
38 </p>
39
40 <h3>Derived from</h3>
41 QDialog, Ui_IrcNetworkEditDialog
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="#IrcNetworkEditDialog.__init__">IrcNetworkEditDialog</a></td>
56 <td>Constructor</td>
57 </tr>
58 <tr>
59 <td><a href="#IrcNetworkEditDialog.__editChannel">__editChannel</a></td>
60 <td>Private method to edit a channel.</td>
61 </tr>
62 <tr>
63 <td><a href="#IrcNetworkEditDialog.__refreshIdentityCombo">__refreshIdentityCombo</a></td>
64 <td>Private method to refresh the identity combo.</td>
65 </tr>
66 <tr>
67 <td><a href="#IrcNetworkEditDialog.__updateOkButton">__updateOkButton</a></td>
68 <td>Private method to update the OK button state.</td>
69 </tr>
70 <tr>
71 <td><a href="#IrcNetworkEditDialog.getNetwork">getNetwork</a></td>
72 <td>Public method to get the network object.</td>
73 </tr>
74 <tr>
75 <td><a href="#IrcNetworkEditDialog.on_addChannelButton_clicked">on_addChannelButton_clicked</a></td>
76 <td>Private slot to add a channel.</td>
77 </tr>
78 <tr>
79 <td><a href="#IrcNetworkEditDialog.on_channelList_itemActivated">on_channelList_itemActivated</a></td>
80 <td>Private slot to handle the activation of a channel entry.</td>
81 </tr>
82 <tr>
83 <td><a href="#IrcNetworkEditDialog.on_channelList_itemSelectionChanged">on_channelList_itemSelectionChanged</a></td>
84 <td>Private slot to handle changes of the selection of channels.</td>
85 </tr>
86 <tr>
87 <td><a href="#IrcNetworkEditDialog.on_deleteChannelButton_clicked">on_deleteChannelButton_clicked</a></td>
88 <td>Private slot to delete the selected channel.</td>
89 </tr>
90 <tr>
91 <td><a href="#IrcNetworkEditDialog.on_editChannelButton_clicked">on_editChannelButton_clicked</a></td>
92 <td>Private slot to edit the selected channel.</td>
93 </tr>
94 <tr>
95 <td><a href="#IrcNetworkEditDialog.on_editIdentitiesButton_clicked">on_editIdentitiesButton_clicked</a></td>
96 <td>Private slot to edit the identities.</td>
97 </tr>
98 <tr>
99 <td><a href="#IrcNetworkEditDialog.on_editServerButton_clicked">on_editServerButton_clicked</a></td>
100 <td>Private slot to edit the server configuration.</td>
101 </tr>
102 <tr>
103 <td><a href="#IrcNetworkEditDialog.on_identityCombo_currentTextChanged">on_identityCombo_currentTextChanged</a></td>
104 <td>Private slot to handle the selection of an identity.</td>
105 </tr>
106 <tr>
107 <td><a href="#IrcNetworkEditDialog.on_networkEdit_textChanged">on_networkEdit_textChanged</a></td>
108 <td>Private slot to handle changes of the network name.</td>
109 </tr>
110 <tr>
111 <td><a href="#IrcNetworkEditDialog.on_serverEdit_textChanged">on_serverEdit_textChanged</a></td>
112 <td>Private slot to handle changes of the server name.</td>
113 </tr>
114 </table>
115
116 <h3>Static Methods</h3>
117 <table>
118 <tr><td>None</td></tr>
119 </table>
120
121
122 <a NAME="IrcNetworkEditDialog.__init__" ID="IrcNetworkEditDialog.__init__"></a>
123 <h4>IrcNetworkEditDialog (Constructor)</h4>
124 <b>IrcNetworkEditDialog</b>(<i>manager, networkName, parent=None</i>)
125 <p>
126 Constructor
127 </p>
128
129 <dl>
130
131 <dt><i>manager</i> (IrcNetworkManager)</dt>
132 <dd>
133 reference to the IRC network manager object
134 </dd>
135 <dt><i>networkName</i> (str)</dt>
136 <dd>
137 name of the network to work on
138 </dd>
139 <dt><i>parent</i> (QWidget)</dt>
140 <dd>
141 reference to the parent widget
142 </dd>
143 </dl>
144 <a NAME="IrcNetworkEditDialog.__editChannel" ID="IrcNetworkEditDialog.__editChannel"></a>
145 <h4>IrcNetworkEditDialog.__editChannel</h4>
146 <b>__editChannel</b>(<i>itm</i>)
147 <p>
148 Private method to edit a channel.
149 </p>
150
151 <dl>
152
153 <dt><i>itm</i> (QTreeWidgetItem)</dt>
154 <dd>
155 reference to the item to be edited
156 </dd>
157 </dl>
158 <a NAME="IrcNetworkEditDialog.__refreshIdentityCombo" ID="IrcNetworkEditDialog.__refreshIdentityCombo"></a>
159 <h4>IrcNetworkEditDialog.__refreshIdentityCombo</h4>
160 <b>__refreshIdentityCombo</b>(<i>currentIdentity</i>)
161 <p>
162 Private method to refresh the identity combo.
163 </p>
164
165 <dl>
166
167 <dt><i>currentIdentity</i> (str)</dt>
168 <dd>
169 name of the identity to select
170 </dd>
171 </dl>
172 <a NAME="IrcNetworkEditDialog.__updateOkButton" ID="IrcNetworkEditDialog.__updateOkButton"></a>
173 <h4>IrcNetworkEditDialog.__updateOkButton</h4>
174 <b>__updateOkButton</b>(<i></i>)
175 <p>
176 Private method to update the OK button state.
177 </p>
178
179 <a NAME="IrcNetworkEditDialog.getNetwork" ID="IrcNetworkEditDialog.getNetwork"></a>
180 <h4>IrcNetworkEditDialog.getNetwork</h4>
181 <b>getNetwork</b>(<i></i>)
182 <p>
183 Public method to get the network object.
184 </p>
185
186 <dl>
187 <dt>Return:</dt>
188 <dd>
189 edited network object
190 </dd>
191 </dl>
192 <dl>
193 <dt>Return Type:</dt>
194 <dd>
195 IrcNetwork
196 </dd>
197 </dl>
198 <a NAME="IrcNetworkEditDialog.on_addChannelButton_clicked" ID="IrcNetworkEditDialog.on_addChannelButton_clicked"></a>
199 <h4>IrcNetworkEditDialog.on_addChannelButton_clicked</h4>
200 <b>on_addChannelButton_clicked</b>(<i></i>)
201 <p>
202 Private slot to add a channel.
203 </p>
204
205 <a NAME="IrcNetworkEditDialog.on_channelList_itemActivated" ID="IrcNetworkEditDialog.on_channelList_itemActivated"></a>
206 <h4>IrcNetworkEditDialog.on_channelList_itemActivated</h4>
207 <b>on_channelList_itemActivated</b>(<i>item, _column</i>)
208 <p>
209 Private slot to handle the activation of a channel entry.
210 </p>
211
212 <dl>
213
214 <dt><i>item</i> (QTreeWidgetItem)</dt>
215 <dd>
216 reference to the activated item
217 </dd>
218 <dt><i>_column</i> (int)</dt>
219 <dd>
220 column the activation occurred in (unused)
221 </dd>
222 </dl>
223 <a NAME="IrcNetworkEditDialog.on_channelList_itemSelectionChanged" ID="IrcNetworkEditDialog.on_channelList_itemSelectionChanged"></a>
224 <h4>IrcNetworkEditDialog.on_channelList_itemSelectionChanged</h4>
225 <b>on_channelList_itemSelectionChanged</b>(<i></i>)
226 <p>
227 Private slot to handle changes of the selection of channels.
228 </p>
229
230 <a NAME="IrcNetworkEditDialog.on_deleteChannelButton_clicked" ID="IrcNetworkEditDialog.on_deleteChannelButton_clicked"></a>
231 <h4>IrcNetworkEditDialog.on_deleteChannelButton_clicked</h4>
232 <b>on_deleteChannelButton_clicked</b>(<i></i>)
233 <p>
234 Private slot to delete the selected channel.
235 </p>
236
237 <a NAME="IrcNetworkEditDialog.on_editChannelButton_clicked" ID="IrcNetworkEditDialog.on_editChannelButton_clicked"></a>
238 <h4>IrcNetworkEditDialog.on_editChannelButton_clicked</h4>
239 <b>on_editChannelButton_clicked</b>(<i></i>)
240 <p>
241 Private slot to edit the selected channel.
242 </p>
243
244 <a NAME="IrcNetworkEditDialog.on_editIdentitiesButton_clicked" ID="IrcNetworkEditDialog.on_editIdentitiesButton_clicked"></a>
245 <h4>IrcNetworkEditDialog.on_editIdentitiesButton_clicked</h4>
246 <b>on_editIdentitiesButton_clicked</b>(<i></i>)
247 <p>
248 Private slot to edit the identities.
249 </p>
250
251 <a NAME="IrcNetworkEditDialog.on_editServerButton_clicked" ID="IrcNetworkEditDialog.on_editServerButton_clicked"></a>
252 <h4>IrcNetworkEditDialog.on_editServerButton_clicked</h4>
253 <b>on_editServerButton_clicked</b>(<i></i>)
254 <p>
255 Private slot to edit the server configuration.
256 </p>
257
258 <a NAME="IrcNetworkEditDialog.on_identityCombo_currentTextChanged" ID="IrcNetworkEditDialog.on_identityCombo_currentTextChanged"></a>
259 <h4>IrcNetworkEditDialog.on_identityCombo_currentTextChanged</h4>
260 <b>on_identityCombo_currentTextChanged</b>(<i>identity</i>)
261 <p>
262 Private slot to handle the selection of an identity.
263 </p>
264
265 <dl>
266
267 <dt><i>identity</i> (str)</dt>
268 <dd>
269 selected identity
270 </dd>
271 </dl>
272 <a NAME="IrcNetworkEditDialog.on_networkEdit_textChanged" ID="IrcNetworkEditDialog.on_networkEdit_textChanged"></a>
273 <h4>IrcNetworkEditDialog.on_networkEdit_textChanged</h4>
274 <b>on_networkEdit_textChanged</b>(<i>_txt</i>)
275 <p>
276 Private slot to handle changes of the network name.
277 </p>
278
279 <dl>
280
281 <dt><i>_txt</i> (str)</dt>
282 <dd>
283 text entered into the network name edit (unused)
284 </dd>
285 </dl>
286 <a NAME="IrcNetworkEditDialog.on_serverEdit_textChanged" ID="IrcNetworkEditDialog.on_serverEdit_textChanged"></a>
287 <h4>IrcNetworkEditDialog.on_serverEdit_textChanged</h4>
288 <b>on_serverEdit_textChanged</b>(<i>_txt</i>)
289 <p>
290 Private slot to handle changes of the server name.
291 </p>
292
293 <dl>
294
295 <dt><i>_txt</i> (str)</dt>
296 <dd>
297 text entered into the server name edit (unused)
298 </dd>
299 </dl>
300 <div align="right"><a href="#top">Up</a></div>
301 <hr />
302 </body></html>

eric ide

mercurial