ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcIdentitiesEditDialog.html

changeset 3
51c2c37bde76
equal deleted inserted replaced
2:5b635dc8895f 3:51c2c37bde76
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Extension_Irc.ExtensionIrc.IrcIdentitiesEditDialog</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.IrcIdentitiesEditDialog</h1>
10 <p>
11 Module implementing the identities management dialog.
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="#IrcIdentitiesEditDialog">IrcIdentitiesEditDialog</a></td>
23 <td>Class implementing the identities management dialog.</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="IrcIdentitiesEditDialog" ID="IrcIdentitiesEditDialog"></a>
35 <h2>IrcIdentitiesEditDialog</h2>
36 <p>
37 Class implementing the identities management dialog.
38 </p>
39
40 <h3>Derived from</h3>
41 QDialog, Ui_IrcIdentitiesEditDialog
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="#IrcIdentitiesEditDialog.__init__">IrcIdentitiesEditDialog</a></td>
56 <td>Constructor</td>
57 </tr>
58 <tr>
59 <td><a href="#IrcIdentitiesEditDialog.__checkCurrentIdentity">__checkCurrentIdentity</a></td>
60 <td>Private method to check the data for the current identity.</td>
61 </tr>
62 <tr>
63 <td><a href="#IrcIdentitiesEditDialog.__refreshCurrentIdentity">__refreshCurrentIdentity</a></td>
64 <td>Private method to read back the data for the current identity.</td>
65 </tr>
66 <tr>
67 <td><a href="#IrcIdentitiesEditDialog.__updateIdentitiesButtons">__updateIdentitiesButtons</a></td>
68 <td>Private slot to update the status of the identity related buttons.</td>
69 </tr>
70 <tr>
71 <td><a href="#IrcIdentitiesEditDialog.__updateNicknameButtons">__updateNicknameButtons</a></td>
72 <td>Private slot to update the nick name buttons except the up and down buttons.</td>
73 </tr>
74 <tr>
75 <td><a href="#IrcIdentitiesEditDialog.__updateNicknameUpDownButtons">__updateNicknameUpDownButtons</a></td>
76 <td>Private method to set the enabled state of the nick name up and down buttons.</td>
77 </tr>
78 <tr>
79 <td><a href="#IrcIdentitiesEditDialog.accept">accept</a></td>
80 <td>Public slot handling the acceptance of the dialog.</td>
81 </tr>
82 <tr>
83 <td><a href="#IrcIdentitiesEditDialog.eventFilter">eventFilter</a></td>
84 <td>Public method to handle events for other objects.</td>
85 </tr>
86 <tr>
87 <td><a href="#IrcIdentitiesEditDialog.on_addButton_clicked">on_addButton_clicked</a></td>
88 <td>Private slot to add a new idntity.</td>
89 </tr>
90 <tr>
91 <td><a href="#IrcIdentitiesEditDialog.on_copyButton_clicked">on_copyButton_clicked</a></td>
92 <td>Private slot to copy the selected identity.</td>
93 </tr>
94 <tr>
95 <td><a href="#IrcIdentitiesEditDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
96 <td>Private slot to rename the selected identity.</td>
97 </tr>
98 <tr>
99 <td><a href="#IrcIdentitiesEditDialog.on_identitiesCombo_currentIndexChanged">on_identitiesCombo_currentIndexChanged</a></td>
100 <td>Private slot to handle the selection of an identity.</td>
101 </tr>
102 <tr>
103 <td><a href="#IrcIdentitiesEditDialog.on_nicknameAddButton_clicked">on_nicknameAddButton_clicked</a></td>
104 <td>Private slot to add a new nickname.</td>
105 </tr>
106 <tr>
107 <td><a href="#IrcIdentitiesEditDialog.on_nicknameDeleteButton_clicked">on_nicknameDeleteButton_clicked</a></td>
108 <td>Private slot to delete a nick name.</td>
109 </tr>
110 <tr>
111 <td><a href="#IrcIdentitiesEditDialog.on_nicknameDownButton_clicked">on_nicknameDownButton_clicked</a></td>
112 <td>Private slot to move the selected entry down one row.</td>
113 </tr>
114 <tr>
115 <td><a href="#IrcIdentitiesEditDialog.on_nicknameEdit_textEdited">on_nicknameEdit_textEdited</a></td>
116 <td>Private slot handling a change of the nick name.</td>
117 </tr>
118 <tr>
119 <td><a href="#IrcIdentitiesEditDialog.on_nicknameUpButton_clicked">on_nicknameUpButton_clicked</a></td>
120 <td>Private slot to move the selected entry up one row.</td>
121 </tr>
122 <tr>
123 <td><a href="#IrcIdentitiesEditDialog.on_nicknamesList_itemSelectionChanged">on_nicknamesList_itemSelectionChanged</a></td>
124 <td>Private slot handling the selection of a nick name.</td>
125 </tr>
126 <tr>
127 <td><a href="#IrcIdentitiesEditDialog.on_renameButton_clicked">on_renameButton_clicked</a></td>
128 <td>Private slot to rename the selected identity.</td>
129 </tr>
130 <tr>
131 <td><a href="#IrcIdentitiesEditDialog.on_showPasswordButton_clicked">on_showPasswordButton_clicked</a></td>
132 <td>Private slot to show or hide the password.</td>
133 </tr>
134 </table>
135
136 <h3>Static Methods</h3>
137 <table>
138 <tr><td>None</td></tr>
139 </table>
140
141
142 <a NAME="IrcIdentitiesEditDialog.__init__" ID="IrcIdentitiesEditDialog.__init__"></a>
143 <h4>IrcIdentitiesEditDialog (Constructor)</h4>
144 <b>IrcIdentitiesEditDialog</b>(<i>manager, identityName, parent=None</i>)
145 <p>
146 Constructor
147 </p>
148
149 <dl>
150
151 <dt><i>manager</i> (IrcNetworkManager)</dt>
152 <dd>
153 reference to the IRC network manager object
154 </dd>
155 <dt><i>identityName</i> (str)</dt>
156 <dd>
157 name of the identity to be selected
158 </dd>
159 <dt><i>parent</i> (QWidget)</dt>
160 <dd>
161 reference to the parent widget
162 </dd>
163 </dl>
164 <a NAME="IrcIdentitiesEditDialog.__checkCurrentIdentity" ID="IrcIdentitiesEditDialog.__checkCurrentIdentity"></a>
165 <h4>IrcIdentitiesEditDialog.__checkCurrentIdentity</h4>
166 <b>__checkCurrentIdentity</b>(<i></i>)
167 <p>
168 Private method to check the data for the current identity.
169 </p>
170
171 <dl>
172 <dt>Return:</dt>
173 <dd>
174 flag indicating a successful check
175 </dd>
176 </dl>
177 <dl>
178 <dt>Return Type:</dt>
179 <dd>
180 bool
181 </dd>
182 </dl>
183 <a NAME="IrcIdentitiesEditDialog.__refreshCurrentIdentity" ID="IrcIdentitiesEditDialog.__refreshCurrentIdentity"></a>
184 <h4>IrcIdentitiesEditDialog.__refreshCurrentIdentity</h4>
185 <b>__refreshCurrentIdentity</b>(<i></i>)
186 <p>
187 Private method to read back the data for the current identity.
188 </p>
189
190 <a NAME="IrcIdentitiesEditDialog.__updateIdentitiesButtons" ID="IrcIdentitiesEditDialog.__updateIdentitiesButtons"></a>
191 <h4>IrcIdentitiesEditDialog.__updateIdentitiesButtons</h4>
192 <b>__updateIdentitiesButtons</b>(<i></i>)
193 <p>
194 Private slot to update the status of the identity related buttons.
195 </p>
196
197 <a NAME="IrcIdentitiesEditDialog.__updateNicknameButtons" ID="IrcIdentitiesEditDialog.__updateNicknameButtons"></a>
198 <h4>IrcIdentitiesEditDialog.__updateNicknameButtons</h4>
199 <b>__updateNicknameButtons</b>(<i></i>)
200 <p>
201 Private slot to update the nick name buttons except the up and
202 down buttons.
203 </p>
204
205 <a NAME="IrcIdentitiesEditDialog.__updateNicknameUpDownButtons" ID="IrcIdentitiesEditDialog.__updateNicknameUpDownButtons"></a>
206 <h4>IrcIdentitiesEditDialog.__updateNicknameUpDownButtons</h4>
207 <b>__updateNicknameUpDownButtons</b>(<i></i>)
208 <p>
209 Private method to set the enabled state of the nick name up and
210 down buttons.
211 </p>
212
213 <a NAME="IrcIdentitiesEditDialog.accept" ID="IrcIdentitiesEditDialog.accept"></a>
214 <h4>IrcIdentitiesEditDialog.accept</h4>
215 <b>accept</b>(<i></i>)
216 <p>
217 Public slot handling the acceptance of the dialog.
218 </p>
219
220 <a NAME="IrcIdentitiesEditDialog.eventFilter" ID="IrcIdentitiesEditDialog.eventFilter"></a>
221 <h4>IrcIdentitiesEditDialog.eventFilter</h4>
222 <b>eventFilter</b>(<i>obj, evt</i>)
223 <p>
224 Public method to handle events for other objects.
225 </p>
226
227 <dl>
228
229 <dt><i>obj</i> (QObject)</dt>
230 <dd>
231 reference to the object
232 </dd>
233 <dt><i>evt</i> (QEvent)</dt>
234 <dd>
235 reference to the event
236 </dd>
237 </dl>
238 <dl>
239 <dt>Return:</dt>
240 <dd>
241 flag indicating that the event should be filtered out
242 </dd>
243 </dl>
244 <dl>
245 <dt>Return Type:</dt>
246 <dd>
247 bool
248 </dd>
249 </dl>
250 <a NAME="IrcIdentitiesEditDialog.on_addButton_clicked" ID="IrcIdentitiesEditDialog.on_addButton_clicked"></a>
251 <h4>IrcIdentitiesEditDialog.on_addButton_clicked</h4>
252 <b>on_addButton_clicked</b>(<i></i>)
253 <p>
254 Private slot to add a new idntity.
255 </p>
256
257 <a NAME="IrcIdentitiesEditDialog.on_copyButton_clicked" ID="IrcIdentitiesEditDialog.on_copyButton_clicked"></a>
258 <h4>IrcIdentitiesEditDialog.on_copyButton_clicked</h4>
259 <b>on_copyButton_clicked</b>(<i></i>)
260 <p>
261 Private slot to copy the selected identity.
262 </p>
263
264 <a NAME="IrcIdentitiesEditDialog.on_deleteButton_clicked" ID="IrcIdentitiesEditDialog.on_deleteButton_clicked"></a>
265 <h4>IrcIdentitiesEditDialog.on_deleteButton_clicked</h4>
266 <b>on_deleteButton_clicked</b>(<i></i>)
267 <p>
268 Private slot to rename the selected identity.
269 </p>
270
271 <a NAME="IrcIdentitiesEditDialog.on_identitiesCombo_currentIndexChanged" ID="IrcIdentitiesEditDialog.on_identitiesCombo_currentIndexChanged"></a>
272 <h4>IrcIdentitiesEditDialog.on_identitiesCombo_currentIndexChanged</h4>
273 <b>on_identitiesCombo_currentIndexChanged</b>(<i>index</i>)
274 <p>
275 Private slot to handle the selection of an identity.
276 </p>
277
278 <dl>
279
280 <dt><i>index</i> (int)</dt>
281 <dd>
282 index of the selected entry
283 </dd>
284 </dl>
285 <a NAME="IrcIdentitiesEditDialog.on_nicknameAddButton_clicked" ID="IrcIdentitiesEditDialog.on_nicknameAddButton_clicked"></a>
286 <h4>IrcIdentitiesEditDialog.on_nicknameAddButton_clicked</h4>
287 <b>on_nicknameAddButton_clicked</b>(<i></i>)
288 <p>
289 Private slot to add a new nickname.
290 </p>
291
292 <a NAME="IrcIdentitiesEditDialog.on_nicknameDeleteButton_clicked" ID="IrcIdentitiesEditDialog.on_nicknameDeleteButton_clicked"></a>
293 <h4>IrcIdentitiesEditDialog.on_nicknameDeleteButton_clicked</h4>
294 <b>on_nicknameDeleteButton_clicked</b>(<i></i>)
295 <p>
296 Private slot to delete a nick name.
297 </p>
298
299 <a NAME="IrcIdentitiesEditDialog.on_nicknameDownButton_clicked" ID="IrcIdentitiesEditDialog.on_nicknameDownButton_clicked"></a>
300 <h4>IrcIdentitiesEditDialog.on_nicknameDownButton_clicked</h4>
301 <b>on_nicknameDownButton_clicked</b>(<i></i>)
302 <p>
303 Private slot to move the selected entry down one row.
304 </p>
305
306 <a NAME="IrcIdentitiesEditDialog.on_nicknameEdit_textEdited" ID="IrcIdentitiesEditDialog.on_nicknameEdit_textEdited"></a>
307 <h4>IrcIdentitiesEditDialog.on_nicknameEdit_textEdited</h4>
308 <b>on_nicknameEdit_textEdited</b>(<i>nick</i>)
309 <p>
310 Private slot handling a change of the nick name.
311 </p>
312
313 <dl>
314
315 <dt><i>nick</i> (str)</dt>
316 <dd>
317 new nick name
318 </dd>
319 </dl>
320 <a NAME="IrcIdentitiesEditDialog.on_nicknameUpButton_clicked" ID="IrcIdentitiesEditDialog.on_nicknameUpButton_clicked"></a>
321 <h4>IrcIdentitiesEditDialog.on_nicknameUpButton_clicked</h4>
322 <b>on_nicknameUpButton_clicked</b>(<i></i>)
323 <p>
324 Private slot to move the selected entry up one row.
325 </p>
326
327 <a NAME="IrcIdentitiesEditDialog.on_nicknamesList_itemSelectionChanged" ID="IrcIdentitiesEditDialog.on_nicknamesList_itemSelectionChanged"></a>
328 <h4>IrcIdentitiesEditDialog.on_nicknamesList_itemSelectionChanged</h4>
329 <b>on_nicknamesList_itemSelectionChanged</b>(<i></i>)
330 <p>
331 Private slot handling the selection of a nick name.
332 </p>
333
334 <a NAME="IrcIdentitiesEditDialog.on_renameButton_clicked" ID="IrcIdentitiesEditDialog.on_renameButton_clicked"></a>
335 <h4>IrcIdentitiesEditDialog.on_renameButton_clicked</h4>
336 <b>on_renameButton_clicked</b>(<i></i>)
337 <p>
338 Private slot to rename the selected identity.
339 </p>
340
341 <a NAME="IrcIdentitiesEditDialog.on_showPasswordButton_clicked" ID="IrcIdentitiesEditDialog.on_showPasswordButton_clicked"></a>
342 <h4>IrcIdentitiesEditDialog.on_showPasswordButton_clicked</h4>
343 <b>on_showPasswordButton_clicked</b>(<i>checked</i>)
344 <p>
345 Private slot to show or hide the password.
346 </p>
347
348 <dl>
349
350 <dt><i>checked</i> (bool)</dt>
351 <dd>
352 state of the button
353 </dd>
354 </dl>
355 <div align="right"><a href="#top">Up</a></div>
356 <hr />
357 </body></html>

eric ide

mercurial