eric6/Documentation/Source/eric6.Network.IRC.IrcNetworkManager.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.Network.IRC.IrcNetworkManager</h1> 23 <h1>eric6.Network.IRC.IrcNetworkManager</h1>
24
23 <p> 25 <p>
24 Module implementing the IRC data structures and their manager. 26 Module implementing the IRC data structures and their manager.
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="#IrcChannel">IrcChannel</a></td> 38 <td><a href="#IrcChannel">IrcChannel</a></td>
34 <td>Class implementing the IRC channel object.</td> 39 <td>Class implementing the IRC channel object.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#IrcIdentity">IrcIdentity</a></td> 42 <td><a href="#IrcIdentity">IrcIdentity</a></td>
37 <td>Class implementing the IRC identity object.</td> 43 <td>Class implementing the IRC identity object.</td>
38 </tr><tr> 44 </tr>
45 <tr>
39 <td><a href="#IrcNetwork">IrcNetwork</a></td> 46 <td><a href="#IrcNetwork">IrcNetwork</a></td>
40 <td>Class implementing the IRC network object.</td> 47 <td>Class implementing the IRC network object.</td>
41 </tr><tr> 48 </tr>
49 <tr>
42 <td><a href="#IrcNetworkManager">IrcNetworkManager</a></td> 50 <td><a href="#IrcNetworkManager">IrcNetworkManager</a></td>
43 <td>Class implementing the IRC identity object.</td> 51 <td>Class implementing the IRC identity object.</td>
44 </tr><tr> 52 </tr>
53 <tr>
45 <td><a href="#IrcServer">IrcServer</a></td> 54 <td><a href="#IrcServer">IrcServer</a></td>
46 <td>Class implementing the IRC identity object.</td> 55 <td>Class implementing the IRC identity object.</td>
47 </tr> 56 </tr>
48 </table> 57 </table>
49 <h3>Functions</h3> 58 <h3>Functions</h3>
59
50 <table> 60 <table>
51 <tr><td>None</td></tr> 61 <tr><td>None</td></tr>
52 </table> 62 </table>
53 <hr /><hr /> 63 <hr />
64 <hr />
54 <a NAME="IrcChannel" ID="IrcChannel"></a> 65 <a NAME="IrcChannel" ID="IrcChannel"></a>
55 <h2>IrcChannel</h2> 66 <h2>IrcChannel</h2>
67
56 <p> 68 <p>
57 Class implementing the IRC channel object. 69 Class implementing the IRC channel object.
58 </p> 70 </p>
59 <h3>Derived from</h3> 71 <h3>Derived from</h3>
60 object 72 object
61 <h3>Class Attributes</h3> 73 <h3>Class Attributes</h3>
74
62 <table> 75 <table>
63 <tr><td>None</td></tr> 76 <tr><td>None</td></tr>
64 </table> 77 </table>
65 <h3>Class Methods</h3> 78 <h3>Class Methods</h3>
79
66 <table> 80 <table>
67 <tr><td>None</td></tr> 81 <tr><td>None</td></tr>
68 </table> 82 </table>
69 <h3>Methods</h3> 83 <h3>Methods</h3>
70 <table> 84
85 <table>
86
71 <tr> 87 <tr>
72 <td><a href="#IrcChannel.__init__">IrcChannel</a></td> 88 <td><a href="#IrcChannel.__init__">IrcChannel</a></td>
73 <td>Constructor</td> 89 <td>Constructor</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#IrcChannel.autoJoin">autoJoin</a></td> 92 <td><a href="#IrcChannel.autoJoin">autoJoin</a></td>
76 <td>Public method to check the auto join status.</td> 93 <td>Public method to check the auto join status.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#IrcChannel.getKey">getKey</a></td> 96 <td><a href="#IrcChannel.getKey">getKey</a></td>
79 <td>Public method to get the channel key.</td> 97 <td>Public method to get the channel key.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#IrcChannel.getName">getName</a></td> 100 <td><a href="#IrcChannel.getName">getName</a></td>
82 <td>Public method to get the channel name.</td> 101 <td>Public method to get the channel name.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#IrcChannel.load">load</a></td> 104 <td><a href="#IrcChannel.load">load</a></td>
85 <td>Public method to load the network data.</td> 105 <td>Public method to load the network data.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#IrcChannel.save">save</a></td> 108 <td><a href="#IrcChannel.save">save</a></td>
88 <td>Public method to save the channel data.</td> 109 <td>Public method to save the channel data.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#IrcChannel.setAutoJoin">setAutoJoin</a></td> 112 <td><a href="#IrcChannel.setAutoJoin">setAutoJoin</a></td>
91 <td>Public method to set the auto join status of the channel.</td> 113 <td>Public method to set the auto join status of the channel.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#IrcChannel.setKey">setKey</a></td> 116 <td><a href="#IrcChannel.setKey">setKey</a></td>
94 <td>Public method to set a new channel key.</td> 117 <td>Public method to set a new channel key.</td>
95 </tr> 118 </tr>
96 </table> 119 </table>
97 <h3>Static Methods</h3> 120 <h3>Static Methods</h3>
121
98 <table> 122 <table>
99 <tr><td>None</td></tr> 123 <tr><td>None</td></tr>
100 </table> 124 </table>
125
101 <a NAME="IrcChannel.__init__" ID="IrcChannel.__init__"></a> 126 <a NAME="IrcChannel.__init__" ID="IrcChannel.__init__"></a>
102 <h4>IrcChannel (Constructor)</h4> 127 <h4>IrcChannel (Constructor)</h4>
103 <b>IrcChannel</b>(<i>name</i>) 128 <b>IrcChannel</b>(<i>name</i>)
129
104 <p> 130 <p>
105 Constructor 131 Constructor
106 </p><dl> 132 </p>
133 <dl>
134
107 <dt><i>name</i></dt> 135 <dt><i>name</i></dt>
108 <dd> 136 <dd>
109 name of the network (string) 137 name of the network (string)
110 </dd> 138 </dd>
111 </dl><a NAME="IrcChannel.autoJoin" ID="IrcChannel.autoJoin"></a> 139 </dl>
140 <a NAME="IrcChannel.autoJoin" ID="IrcChannel.autoJoin"></a>
112 <h4>IrcChannel.autoJoin</h4> 141 <h4>IrcChannel.autoJoin</h4>
113 <b>autoJoin</b>(<i></i>) 142 <b>autoJoin</b>(<i></i>)
143
114 <p> 144 <p>
115 Public method to check the auto join status. 145 Public method to check the auto join status.
116 </p><dl> 146 </p>
147 <dl>
117 <dt>Returns:</dt> 148 <dt>Returns:</dt>
118 <dd> 149 <dd>
119 flag indicating if the channel should be 150 flag indicating if the channel should be
120 joined automatically (boolean) 151 joined automatically (boolean)
121 </dd> 152 </dd>
122 </dl><a NAME="IrcChannel.getKey" ID="IrcChannel.getKey"></a> 153 </dl>
154 <a NAME="IrcChannel.getKey" ID="IrcChannel.getKey"></a>
123 <h4>IrcChannel.getKey</h4> 155 <h4>IrcChannel.getKey</h4>
124 <b>getKey</b>(<i></i>) 156 <b>getKey</b>(<i></i>)
157
125 <p> 158 <p>
126 Public method to get the channel key. 159 Public method to get the channel key.
127 </p><dl> 160 </p>
161 <dl>
128 <dt>Returns:</dt> 162 <dt>Returns:</dt>
129 <dd> 163 <dd>
130 channel key (string) 164 channel key (string)
131 </dd> 165 </dd>
132 </dl><a NAME="IrcChannel.getName" ID="IrcChannel.getName"></a> 166 </dl>
167 <a NAME="IrcChannel.getName" ID="IrcChannel.getName"></a>
133 <h4>IrcChannel.getName</h4> 168 <h4>IrcChannel.getName</h4>
134 <b>getName</b>(<i></i>) 169 <b>getName</b>(<i></i>)
170
135 <p> 171 <p>
136 Public method to get the channel name. 172 Public method to get the channel name.
137 </p><dl> 173 </p>
174 <dl>
138 <dt>Returns:</dt> 175 <dt>Returns:</dt>
139 <dd> 176 <dd>
140 channel name (string) 177 channel name (string)
141 </dd> 178 </dd>
142 </dl><a NAME="IrcChannel.load" ID="IrcChannel.load"></a> 179 </dl>
180 <a NAME="IrcChannel.load" ID="IrcChannel.load"></a>
143 <h4>IrcChannel.load</h4> 181 <h4>IrcChannel.load</h4>
144 <b>load</b>(<i>settings</i>) 182 <b>load</b>(<i>settings</i>)
183
145 <p> 184 <p>
146 Public method to load the network data. 185 Public method to load the network data.
147 </p><dl> 186 </p>
187 <dl>
188
148 <dt><i>settings</i></dt> 189 <dt><i>settings</i></dt>
149 <dd> 190 <dd>
150 reference to the settings object (QSettings) 191 reference to the settings object (QSettings)
151 </dd> 192 </dd>
152 </dl><a NAME="IrcChannel.save" ID="IrcChannel.save"></a> 193 </dl>
194 <a NAME="IrcChannel.save" ID="IrcChannel.save"></a>
153 <h4>IrcChannel.save</h4> 195 <h4>IrcChannel.save</h4>
154 <b>save</b>(<i>settings</i>) 196 <b>save</b>(<i>settings</i>)
197
155 <p> 198 <p>
156 Public method to save the channel data. 199 Public method to save the channel data.
157 </p><dl> 200 </p>
201 <dl>
202
158 <dt><i>settings</i></dt> 203 <dt><i>settings</i></dt>
159 <dd> 204 <dd>
160 reference to the settings object (QSettings) 205 reference to the settings object (QSettings)
161 </dd> 206 </dd>
162 </dl><a NAME="IrcChannel.setAutoJoin" ID="IrcChannel.setAutoJoin"></a> 207 </dl>
208 <a NAME="IrcChannel.setAutoJoin" ID="IrcChannel.setAutoJoin"></a>
163 <h4>IrcChannel.setAutoJoin</h4> 209 <h4>IrcChannel.setAutoJoin</h4>
164 <b>setAutoJoin</b>(<i>enable</i>) 210 <b>setAutoJoin</b>(<i>enable</i>)
211
165 <p> 212 <p>
166 Public method to set the auto join status of the channel. 213 Public method to set the auto join status of the channel.
167 </p><dl> 214 </p>
215 <dl>
216
168 <dt><i>enable</i></dt> 217 <dt><i>enable</i></dt>
169 <dd> 218 <dd>
170 flag indicating if the channel should be 219 flag indicating if the channel should be
171 joined automatically (boolean) 220 joined automatically (boolean)
172 </dd> 221 </dd>
173 </dl><a NAME="IrcChannel.setKey" ID="IrcChannel.setKey"></a> 222 </dl>
223 <a NAME="IrcChannel.setKey" ID="IrcChannel.setKey"></a>
174 <h4>IrcChannel.setKey</h4> 224 <h4>IrcChannel.setKey</h4>
175 <b>setKey</b>(<i>key</i>) 225 <b>setKey</b>(<i>key</i>)
226
176 <p> 227 <p>
177 Public method to set a new channel key. 228 Public method to set a new channel key.
178 </p><dl> 229 </p>
230 <dl>
231
179 <dt><i>key</i></dt> 232 <dt><i>key</i></dt>
180 <dd> 233 <dd>
181 channel key to set (string) 234 channel key to set (string)
182 </dd> 235 </dd>
183 </dl> 236 </dl>
184 <div align="right"><a href="#top">Up</a></div> 237 <div align="right"><a href="#top">Up</a></div>
185 <hr /><hr /> 238 <hr />
239 <hr />
186 <a NAME="IrcIdentity" ID="IrcIdentity"></a> 240 <a NAME="IrcIdentity" ID="IrcIdentity"></a>
187 <h2>IrcIdentity</h2> 241 <h2>IrcIdentity</h2>
242
188 <p> 243 <p>
189 Class implementing the IRC identity object. 244 Class implementing the IRC identity object.
190 </p> 245 </p>
191 <h3>Derived from</h3> 246 <h3>Derived from</h3>
192 object 247 object
193 <h3>Class Attributes</h3> 248 <h3>Class Attributes</h3>
249
194 <table> 250 <table>
195 <tr><td>DefaultAwayMessage</td></tr><tr><td>DefaultIdentityDisplay</td></tr><tr><td>DefaultIdentityName</td></tr><tr><td>DefaultPartMessage</td></tr><tr><td>DefaultQuitMessage</td></tr> 251 <tr><td>DefaultAwayMessage</td></tr><tr><td>DefaultIdentityDisplay</td></tr><tr><td>DefaultIdentityName</td></tr><tr><td>DefaultPartMessage</td></tr><tr><td>DefaultQuitMessage</td></tr>
196 </table> 252 </table>
197 <h3>Class Methods</h3> 253 <h3>Class Methods</h3>
198 <table> 254
255 <table>
256
199 <tr> 257 <tr>
200 <td><a href="#IrcIdentity.createDefaultIdentity">createDefaultIdentity</a></td> 258 <td><a href="#IrcIdentity.createDefaultIdentity">createDefaultIdentity</a></td>
201 <td>Class method to create the default identity.</td> 259 <td>Class method to create the default identity.</td>
202 </tr> 260 </tr>
203 </table> 261 </table>
204 <h3>Methods</h3> 262 <h3>Methods</h3>
205 <table> 263
264 <table>
265
206 <tr> 266 <tr>
207 <td><a href="#IrcIdentity.__init__">IrcIdentity</a></td> 267 <td><a href="#IrcIdentity.__init__">IrcIdentity</a></td>
208 <td>Constructor</td> 268 <td>Constructor</td>
209 </tr><tr> 269 </tr>
270 <tr>
210 <td><a href="#IrcIdentity.getAwayMessage">getAwayMessage</a></td> 271 <td><a href="#IrcIdentity.getAwayMessage">getAwayMessage</a></td>
211 <td>Public method to get the AWAY message.</td> 272 <td>Public method to get the AWAY message.</td>
212 </tr><tr> 273 </tr>
274 <tr>
213 <td><a href="#IrcIdentity.getIdent">getIdent</a></td> 275 <td><a href="#IrcIdentity.getIdent">getIdent</a></td>
214 <td>Public method to get the real identity name.</td> 276 <td>Public method to get the real identity name.</td>
215 </tr><tr> 277 </tr>
278 <tr>
216 <td><a href="#IrcIdentity.getName">getName</a></td> 279 <td><a href="#IrcIdentity.getName">getName</a></td>
217 <td>Public method to get the identity name.</td> 280 <td>Public method to get the identity name.</td>
218 </tr><tr> 281 </tr>
282 <tr>
219 <td><a href="#IrcIdentity.getNickNames">getNickNames</a></td> 283 <td><a href="#IrcIdentity.getNickNames">getNickNames</a></td>
220 <td>Public method to get the nick names.</td> 284 <td>Public method to get the nick names.</td>
221 </tr><tr> 285 </tr>
286 <tr>
222 <td><a href="#IrcIdentity.getPartMessage">getPartMessage</a></td> 287 <td><a href="#IrcIdentity.getPartMessage">getPartMessage</a></td>
223 <td>Public method to get the PART message.</td> 288 <td>Public method to get the PART message.</td>
224 </tr><tr> 289 </tr>
290 <tr>
225 <td><a href="#IrcIdentity.getPassword">getPassword</a></td> 291 <td><a href="#IrcIdentity.getPassword">getPassword</a></td>
226 <td>Public method to get the password.</td> 292 <td>Public method to get the password.</td>
227 </tr><tr> 293 </tr>
294 <tr>
228 <td><a href="#IrcIdentity.getQuitMessage">getQuitMessage</a></td> 295 <td><a href="#IrcIdentity.getQuitMessage">getQuitMessage</a></td>
229 <td>Public method to get the QUIT message.</td> 296 <td>Public method to get the QUIT message.</td>
230 </tr><tr> 297 </tr>
298 <tr>
231 <td><a href="#IrcIdentity.getRealName">getRealName</a></td> 299 <td><a href="#IrcIdentity.getRealName">getRealName</a></td>
232 <td>Public method to get the real name.</td> 300 <td>Public method to get the real name.</td>
233 </tr><tr> 301 </tr>
302 <tr>
234 <td><a href="#IrcIdentity.getServiceName">getServiceName</a></td> 303 <td><a href="#IrcIdentity.getServiceName">getServiceName</a></td>
235 <td>Public method to get the service name of the identity used for identification.</td> 304 <td>Public method to get the service name of the identity used for identification.</td>
236 </tr><tr> 305 </tr>
306 <tr>
237 <td><a href="#IrcIdentity.load">load</a></td> 307 <td><a href="#IrcIdentity.load">load</a></td>
238 <td>Public method to load the identity data.</td> 308 <td>Public method to load the identity data.</td>
239 </tr><tr> 309 </tr>
310 <tr>
240 <td><a href="#IrcIdentity.rememberAwayPosition">rememberAwayPosition</a></td> 311 <td><a href="#IrcIdentity.rememberAwayPosition">rememberAwayPosition</a></td>
241 <td>Public method to get a flag indicating to remember the chat position upon AWAY.</td> 312 <td>Public method to get a flag indicating to remember the chat position upon AWAY.</td>
242 </tr><tr> 313 </tr>
314 <tr>
243 <td><a href="#IrcIdentity.save">save</a></td> 315 <td><a href="#IrcIdentity.save">save</a></td>
244 <td>Public method to save the identity data.</td> 316 <td>Public method to save the identity data.</td>
245 </tr><tr> 317 </tr>
318 <tr>
246 <td><a href="#IrcIdentity.setAwayMessage">setAwayMessage</a></td> 319 <td><a href="#IrcIdentity.setAwayMessage">setAwayMessage</a></td>
247 <td>Public method to set the AWAY message.</td> 320 <td>Public method to set the AWAY message.</td>
248 </tr><tr> 321 </tr>
322 <tr>
249 <td><a href="#IrcIdentity.setIdent">setIdent</a></td> 323 <td><a href="#IrcIdentity.setIdent">setIdent</a></td>
250 <td>Public method to set the real identity name.</td> 324 <td>Public method to set the real identity name.</td>
251 </tr><tr> 325 </tr>
326 <tr>
252 <td><a href="#IrcIdentity.setName">setName</a></td> 327 <td><a href="#IrcIdentity.setName">setName</a></td>
253 <td>Public method to set the identity name.</td> 328 <td>Public method to set the identity name.</td>
254 </tr><tr> 329 </tr>
330 <tr>
255 <td><a href="#IrcIdentity.setNickNames">setNickNames</a></td> 331 <td><a href="#IrcIdentity.setNickNames">setNickNames</a></td>
256 <td>Public method to set the nick names of the identity.</td> 332 <td>Public method to set the nick names of the identity.</td>
257 </tr><tr> 333 </tr>
334 <tr>
258 <td><a href="#IrcIdentity.setPartMessage">setPartMessage</a></td> 335 <td><a href="#IrcIdentity.setPartMessage">setPartMessage</a></td>
259 <td>Public method to set the PART message.</td> 336 <td>Public method to set the PART message.</td>
260 </tr><tr> 337 </tr>
338 <tr>
261 <td><a href="#IrcIdentity.setPassword">setPassword</a></td> 339 <td><a href="#IrcIdentity.setPassword">setPassword</a></td>
262 <td>Public method to set a new password.</td> 340 <td>Public method to set a new password.</td>
263 </tr><tr> 341 </tr>
342 <tr>
264 <td><a href="#IrcIdentity.setQuitMessage">setQuitMessage</a></td> 343 <td><a href="#IrcIdentity.setQuitMessage">setQuitMessage</a></td>
265 <td>Public method to set the QUIT message.</td> 344 <td>Public method to set the QUIT message.</td>
266 </tr><tr> 345 </tr>
346 <tr>
267 <td><a href="#IrcIdentity.setRealName">setRealName</a></td> 347 <td><a href="#IrcIdentity.setRealName">setRealName</a></td>
268 <td>Public method to set the real name of the identity.</td> 348 <td>Public method to set the real name of the identity.</td>
269 </tr><tr> 349 </tr>
350 <tr>
270 <td><a href="#IrcIdentity.setRememberAwayPosition">setRememberAwayPosition</a></td> 351 <td><a href="#IrcIdentity.setRememberAwayPosition">setRememberAwayPosition</a></td>
271 <td>Public method to set to remember the chat position upon AWAY.</td> 352 <td>Public method to set to remember the chat position upon AWAY.</td>
272 </tr><tr> 353 </tr>
354 <tr>
273 <td><a href="#IrcIdentity.setServiceName">setServiceName</a></td> 355 <td><a href="#IrcIdentity.setServiceName">setServiceName</a></td>
274 <td>Public method to set the service name of the identity used for identification.</td> 356 <td>Public method to set the service name of the identity used for identification.</td>
275 </tr> 357 </tr>
276 </table> 358 </table>
277 <h3>Static Methods</h3> 359 <h3>Static Methods</h3>
360
278 <table> 361 <table>
279 <tr><td>None</td></tr> 362 <tr><td>None</td></tr>
280 </table> 363 </table>
364
281 <a NAME="IrcIdentity.createDefaultIdentity" ID="IrcIdentity.createDefaultIdentity"></a> 365 <a NAME="IrcIdentity.createDefaultIdentity" ID="IrcIdentity.createDefaultIdentity"></a>
282 <h4>IrcIdentity.createDefaultIdentity (class method)</h4> 366 <h4>IrcIdentity.createDefaultIdentity (class method)</h4>
283 <b>createDefaultIdentity</b>(<i></i>) 367 <b>createDefaultIdentity</b>(<i></i>)
368
284 <p> 369 <p>
285 Class method to create the default identity. 370 Class method to create the default identity.
286 </p><dl> 371 </p>
372 <dl>
287 <dt>Returns:</dt> 373 <dt>Returns:</dt>
288 <dd> 374 <dd>
289 default identity (IrcIdentity) 375 default identity (IrcIdentity)
290 </dd> 376 </dd>
291 </dl><a NAME="IrcIdentity.__init__" ID="IrcIdentity.__init__"></a> 377 </dl>
378 <a NAME="IrcIdentity.__init__" ID="IrcIdentity.__init__"></a>
292 <h4>IrcIdentity (Constructor)</h4> 379 <h4>IrcIdentity (Constructor)</h4>
293 <b>IrcIdentity</b>(<i>name</i>) 380 <b>IrcIdentity</b>(<i>name</i>)
381
294 <p> 382 <p>
295 Constructor 383 Constructor
296 </p><dl> 384 </p>
385 <dl>
386
297 <dt><i>name</i></dt> 387 <dt><i>name</i></dt>
298 <dd> 388 <dd>
299 name of the identity (string) 389 name of the identity (string)
300 </dd> 390 </dd>
301 </dl><a NAME="IrcIdentity.getAwayMessage" ID="IrcIdentity.getAwayMessage"></a> 391 </dl>
392 <a NAME="IrcIdentity.getAwayMessage" ID="IrcIdentity.getAwayMessage"></a>
302 <h4>IrcIdentity.getAwayMessage</h4> 393 <h4>IrcIdentity.getAwayMessage</h4>
303 <b>getAwayMessage</b>(<i></i>) 394 <b>getAwayMessage</b>(<i></i>)
395
304 <p> 396 <p>
305 Public method to get the AWAY message. 397 Public method to get the AWAY message.
306 </p><dl> 398 </p>
399 <dl>
307 <dt>Returns:</dt> 400 <dt>Returns:</dt>
308 <dd> 401 <dd>
309 AWAY message (string) 402 AWAY message (string)
310 </dd> 403 </dd>
311 </dl><a NAME="IrcIdentity.getIdent" ID="IrcIdentity.getIdent"></a> 404 </dl>
405 <a NAME="IrcIdentity.getIdent" ID="IrcIdentity.getIdent"></a>
312 <h4>IrcIdentity.getIdent</h4> 406 <h4>IrcIdentity.getIdent</h4>
313 <b>getIdent</b>(<i></i>) 407 <b>getIdent</b>(<i></i>)
408
314 <p> 409 <p>
315 Public method to get the real identity name. 410 Public method to get the real identity name.
316 </p><dl> 411 </p>
412 <dl>
317 <dt>Returns:</dt> 413 <dt>Returns:</dt>
318 <dd> 414 <dd>
319 real identity name (string) 415 real identity name (string)
320 </dd> 416 </dd>
321 </dl><a NAME="IrcIdentity.getName" ID="IrcIdentity.getName"></a> 417 </dl>
418 <a NAME="IrcIdentity.getName" ID="IrcIdentity.getName"></a>
322 <h4>IrcIdentity.getName</h4> 419 <h4>IrcIdentity.getName</h4>
323 <b>getName</b>(<i></i>) 420 <b>getName</b>(<i></i>)
421
324 <p> 422 <p>
325 Public method to get the identity name. 423 Public method to get the identity name.
326 </p><dl> 424 </p>
425 <dl>
327 <dt>Returns:</dt> 426 <dt>Returns:</dt>
328 <dd> 427 <dd>
329 identity name (string) 428 identity name (string)
330 </dd> 429 </dd>
331 </dl><a NAME="IrcIdentity.getNickNames" ID="IrcIdentity.getNickNames"></a> 430 </dl>
431 <a NAME="IrcIdentity.getNickNames" ID="IrcIdentity.getNickNames"></a>
332 <h4>IrcIdentity.getNickNames</h4> 432 <h4>IrcIdentity.getNickNames</h4>
333 <b>getNickNames</b>(<i></i>) 433 <b>getNickNames</b>(<i></i>)
434
334 <p> 435 <p>
335 Public method to get the nick names. 436 Public method to get the nick names.
336 </p><dl> 437 </p>
438 <dl>
337 <dt>Returns:</dt> 439 <dt>Returns:</dt>
338 <dd> 440 <dd>
339 nick names (list of string) 441 nick names (list of string)
340 </dd> 442 </dd>
341 </dl><a NAME="IrcIdentity.getPartMessage" ID="IrcIdentity.getPartMessage"></a> 443 </dl>
444 <a NAME="IrcIdentity.getPartMessage" ID="IrcIdentity.getPartMessage"></a>
342 <h4>IrcIdentity.getPartMessage</h4> 445 <h4>IrcIdentity.getPartMessage</h4>
343 <b>getPartMessage</b>(<i></i>) 446 <b>getPartMessage</b>(<i></i>)
447
344 <p> 448 <p>
345 Public method to get the PART message. 449 Public method to get the PART message.
346 </p><dl> 450 </p>
451 <dl>
347 <dt>Returns:</dt> 452 <dt>Returns:</dt>
348 <dd> 453 <dd>
349 PART message (string) 454 PART message (string)
350 </dd> 455 </dd>
351 </dl><a NAME="IrcIdentity.getPassword" ID="IrcIdentity.getPassword"></a> 456 </dl>
457 <a NAME="IrcIdentity.getPassword" ID="IrcIdentity.getPassword"></a>
352 <h4>IrcIdentity.getPassword</h4> 458 <h4>IrcIdentity.getPassword</h4>
353 <b>getPassword</b>(<i></i>) 459 <b>getPassword</b>(<i></i>)
460
354 <p> 461 <p>
355 Public method to get the password. 462 Public method to get the password.
356 </p><dl> 463 </p>
464 <dl>
357 <dt>Returns:</dt> 465 <dt>Returns:</dt>
358 <dd> 466 <dd>
359 password (string) 467 password (string)
360 </dd> 468 </dd>
361 </dl><a NAME="IrcIdentity.getQuitMessage" ID="IrcIdentity.getQuitMessage"></a> 469 </dl>
470 <a NAME="IrcIdentity.getQuitMessage" ID="IrcIdentity.getQuitMessage"></a>
362 <h4>IrcIdentity.getQuitMessage</h4> 471 <h4>IrcIdentity.getQuitMessage</h4>
363 <b>getQuitMessage</b>(<i></i>) 472 <b>getQuitMessage</b>(<i></i>)
473
364 <p> 474 <p>
365 Public method to get the QUIT message. 475 Public method to get the QUIT message.
366 </p><dl> 476 </p>
477 <dl>
367 <dt>Returns:</dt> 478 <dt>Returns:</dt>
368 <dd> 479 <dd>
369 QUIT message (string) 480 QUIT message (string)
370 </dd> 481 </dd>
371 </dl><a NAME="IrcIdentity.getRealName" ID="IrcIdentity.getRealName"></a> 482 </dl>
483 <a NAME="IrcIdentity.getRealName" ID="IrcIdentity.getRealName"></a>
372 <h4>IrcIdentity.getRealName</h4> 484 <h4>IrcIdentity.getRealName</h4>
373 <b>getRealName</b>(<i></i>) 485 <b>getRealName</b>(<i></i>)
486
374 <p> 487 <p>
375 Public method to get the real name. 488 Public method to get the real name.
376 </p><dl> 489 </p>
490 <dl>
377 <dt>Returns:</dt> 491 <dt>Returns:</dt>
378 <dd> 492 <dd>
379 real name (string) 493 real name (string)
380 </dd> 494 </dd>
381 </dl><a NAME="IrcIdentity.getServiceName" ID="IrcIdentity.getServiceName"></a> 495 </dl>
496 <a NAME="IrcIdentity.getServiceName" ID="IrcIdentity.getServiceName"></a>
382 <h4>IrcIdentity.getServiceName</h4> 497 <h4>IrcIdentity.getServiceName</h4>
383 <b>getServiceName</b>(<i></i>) 498 <b>getServiceName</b>(<i></i>)
499
384 <p> 500 <p>
385 Public method to get the service name of the identity used for 501 Public method to get the service name of the identity used for
386 identification. 502 identification.
387 </p><dl> 503 </p>
504 <dl>
388 <dt>Returns:</dt> 505 <dt>Returns:</dt>
389 <dd> 506 <dd>
390 service name (string) 507 service name (string)
391 </dd> 508 </dd>
392 </dl><a NAME="IrcIdentity.load" ID="IrcIdentity.load"></a> 509 </dl>
510 <a NAME="IrcIdentity.load" ID="IrcIdentity.load"></a>
393 <h4>IrcIdentity.load</h4> 511 <h4>IrcIdentity.load</h4>
394 <b>load</b>(<i>settings</i>) 512 <b>load</b>(<i>settings</i>)
513
395 <p> 514 <p>
396 Public method to load the identity data. 515 Public method to load the identity data.
397 </p><dl> 516 </p>
517 <dl>
518
398 <dt><i>settings</i></dt> 519 <dt><i>settings</i></dt>
399 <dd> 520 <dd>
400 reference to the settings object (QSettings) 521 reference to the settings object (QSettings)
401 </dd> 522 </dd>
402 </dl><a NAME="IrcIdentity.rememberAwayPosition" ID="IrcIdentity.rememberAwayPosition"></a> 523 </dl>
524 <a NAME="IrcIdentity.rememberAwayPosition" ID="IrcIdentity.rememberAwayPosition"></a>
403 <h4>IrcIdentity.rememberAwayPosition</h4> 525 <h4>IrcIdentity.rememberAwayPosition</h4>
404 <b>rememberAwayPosition</b>(<i></i>) 526 <b>rememberAwayPosition</b>(<i></i>)
527
405 <p> 528 <p>
406 Public method to get a flag indicating to remember the chat position 529 Public method to get a flag indicating to remember the chat position
407 upon AWAY. 530 upon AWAY.
408 </p><dl> 531 </p>
532 <dl>
409 <dt>Returns:</dt> 533 <dt>Returns:</dt>
410 <dd> 534 <dd>
411 flag indicating to remember the chat position (boolean) 535 flag indicating to remember the chat position (boolean)
412 </dd> 536 </dd>
413 </dl><a NAME="IrcIdentity.save" ID="IrcIdentity.save"></a> 537 </dl>
538 <a NAME="IrcIdentity.save" ID="IrcIdentity.save"></a>
414 <h4>IrcIdentity.save</h4> 539 <h4>IrcIdentity.save</h4>
415 <b>save</b>(<i>settings</i>) 540 <b>save</b>(<i>settings</i>)
541
416 <p> 542 <p>
417 Public method to save the identity data. 543 Public method to save the identity data.
418 </p><dl> 544 </p>
545 <dl>
546
419 <dt><i>settings</i></dt> 547 <dt><i>settings</i></dt>
420 <dd> 548 <dd>
421 reference to the settings object (QSettings) 549 reference to the settings object (QSettings)
422 </dd> 550 </dd>
423 </dl><a NAME="IrcIdentity.setAwayMessage" ID="IrcIdentity.setAwayMessage"></a> 551 </dl>
552 <a NAME="IrcIdentity.setAwayMessage" ID="IrcIdentity.setAwayMessage"></a>
424 <h4>IrcIdentity.setAwayMessage</h4> 553 <h4>IrcIdentity.setAwayMessage</h4>
425 <b>setAwayMessage</b>(<i>message</i>) 554 <b>setAwayMessage</b>(<i>message</i>)
555
426 <p> 556 <p>
427 Public method to set the AWAY message. 557 Public method to set the AWAY message.
428 </p><dl> 558 </p>
559 <dl>
560
429 <dt><i>message</i></dt> 561 <dt><i>message</i></dt>
430 <dd> 562 <dd>
431 AWAY message (string) 563 AWAY message (string)
432 </dd> 564 </dd>
433 </dl><a NAME="IrcIdentity.setIdent" ID="IrcIdentity.setIdent"></a> 565 </dl>
566 <a NAME="IrcIdentity.setIdent" ID="IrcIdentity.setIdent"></a>
434 <h4>IrcIdentity.setIdent</h4> 567 <h4>IrcIdentity.setIdent</h4>
435 <b>setIdent</b>(<i>name</i>) 568 <b>setIdent</b>(<i>name</i>)
569
436 <p> 570 <p>
437 Public method to set the real identity name. 571 Public method to set the real identity name.
438 </p><dl> 572 </p>
573 <dl>
574
439 <dt><i>name</i></dt> 575 <dt><i>name</i></dt>
440 <dd> 576 <dd>
441 real identity name (string) 577 real identity name (string)
442 </dd> 578 </dd>
443 </dl><a NAME="IrcIdentity.setName" ID="IrcIdentity.setName"></a> 579 </dl>
580 <a NAME="IrcIdentity.setName" ID="IrcIdentity.setName"></a>
444 <h4>IrcIdentity.setName</h4> 581 <h4>IrcIdentity.setName</h4>
445 <b>setName</b>(<i>name</i>) 582 <b>setName</b>(<i>name</i>)
583
446 <p> 584 <p>
447 Public method to set the identity name. 585 Public method to set the identity name.
448 </p><dl> 586 </p>
587 <dl>
588
449 <dt><i>name</i></dt> 589 <dt><i>name</i></dt>
450 <dd> 590 <dd>
451 identity name (string) 591 identity name (string)
452 </dd> 592 </dd>
453 </dl><a NAME="IrcIdentity.setNickNames" ID="IrcIdentity.setNickNames"></a> 593 </dl>
594 <a NAME="IrcIdentity.setNickNames" ID="IrcIdentity.setNickNames"></a>
454 <h4>IrcIdentity.setNickNames</h4> 595 <h4>IrcIdentity.setNickNames</h4>
455 <b>setNickNames</b>(<i>names</i>) 596 <b>setNickNames</b>(<i>names</i>)
597
456 <p> 598 <p>
457 Public method to set the nick names of the identity. 599 Public method to set the nick names of the identity.
458 </p><dl> 600 </p>
601 <dl>
602
459 <dt><i>names</i></dt> 603 <dt><i>names</i></dt>
460 <dd> 604 <dd>
461 nick names (list of string) 605 nick names (list of string)
462 </dd> 606 </dd>
463 </dl><a NAME="IrcIdentity.setPartMessage" ID="IrcIdentity.setPartMessage"></a> 607 </dl>
608 <a NAME="IrcIdentity.setPartMessage" ID="IrcIdentity.setPartMessage"></a>
464 <h4>IrcIdentity.setPartMessage</h4> 609 <h4>IrcIdentity.setPartMessage</h4>
465 <b>setPartMessage</b>(<i>message</i>) 610 <b>setPartMessage</b>(<i>message</i>)
611
466 <p> 612 <p>
467 Public method to set the PART message. 613 Public method to set the PART message.
468 </p><dl> 614 </p>
615 <dl>
616
469 <dt><i>message</i></dt> 617 <dt><i>message</i></dt>
470 <dd> 618 <dd>
471 PART message (string) 619 PART message (string)
472 </dd> 620 </dd>
473 </dl><a NAME="IrcIdentity.setPassword" ID="IrcIdentity.setPassword"></a> 621 </dl>
622 <a NAME="IrcIdentity.setPassword" ID="IrcIdentity.setPassword"></a>
474 <h4>IrcIdentity.setPassword</h4> 623 <h4>IrcIdentity.setPassword</h4>
475 <b>setPassword</b>(<i>password</i>) 624 <b>setPassword</b>(<i>password</i>)
625
476 <p> 626 <p>
477 Public method to set a new password. 627 Public method to set a new password.
478 </p><dl> 628 </p>
629 <dl>
630
479 <dt><i>password</i></dt> 631 <dt><i>password</i></dt>
480 <dd> 632 <dd>
481 password to set (string) 633 password to set (string)
482 </dd> 634 </dd>
483 </dl><a NAME="IrcIdentity.setQuitMessage" ID="IrcIdentity.setQuitMessage"></a> 635 </dl>
636 <a NAME="IrcIdentity.setQuitMessage" ID="IrcIdentity.setQuitMessage"></a>
484 <h4>IrcIdentity.setQuitMessage</h4> 637 <h4>IrcIdentity.setQuitMessage</h4>
485 <b>setQuitMessage</b>(<i>message</i>) 638 <b>setQuitMessage</b>(<i>message</i>)
639
486 <p> 640 <p>
487 Public method to set the QUIT message. 641 Public method to set the QUIT message.
488 </p><dl> 642 </p>
643 <dl>
644
489 <dt><i>message</i></dt> 645 <dt><i>message</i></dt>
490 <dd> 646 <dd>
491 QUIT message (string) 647 QUIT message (string)
492 </dd> 648 </dd>
493 </dl><a NAME="IrcIdentity.setRealName" ID="IrcIdentity.setRealName"></a> 649 </dl>
650 <a NAME="IrcIdentity.setRealName" ID="IrcIdentity.setRealName"></a>
494 <h4>IrcIdentity.setRealName</h4> 651 <h4>IrcIdentity.setRealName</h4>
495 <b>setRealName</b>(<i>name</i>) 652 <b>setRealName</b>(<i>name</i>)
653
496 <p> 654 <p>
497 Public method to set the real name of the identity. 655 Public method to set the real name of the identity.
498 </p><dl> 656 </p>
657 <dl>
658
499 <dt><i>name</i></dt> 659 <dt><i>name</i></dt>
500 <dd> 660 <dd>
501 real name (string) 661 real name (string)
502 </dd> 662 </dd>
503 </dl><a NAME="IrcIdentity.setRememberAwayPosition" ID="IrcIdentity.setRememberAwayPosition"></a> 663 </dl>
664 <a NAME="IrcIdentity.setRememberAwayPosition" ID="IrcIdentity.setRememberAwayPosition"></a>
504 <h4>IrcIdentity.setRememberAwayPosition</h4> 665 <h4>IrcIdentity.setRememberAwayPosition</h4>
505 <b>setRememberAwayPosition</b>(<i>remember</i>) 666 <b>setRememberAwayPosition</b>(<i>remember</i>)
667
506 <p> 668 <p>
507 Public method to set to remember the chat position upon AWAY. 669 Public method to set to remember the chat position upon AWAY.
508 </p><dl> 670 </p>
671 <dl>
672
509 <dt><i>remember</i></dt> 673 <dt><i>remember</i></dt>
510 <dd> 674 <dd>
511 flag indicating to remember the chat position (boolean) 675 flag indicating to remember the chat position (boolean)
512 </dd> 676 </dd>
513 </dl><a NAME="IrcIdentity.setServiceName" ID="IrcIdentity.setServiceName"></a> 677 </dl>
678 <a NAME="IrcIdentity.setServiceName" ID="IrcIdentity.setServiceName"></a>
514 <h4>IrcIdentity.setServiceName</h4> 679 <h4>IrcIdentity.setServiceName</h4>
515 <b>setServiceName</b>(<i>name</i>) 680 <b>setServiceName</b>(<i>name</i>)
681
516 <p> 682 <p>
517 Public method to set the service name of the identity used for 683 Public method to set the service name of the identity used for
518 identification. 684 identification.
519 </p><dl> 685 </p>
686 <dl>
687
520 <dt><i>name</i></dt> 688 <dt><i>name</i></dt>
521 <dd> 689 <dd>
522 service name (string) 690 service name (string)
523 </dd> 691 </dd>
524 </dl> 692 </dl>
525 <div align="right"><a href="#top">Up</a></div> 693 <div align="right"><a href="#top">Up</a></div>
526 <hr /><hr /> 694 <hr />
695 <hr />
527 <a NAME="IrcNetwork" ID="IrcNetwork"></a> 696 <a NAME="IrcNetwork" ID="IrcNetwork"></a>
528 <h2>IrcNetwork</h2> 697 <h2>IrcNetwork</h2>
698
529 <p> 699 <p>
530 Class implementing the IRC network object. 700 Class implementing the IRC network object.
531 </p> 701 </p>
532 <h3>Derived from</h3> 702 <h3>Derived from</h3>
533 object 703 object
534 <h3>Class Attributes</h3> 704 <h3>Class Attributes</h3>
705
535 <table> 706 <table>
536 <tr><td>None</td></tr> 707 <tr><td>None</td></tr>
537 </table> 708 </table>
538 <h3>Class Methods</h3> 709 <h3>Class Methods</h3>
539 <table> 710
711 <table>
712
540 <tr> 713 <tr>
541 <td><a href="#IrcNetwork.createDefaultNetwork">createDefaultNetwork</a></td> 714 <td><a href="#IrcNetwork.createDefaultNetwork">createDefaultNetwork</a></td>
542 <td>Class method to create the default network.</td> 715 <td>Class method to create the default network.</td>
543 </tr> 716 </tr>
544 </table> 717 </table>
545 <h3>Methods</h3> 718 <h3>Methods</h3>
546 <table> 719
720 <table>
721
547 <tr> 722 <tr>
548 <td><a href="#IrcNetwork.__init__">IrcNetwork</a></td> 723 <td><a href="#IrcNetwork.__init__">IrcNetwork</a></td>
549 <td>Constructor</td> 724 <td>Constructor</td>
550 </tr><tr> 725 </tr>
726 <tr>
551 <td><a href="#IrcNetwork.addChannel">addChannel</a></td> 727 <td><a href="#IrcNetwork.addChannel">addChannel</a></td>
552 <td>Public method to add a channel.</td> 728 <td>Public method to add a channel.</td>
553 </tr><tr> 729 </tr>
730 <tr>
554 <td><a href="#IrcNetwork.autoConnect">autoConnect</a></td> 731 <td><a href="#IrcNetwork.autoConnect">autoConnect</a></td>
555 <td>Public method to check, if the network should be connected to at start-up.</td> 732 <td>Public method to check, if the network should be connected to at start-up.</td>
556 </tr><tr> 733 </tr>
734 <tr>
557 <td><a href="#IrcNetwork.deleteChannel">deleteChannel</a></td> 735 <td><a href="#IrcNetwork.deleteChannel">deleteChannel</a></td>
558 <td>Public method to delete the given channel.</td> 736 <td>Public method to delete the given channel.</td>
559 </tr><tr> 737 </tr>
738 <tr>
560 <td><a href="#IrcNetwork.getChannel">getChannel</a></td> 739 <td><a href="#IrcNetwork.getChannel">getChannel</a></td>
561 <td>Public method to get a channel.</td> 740 <td>Public method to get a channel.</td>
562 </tr><tr> 741 </tr>
742 <tr>
563 <td><a href="#IrcNetwork.getChannelNames">getChannelNames</a></td> 743 <td><a href="#IrcNetwork.getChannelNames">getChannelNames</a></td>
564 <td>Public method to get the list of channels.</td> 744 <td>Public method to get the list of channels.</td>
565 </tr><tr> 745 </tr>
746 <tr>
566 <td><a href="#IrcNetwork.getChannels">getChannels</a></td> 747 <td><a href="#IrcNetwork.getChannels">getChannels</a></td>
567 <td>Public method to get the channels.</td> 748 <td>Public method to get the channels.</td>
568 </tr><tr> 749 </tr>
750 <tr>
569 <td><a href="#IrcNetwork.getIdentityName">getIdentityName</a></td> 751 <td><a href="#IrcNetwork.getIdentityName">getIdentityName</a></td>
570 <td>Public method to get the name of the identity.</td> 752 <td>Public method to get the name of the identity.</td>
571 </tr><tr> 753 </tr>
754 <tr>
572 <td><a href="#IrcNetwork.getName">getName</a></td> 755 <td><a href="#IrcNetwork.getName">getName</a></td>
573 <td>Public method to get the network name.</td> 756 <td>Public method to get the network name.</td>
574 </tr><tr> 757 </tr>
758 <tr>
575 <td><a href="#IrcNetwork.getServer">getServer</a></td> 759 <td><a href="#IrcNetwork.getServer">getServer</a></td>
576 <td>Public method to get the server object.</td> 760 <td>Public method to get the server object.</td>
577 </tr><tr> 761 </tr>
762 <tr>
578 <td><a href="#IrcNetwork.getServerName">getServerName</a></td> 763 <td><a href="#IrcNetwork.getServerName">getServerName</a></td>
579 <td>Public method to get the server name.</td> 764 <td>Public method to get the server name.</td>
580 </tr><tr> 765 </tr>
766 <tr>
581 <td><a href="#IrcNetwork.load">load</a></td> 767 <td><a href="#IrcNetwork.load">load</a></td>
582 <td>Public method to load the network data.</td> 768 <td>Public method to load the network data.</td>
583 </tr><tr> 769 </tr>
770 <tr>
584 <td><a href="#IrcNetwork.save">save</a></td> 771 <td><a href="#IrcNetwork.save">save</a></td>
585 <td>Public method to save the network data.</td> 772 <td>Public method to save the network data.</td>
586 </tr><tr> 773 </tr>
774 <tr>
587 <td><a href="#IrcNetwork.setAutoConnect">setAutoConnect</a></td> 775 <td><a href="#IrcNetwork.setAutoConnect">setAutoConnect</a></td>
588 <td>Public method to set the auto connect flag.</td> 776 <td>Public method to set the auto connect flag.</td>
589 </tr><tr> 777 </tr>
778 <tr>
590 <td><a href="#IrcNetwork.setChannel">setChannel</a></td> 779 <td><a href="#IrcNetwork.setChannel">setChannel</a></td>
591 <td>Public method to set a channel.</td> 780 <td>Public method to set a channel.</td>
592 </tr><tr> 781 </tr>
782 <tr>
593 <td><a href="#IrcNetwork.setChannels">setChannels</a></td> 783 <td><a href="#IrcNetwork.setChannels">setChannels</a></td>
594 <td>Public method to set the list of channels.</td> 784 <td>Public method to set the list of channels.</td>
595 </tr><tr> 785 </tr>
786 <tr>
596 <td><a href="#IrcNetwork.setIdentityName">setIdentityName</a></td> 787 <td><a href="#IrcNetwork.setIdentityName">setIdentityName</a></td>
597 <td>Public method to set the name of the identity.</td> 788 <td>Public method to set the name of the identity.</td>
598 </tr><tr> 789 </tr>
790 <tr>
599 <td><a href="#IrcNetwork.setName">setName</a></td> 791 <td><a href="#IrcNetwork.setName">setName</a></td>
600 <td>Public method to set the network name.</td> 792 <td>Public method to set the network name.</td>
601 </tr><tr> 793 </tr>
794 <tr>
602 <td><a href="#IrcNetwork.setServer">setServer</a></td> 795 <td><a href="#IrcNetwork.setServer">setServer</a></td>
603 <td>Public method to set the server.</td> 796 <td>Public method to set the server.</td>
604 </tr> 797 </tr>
605 </table> 798 </table>
606 <h3>Static Methods</h3> 799 <h3>Static Methods</h3>
800
607 <table> 801 <table>
608 <tr><td>None</td></tr> 802 <tr><td>None</td></tr>
609 </table> 803 </table>
804
610 <a NAME="IrcNetwork.createDefaultNetwork" ID="IrcNetwork.createDefaultNetwork"></a> 805 <a NAME="IrcNetwork.createDefaultNetwork" ID="IrcNetwork.createDefaultNetwork"></a>
611 <h4>IrcNetwork.createDefaultNetwork (class method)</h4> 806 <h4>IrcNetwork.createDefaultNetwork (class method)</h4>
612 <b>createDefaultNetwork</b>(<i>ssl=False</i>) 807 <b>createDefaultNetwork</b>(<i>ssl=False</i>)
808
613 <p> 809 <p>
614 Class method to create the default network. 810 Class method to create the default network.
615 </p><dl> 811 </p>
812 <dl>
813
616 <dt><i>ssl</i></dt> 814 <dt><i>ssl</i></dt>
617 <dd> 815 <dd>
618 flag indicating to create a SSL network configuration 816 flag indicating to create a SSL network configuration
619 (boolean) 817 (boolean)
620 </dd> 818 </dd>
621 </dl><dl> 819 </dl>
820 <dl>
622 <dt>Returns:</dt> 821 <dt>Returns:</dt>
623 <dd> 822 <dd>
624 default network object (IrcNetwork) 823 default network object (IrcNetwork)
625 </dd> 824 </dd>
626 </dl><a NAME="IrcNetwork.__init__" ID="IrcNetwork.__init__"></a> 825 </dl>
826 <a NAME="IrcNetwork.__init__" ID="IrcNetwork.__init__"></a>
627 <h4>IrcNetwork (Constructor)</h4> 827 <h4>IrcNetwork (Constructor)</h4>
628 <b>IrcNetwork</b>(<i>name</i>) 828 <b>IrcNetwork</b>(<i>name</i>)
829
629 <p> 830 <p>
630 Constructor 831 Constructor
631 </p><dl> 832 </p>
833 <dl>
834
632 <dt><i>name</i></dt> 835 <dt><i>name</i></dt>
633 <dd> 836 <dd>
634 name of the network (string) 837 name of the network (string)
635 </dd> 838 </dd>
636 </dl><a NAME="IrcNetwork.addChannel" ID="IrcNetwork.addChannel"></a> 839 </dl>
840 <a NAME="IrcNetwork.addChannel" ID="IrcNetwork.addChannel"></a>
637 <h4>IrcNetwork.addChannel</h4> 841 <h4>IrcNetwork.addChannel</h4>
638 <b>addChannel</b>(<i>channel</i>) 842 <b>addChannel</b>(<i>channel</i>)
843
639 <p> 844 <p>
640 Public method to add a channel. 845 Public method to add a channel.
641 </p><dl> 846 </p>
847 <dl>
848
642 <dt><i>channel</i></dt> 849 <dt><i>channel</i></dt>
643 <dd> 850 <dd>
644 channel object to add (IrcChannel) 851 channel object to add (IrcChannel)
645 </dd> 852 </dd>
646 </dl><a NAME="IrcNetwork.autoConnect" ID="IrcNetwork.autoConnect"></a> 853 </dl>
854 <a NAME="IrcNetwork.autoConnect" ID="IrcNetwork.autoConnect"></a>
647 <h4>IrcNetwork.autoConnect</h4> 855 <h4>IrcNetwork.autoConnect</h4>
648 <b>autoConnect</b>(<i></i>) 856 <b>autoConnect</b>(<i></i>)
857
649 <p> 858 <p>
650 Public method to check, if the network should be connected to at 859 Public method to check, if the network should be connected to at
651 start-up. 860 start-up.
652 </p><dl> 861 </p>
862 <dl>
653 <dt>Returns:</dt> 863 <dt>Returns:</dt>
654 <dd> 864 <dd>
655 flag indicating an auto connect (boolean) 865 flag indicating an auto connect (boolean)
656 </dd> 866 </dd>
657 </dl><a NAME="IrcNetwork.deleteChannel" ID="IrcNetwork.deleteChannel"></a> 867 </dl>
868 <a NAME="IrcNetwork.deleteChannel" ID="IrcNetwork.deleteChannel"></a>
658 <h4>IrcNetwork.deleteChannel</h4> 869 <h4>IrcNetwork.deleteChannel</h4>
659 <b>deleteChannel</b>(<i>channelName</i>) 870 <b>deleteChannel</b>(<i>channelName</i>)
871
660 <p> 872 <p>
661 Public method to delete the given channel. 873 Public method to delete the given channel.
662 </p><dl> 874 </p>
875 <dl>
876
663 <dt><i>channelName</i></dt> 877 <dt><i>channelName</i></dt>
664 <dd> 878 <dd>
665 name of the channel to be deleted (string) 879 name of the channel to be deleted (string)
666 </dd> 880 </dd>
667 </dl><a NAME="IrcNetwork.getChannel" ID="IrcNetwork.getChannel"></a> 881 </dl>
882 <a NAME="IrcNetwork.getChannel" ID="IrcNetwork.getChannel"></a>
668 <h4>IrcNetwork.getChannel</h4> 883 <h4>IrcNetwork.getChannel</h4>
669 <b>getChannel</b>(<i>channelName</i>) 884 <b>getChannel</b>(<i>channelName</i>)
885
670 <p> 886 <p>
671 Public method to get a channel. 887 Public method to get a channel.
672 </p><dl> 888 </p>
889 <dl>
890
673 <dt><i>channelName</i></dt> 891 <dt><i>channelName</i></dt>
674 <dd> 892 <dd>
675 name of the channel to retrieve (string) 893 name of the channel to retrieve (string)
676 </dd> 894 </dd>
677 </dl><dl> 895 </dl>
896 <dl>
678 <dt>Returns:</dt> 897 <dt>Returns:</dt>
679 <dd> 898 <dd>
680 reference to the channel (IrcChannel) 899 reference to the channel (IrcChannel)
681 </dd> 900 </dd>
682 </dl><a NAME="IrcNetwork.getChannelNames" ID="IrcNetwork.getChannelNames"></a> 901 </dl>
902 <a NAME="IrcNetwork.getChannelNames" ID="IrcNetwork.getChannelNames"></a>
683 <h4>IrcNetwork.getChannelNames</h4> 903 <h4>IrcNetwork.getChannelNames</h4>
684 <b>getChannelNames</b>(<i></i>) 904 <b>getChannelNames</b>(<i></i>)
905
685 <p> 906 <p>
686 Public method to get the list of channels. 907 Public method to get the list of channels.
687 </p><dl> 908 </p>
909 <dl>
688 <dt>Returns:</dt> 910 <dt>Returns:</dt>
689 <dd> 911 <dd>
690 list of channel names (list of string) 912 list of channel names (list of string)
691 </dd> 913 </dd>
692 </dl><a NAME="IrcNetwork.getChannels" ID="IrcNetwork.getChannels"></a> 914 </dl>
915 <a NAME="IrcNetwork.getChannels" ID="IrcNetwork.getChannels"></a>
693 <h4>IrcNetwork.getChannels</h4> 916 <h4>IrcNetwork.getChannels</h4>
694 <b>getChannels</b>(<i></i>) 917 <b>getChannels</b>(<i></i>)
918
695 <p> 919 <p>
696 Public method to get the channels. 920 Public method to get the channels.
697 </p><dl> 921 </p>
922 <dl>
698 <dt>Returns:</dt> 923 <dt>Returns:</dt>
699 <dd> 924 <dd>
700 list of channels for the network (list of IrcChannel) 925 list of channels for the network (list of IrcChannel)
701 </dd> 926 </dd>
702 </dl><a NAME="IrcNetwork.getIdentityName" ID="IrcNetwork.getIdentityName"></a> 927 </dl>
928 <a NAME="IrcNetwork.getIdentityName" ID="IrcNetwork.getIdentityName"></a>
703 <h4>IrcNetwork.getIdentityName</h4> 929 <h4>IrcNetwork.getIdentityName</h4>
704 <b>getIdentityName</b>(<i></i>) 930 <b>getIdentityName</b>(<i></i>)
931
705 <p> 932 <p>
706 Public method to get the name of the identity. 933 Public method to get the name of the identity.
707 </p><dl> 934 </p>
935 <dl>
708 <dt>Returns:</dt> 936 <dt>Returns:</dt>
709 <dd> 937 <dd>
710 identity name (string) 938 identity name (string)
711 </dd> 939 </dd>
712 </dl><a NAME="IrcNetwork.getName" ID="IrcNetwork.getName"></a> 940 </dl>
941 <a NAME="IrcNetwork.getName" ID="IrcNetwork.getName"></a>
713 <h4>IrcNetwork.getName</h4> 942 <h4>IrcNetwork.getName</h4>
714 <b>getName</b>(<i></i>) 943 <b>getName</b>(<i></i>)
944
715 <p> 945 <p>
716 Public method to get the network name. 946 Public method to get the network name.
717 </p><dl> 947 </p>
948 <dl>
718 <dt>Returns:</dt> 949 <dt>Returns:</dt>
719 <dd> 950 <dd>
720 network name (string) 951 network name (string)
721 </dd> 952 </dd>
722 </dl><a NAME="IrcNetwork.getServer" ID="IrcNetwork.getServer"></a> 953 </dl>
954 <a NAME="IrcNetwork.getServer" ID="IrcNetwork.getServer"></a>
723 <h4>IrcNetwork.getServer</h4> 955 <h4>IrcNetwork.getServer</h4>
724 <b>getServer</b>(<i></i>) 956 <b>getServer</b>(<i></i>)
957
725 <p> 958 <p>
726 Public method to get the server object. 959 Public method to get the server object.
727 </p><dl> 960 </p>
961 <dl>
728 <dt>Returns:</dt> 962 <dt>Returns:</dt>
729 <dd> 963 <dd>
730 reference to the server (IrcServer) 964 reference to the server (IrcServer)
731 </dd> 965 </dd>
732 </dl><a NAME="IrcNetwork.getServerName" ID="IrcNetwork.getServerName"></a> 966 </dl>
967 <a NAME="IrcNetwork.getServerName" ID="IrcNetwork.getServerName"></a>
733 <h4>IrcNetwork.getServerName</h4> 968 <h4>IrcNetwork.getServerName</h4>
734 <b>getServerName</b>(<i></i>) 969 <b>getServerName</b>(<i></i>)
970
735 <p> 971 <p>
736 Public method to get the server name. 972 Public method to get the server name.
737 </p><dl> 973 </p>
974 <dl>
738 <dt>Returns:</dt> 975 <dt>Returns:</dt>
739 <dd> 976 <dd>
740 server name (string) 977 server name (string)
741 </dd> 978 </dd>
742 </dl><a NAME="IrcNetwork.load" ID="IrcNetwork.load"></a> 979 </dl>
980 <a NAME="IrcNetwork.load" ID="IrcNetwork.load"></a>
743 <h4>IrcNetwork.load</h4> 981 <h4>IrcNetwork.load</h4>
744 <b>load</b>(<i>settings</i>) 982 <b>load</b>(<i>settings</i>)
983
745 <p> 984 <p>
746 Public method to load the network data. 985 Public method to load the network data.
747 </p><dl> 986 </p>
987 <dl>
988
748 <dt><i>settings</i></dt> 989 <dt><i>settings</i></dt>
749 <dd> 990 <dd>
750 reference to the settings object (QSettings) 991 reference to the settings object (QSettings)
751 </dd> 992 </dd>
752 </dl><a NAME="IrcNetwork.save" ID="IrcNetwork.save"></a> 993 </dl>
994 <a NAME="IrcNetwork.save" ID="IrcNetwork.save"></a>
753 <h4>IrcNetwork.save</h4> 995 <h4>IrcNetwork.save</h4>
754 <b>save</b>(<i>settings</i>) 996 <b>save</b>(<i>settings</i>)
997
755 <p> 998 <p>
756 Public method to save the network data. 999 Public method to save the network data.
757 </p><dl> 1000 </p>
1001 <dl>
1002
758 <dt><i>settings</i></dt> 1003 <dt><i>settings</i></dt>
759 <dd> 1004 <dd>
760 reference to the settings object (QSettings) 1005 reference to the settings object (QSettings)
761 </dd> 1006 </dd>
762 </dl><a NAME="IrcNetwork.setAutoConnect" ID="IrcNetwork.setAutoConnect"></a> 1007 </dl>
1008 <a NAME="IrcNetwork.setAutoConnect" ID="IrcNetwork.setAutoConnect"></a>
763 <h4>IrcNetwork.setAutoConnect</h4> 1009 <h4>IrcNetwork.setAutoConnect</h4>
764 <b>setAutoConnect</b>(<i>enable</i>) 1010 <b>setAutoConnect</b>(<i>enable</i>)
1011
765 <p> 1012 <p>
766 Public method to set the auto connect flag. 1013 Public method to set the auto connect flag.
767 </p><dl> 1014 </p>
1015 <dl>
1016
768 <dt><i>enable</i></dt> 1017 <dt><i>enable</i></dt>
769 <dd> 1018 <dd>
770 flag indicate to connect to the network at start-up. 1019 flag indicate to connect to the network at start-up.
771 </dd> 1020 </dd>
772 </dl><a NAME="IrcNetwork.setChannel" ID="IrcNetwork.setChannel"></a> 1021 </dl>
1022 <a NAME="IrcNetwork.setChannel" ID="IrcNetwork.setChannel"></a>
773 <h4>IrcNetwork.setChannel</h4> 1023 <h4>IrcNetwork.setChannel</h4>
774 <b>setChannel</b>(<i>channel</i>) 1024 <b>setChannel</b>(<i>channel</i>)
1025
775 <p> 1026 <p>
776 Public method to set a channel. 1027 Public method to set a channel.
777 </p><dl> 1028 </p>
1029 <dl>
1030
778 <dt><i>channel</i></dt> 1031 <dt><i>channel</i></dt>
779 <dd> 1032 <dd>
780 channel object to set (IrcChannel) 1033 channel object to set (IrcChannel)
781 </dd> 1034 </dd>
782 </dl><a NAME="IrcNetwork.setChannels" ID="IrcNetwork.setChannels"></a> 1035 </dl>
1036 <a NAME="IrcNetwork.setChannels" ID="IrcNetwork.setChannels"></a>
783 <h4>IrcNetwork.setChannels</h4> 1037 <h4>IrcNetwork.setChannels</h4>
784 <b>setChannels</b>(<i>channels</i>) 1038 <b>setChannels</b>(<i>channels</i>)
1039
785 <p> 1040 <p>
786 Public method to set the list of channels. 1041 Public method to set the list of channels.
787 </p><dl> 1042 </p>
1043 <dl>
1044
788 <dt><i>channels</i></dt> 1045 <dt><i>channels</i></dt>
789 <dd> 1046 <dd>
790 list of channels for the network (list of IrcChannel) 1047 list of channels for the network (list of IrcChannel)
791 </dd> 1048 </dd>
792 </dl><a NAME="IrcNetwork.setIdentityName" ID="IrcNetwork.setIdentityName"></a> 1049 </dl>
1050 <a NAME="IrcNetwork.setIdentityName" ID="IrcNetwork.setIdentityName"></a>
793 <h4>IrcNetwork.setIdentityName</h4> 1051 <h4>IrcNetwork.setIdentityName</h4>
794 <b>setIdentityName</b>(<i>name</i>) 1052 <b>setIdentityName</b>(<i>name</i>)
1053
795 <p> 1054 <p>
796 Public method to set the name of the identity. 1055 Public method to set the name of the identity.
797 </p><dl> 1056 </p>
1057 <dl>
1058
798 <dt><i>name</i></dt> 1059 <dt><i>name</i></dt>
799 <dd> 1060 <dd>
800 identity name (string) 1061 identity name (string)
801 </dd> 1062 </dd>
802 </dl><a NAME="IrcNetwork.setName" ID="IrcNetwork.setName"></a> 1063 </dl>
1064 <a NAME="IrcNetwork.setName" ID="IrcNetwork.setName"></a>
803 <h4>IrcNetwork.setName</h4> 1065 <h4>IrcNetwork.setName</h4>
804 <b>setName</b>(<i>name</i>) 1066 <b>setName</b>(<i>name</i>)
1067
805 <p> 1068 <p>
806 Public method to set the network name. 1069 Public method to set the network name.
807 </p><dl> 1070 </p>
1071 <dl>
1072
808 <dt><i>name</i></dt> 1073 <dt><i>name</i></dt>
809 <dd> 1074 <dd>
810 network name (string) 1075 network name (string)
811 </dd> 1076 </dd>
812 </dl><a NAME="IrcNetwork.setServer" ID="IrcNetwork.setServer"></a> 1077 </dl>
1078 <a NAME="IrcNetwork.setServer" ID="IrcNetwork.setServer"></a>
813 <h4>IrcNetwork.setServer</h4> 1079 <h4>IrcNetwork.setServer</h4>
814 <b>setServer</b>(<i>server</i>) 1080 <b>setServer</b>(<i>server</i>)
1081
815 <p> 1082 <p>
816 Public method to set the server. 1083 Public method to set the server.
817 </p><dl> 1084 </p>
1085 <dl>
1086
818 <dt><i>server</i></dt> 1087 <dt><i>server</i></dt>
819 <dd> 1088 <dd>
820 server object to set (IrcServer) 1089 server object to set (IrcServer)
821 </dd> 1090 </dd>
822 </dl> 1091 </dl>
823 <div align="right"><a href="#top">Up</a></div> 1092 <div align="right"><a href="#top">Up</a></div>
824 <hr /><hr /> 1093 <hr />
1094 <hr />
825 <a NAME="IrcNetworkManager" ID="IrcNetworkManager"></a> 1095 <a NAME="IrcNetworkManager" ID="IrcNetworkManager"></a>
826 <h2>IrcNetworkManager</h2> 1096 <h2>IrcNetworkManager</h2>
1097
827 <p> 1098 <p>
828 Class implementing the IRC identity object. 1099 Class implementing the IRC identity object.
829 </p><h3>Signals</h3> 1100 </p>
830 <dl> 1101 <h3>Signals</h3>
1102 <dl>
1103
831 <dt>dataChanged()</dt> 1104 <dt>dataChanged()</dt>
832 <dd> 1105 <dd>
833 emitted after some data has changed 1106 emitted after some data has changed
834 </dd><dt>identitiesChanged()</dt> 1107 </dd>
1108 <dt>identitiesChanged()</dt>
835 <dd> 1109 <dd>
836 emitted after an identity object has changed 1110 emitted after an identity object has changed
837 </dd><dt>networksChanged()</dt> 1111 </dd>
1112 <dt>networksChanged()</dt>
838 <dd> 1113 <dd>
839 emitted after a network object has changed 1114 emitted after a network object has changed
840 </dd> 1115 </dd>
841 </dl> 1116 </dl>
842 <h3>Derived from</h3> 1117 <h3>Derived from</h3>
843 QObject 1118 QObject
844 <h3>Class Attributes</h3> 1119 <h3>Class Attributes</h3>
1120
845 <table> 1121 <table>
846 <tr><td>None</td></tr> 1122 <tr><td>None</td></tr>
847 </table> 1123 </table>
848 <h3>Class Methods</h3> 1124 <h3>Class Methods</h3>
1125
849 <table> 1126 <table>
850 <tr><td>None</td></tr> 1127 <tr><td>None</td></tr>
851 </table> 1128 </table>
852 <h3>Methods</h3> 1129 <h3>Methods</h3>
853 <table> 1130
1131 <table>
1132
854 <tr> 1133 <tr>
855 <td><a href="#IrcNetworkManager.__init__">IrcNetworkManager</a></td> 1134 <td><a href="#IrcNetworkManager.__init__">IrcNetworkManager</a></td>
856 <td>Constructor</td> 1135 <td>Constructor</td>
857 </tr><tr> 1136 </tr>
1137 <tr>
858 <td><a href="#IrcNetworkManager.__load">__load</a></td> 1138 <td><a href="#IrcNetworkManager.__load">__load</a></td>
859 <td>Private slot to load the IRC data.</td> 1139 <td>Private slot to load the IRC data.</td>
860 </tr><tr> 1140 </tr>
1141 <tr>
861 <td><a href="#IrcNetworkManager.__loadDefaults">__loadDefaults</a></td> 1142 <td><a href="#IrcNetworkManager.__loadDefaults">__loadDefaults</a></td>
862 <td>Private method to load default values.</td> 1143 <td>Private method to load default values.</td>
863 </tr><tr> 1144 </tr>
1145 <tr>
864 <td><a href="#IrcNetworkManager.addIdentity">addIdentity</a></td> 1146 <td><a href="#IrcNetworkManager.addIdentity">addIdentity</a></td>
865 <td>Public method to add a new identity.</td> 1147 <td>Public method to add a new identity.</td>
866 </tr><tr> 1148 </tr>
1149 <tr>
867 <td><a href="#IrcNetworkManager.addNetwork">addNetwork</a></td> 1150 <td><a href="#IrcNetworkManager.addNetwork">addNetwork</a></td>
868 <td>Public method to add a network.</td> 1151 <td>Public method to add a network.</td>
869 </tr><tr> 1152 </tr>
1153 <tr>
870 <td><a href="#IrcNetworkManager.close">close</a></td> 1154 <td><a href="#IrcNetworkManager.close">close</a></td>
871 <td>Public method to close the open search engines manager.</td> 1155 <td>Public method to close the open search engines manager.</td>
872 </tr><tr> 1156 </tr>
1157 <tr>
873 <td><a href="#IrcNetworkManager.deleteIdentity">deleteIdentity</a></td> 1158 <td><a href="#IrcNetworkManager.deleteIdentity">deleteIdentity</a></td>
874 <td>Public method to delete the given identity.</td> 1159 <td>Public method to delete the given identity.</td>
875 </tr><tr> 1160 </tr>
1161 <tr>
876 <td><a href="#IrcNetworkManager.deleteNetwork">deleteNetwork</a></td> 1162 <td><a href="#IrcNetworkManager.deleteNetwork">deleteNetwork</a></td>
877 <td>Public method to delete the given network.</td> 1163 <td>Public method to delete the given network.</td>
878 </tr><tr> 1164 </tr>
1165 <tr>
879 <td><a href="#IrcNetworkManager.getIdentities">getIdentities</a></td> 1166 <td><a href="#IrcNetworkManager.getIdentities">getIdentities</a></td>
880 <td>Public method to get a copy of all identities.</td> 1167 <td>Public method to get a copy of all identities.</td>
881 </tr><tr> 1168 </tr>
1169 <tr>
882 <td><a href="#IrcNetworkManager.getIdentity">getIdentity</a></td> 1170 <td><a href="#IrcNetworkManager.getIdentity">getIdentity</a></td>
883 <td>Public method to get an identity object.</td> 1171 <td>Public method to get an identity object.</td>
884 </tr><tr> 1172 </tr>
1173 <tr>
885 <td><a href="#IrcNetworkManager.getIdentityNames">getIdentityNames</a></td> 1174 <td><a href="#IrcNetworkManager.getIdentityNames">getIdentityNames</a></td>
886 <td>Public method to get the names of all identities.</td> 1175 <td>Public method to get the names of all identities.</td>
887 </tr><tr> 1176 </tr>
1177 <tr>
888 <td><a href="#IrcNetworkManager.getNetwork">getNetwork</a></td> 1178 <td><a href="#IrcNetworkManager.getNetwork">getNetwork</a></td>
889 <td>Public method to get a network object.</td> 1179 <td>Public method to get a network object.</td>
890 </tr><tr> 1180 </tr>
1181 <tr>
891 <td><a href="#IrcNetworkManager.getNetworkNames">getNetworkNames</a></td> 1182 <td><a href="#IrcNetworkManager.getNetworkNames">getNetworkNames</a></td>
892 <td>Public method to get a list of all known network names.</td> 1183 <td>Public method to get a list of all known network names.</td>
893 </tr><tr> 1184 </tr>
1185 <tr>
894 <td><a href="#IrcNetworkManager.identityChanged">identityChanged</a></td> 1186 <td><a href="#IrcNetworkManager.identityChanged">identityChanged</a></td>
895 <td>Public method to indicate a change of an identity object.</td> 1187 <td>Public method to indicate a change of an identity object.</td>
896 </tr><tr> 1188 </tr>
1189 <tr>
897 <td><a href="#IrcNetworkManager.networkChanged">networkChanged</a></td> 1190 <td><a href="#IrcNetworkManager.networkChanged">networkChanged</a></td>
898 <td>Public method to indicate a change of a network object.</td> 1191 <td>Public method to indicate a change of a network object.</td>
899 </tr><tr> 1192 </tr>
1193 <tr>
900 <td><a href="#IrcNetworkManager.renameIdentity">renameIdentity</a></td> 1194 <td><a href="#IrcNetworkManager.renameIdentity">renameIdentity</a></td>
901 <td>Public method to rename an identity.</td> 1195 <td>Public method to rename an identity.</td>
902 </tr><tr> 1196 </tr>
1197 <tr>
903 <td><a href="#IrcNetworkManager.save">save</a></td> 1198 <td><a href="#IrcNetworkManager.save">save</a></td>
904 <td>Public slot to save the IRC data.</td> 1199 <td>Public slot to save the IRC data.</td>
905 </tr><tr> 1200 </tr>
1201 <tr>
906 <td><a href="#IrcNetworkManager.setIdentities">setIdentities</a></td> 1202 <td><a href="#IrcNetworkManager.setIdentities">setIdentities</a></td>
907 <td>Public method to set the identities.</td> 1203 <td>Public method to set the identities.</td>
908 </tr><tr> 1204 </tr>
1205 <tr>
909 <td><a href="#IrcNetworkManager.setNetwork">setNetwork</a></td> 1206 <td><a href="#IrcNetworkManager.setNetwork">setNetwork</a></td>
910 <td>Public method to set a network.</td> 1207 <td>Public method to set a network.</td>
911 </tr> 1208 </tr>
912 </table> 1209 </table>
913 <h3>Static Methods</h3> 1210 <h3>Static Methods</h3>
1211
914 <table> 1212 <table>
915 <tr><td>None</td></tr> 1213 <tr><td>None</td></tr>
916 </table> 1214 </table>
1215
917 <a NAME="IrcNetworkManager.__init__" ID="IrcNetworkManager.__init__"></a> 1216 <a NAME="IrcNetworkManager.__init__" ID="IrcNetworkManager.__init__"></a>
918 <h4>IrcNetworkManager (Constructor)</h4> 1217 <h4>IrcNetworkManager (Constructor)</h4>
919 <b>IrcNetworkManager</b>(<i>parent=None</i>) 1218 <b>IrcNetworkManager</b>(<i>parent=None</i>)
1219
920 <p> 1220 <p>
921 Constructor 1221 Constructor
922 </p><dl> 1222 </p>
1223 <dl>
1224
923 <dt><i>parent</i></dt> 1225 <dt><i>parent</i></dt>
924 <dd> 1226 <dd>
925 reference to the parent object (QObject) 1227 reference to the parent object (QObject)
926 </dd> 1228 </dd>
927 </dl><a NAME="IrcNetworkManager.__load" ID="IrcNetworkManager.__load"></a> 1229 </dl>
1230 <a NAME="IrcNetworkManager.__load" ID="IrcNetworkManager.__load"></a>
928 <h4>IrcNetworkManager.__load</h4> 1231 <h4>IrcNetworkManager.__load</h4>
929 <b>__load</b>(<i></i>) 1232 <b>__load</b>(<i></i>)
1233
930 <p> 1234 <p>
931 Private slot to load the IRC data. 1235 Private slot to load the IRC data.
932 </p><a NAME="IrcNetworkManager.__loadDefaults" ID="IrcNetworkManager.__loadDefaults"></a> 1236 </p>
1237 <a NAME="IrcNetworkManager.__loadDefaults" ID="IrcNetworkManager.__loadDefaults"></a>
933 <h4>IrcNetworkManager.__loadDefaults</h4> 1238 <h4>IrcNetworkManager.__loadDefaults</h4>
934 <b>__loadDefaults</b>(<i>identityOnly=False</i>) 1239 <b>__loadDefaults</b>(<i>identityOnly=False</i>)
1240
935 <p> 1241 <p>
936 Private method to load default values. 1242 Private method to load default values.
937 </p><dl> 1243 </p>
1244 <dl>
1245
938 <dt><i>identityOnly</i></dt> 1246 <dt><i>identityOnly</i></dt>
939 <dd> 1247 <dd>
940 flag indicating to just load the default 1248 flag indicating to just load the default
941 identity (boolean) 1249 identity (boolean)
942 </dd> 1250 </dd>
943 </dl><a NAME="IrcNetworkManager.addIdentity" ID="IrcNetworkManager.addIdentity"></a> 1251 </dl>
1252 <a NAME="IrcNetworkManager.addIdentity" ID="IrcNetworkManager.addIdentity"></a>
944 <h4>IrcNetworkManager.addIdentity</h4> 1253 <h4>IrcNetworkManager.addIdentity</h4>
945 <b>addIdentity</b>(<i>identity</i>) 1254 <b>addIdentity</b>(<i>identity</i>)
1255
946 <p> 1256 <p>
947 Public method to add a new identity. 1257 Public method to add a new identity.
948 </p><dl> 1258 </p>
1259 <dl>
1260
949 <dt><i>identity</i></dt> 1261 <dt><i>identity</i></dt>
950 <dd> 1262 <dd>
951 reference to the identity to add (IrcIdentity) 1263 reference to the identity to add (IrcIdentity)
952 </dd> 1264 </dd>
953 </dl><a NAME="IrcNetworkManager.addNetwork" ID="IrcNetworkManager.addNetwork"></a> 1265 </dl>
1266 <a NAME="IrcNetworkManager.addNetwork" ID="IrcNetworkManager.addNetwork"></a>
954 <h4>IrcNetworkManager.addNetwork</h4> 1267 <h4>IrcNetworkManager.addNetwork</h4>
955 <b>addNetwork</b>(<i>network</i>) 1268 <b>addNetwork</b>(<i>network</i>)
1269
956 <p> 1270 <p>
957 Public method to add a network. 1271 Public method to add a network.
958 </p><dl> 1272 </p>
1273 <dl>
1274
959 <dt><i>network</i></dt> 1275 <dt><i>network</i></dt>
960 <dd> 1276 <dd>
961 network object to add (IrcNetwork) 1277 network object to add (IrcNetwork)
962 </dd> 1278 </dd>
963 </dl><a NAME="IrcNetworkManager.close" ID="IrcNetworkManager.close"></a> 1279 </dl>
1280 <a NAME="IrcNetworkManager.close" ID="IrcNetworkManager.close"></a>
964 <h4>IrcNetworkManager.close</h4> 1281 <h4>IrcNetworkManager.close</h4>
965 <b>close</b>(<i></i>) 1282 <b>close</b>(<i></i>)
1283
966 <p> 1284 <p>
967 Public method to close the open search engines manager. 1285 Public method to close the open search engines manager.
968 </p><a NAME="IrcNetworkManager.deleteIdentity" ID="IrcNetworkManager.deleteIdentity"></a> 1286 </p>
1287 <a NAME="IrcNetworkManager.deleteIdentity" ID="IrcNetworkManager.deleteIdentity"></a>
969 <h4>IrcNetworkManager.deleteIdentity</h4> 1288 <h4>IrcNetworkManager.deleteIdentity</h4>
970 <b>deleteIdentity</b>(<i>name</i>) 1289 <b>deleteIdentity</b>(<i>name</i>)
1290
971 <p> 1291 <p>
972 Public method to delete the given identity. 1292 Public method to delete the given identity.
973 </p><dl> 1293 </p>
1294 <dl>
1295
974 <dt><i>name</i></dt> 1296 <dt><i>name</i></dt>
975 <dd> 1297 <dd>
976 name of the identity to delete (string) 1298 name of the identity to delete (string)
977 </dd> 1299 </dd>
978 </dl><a NAME="IrcNetworkManager.deleteNetwork" ID="IrcNetworkManager.deleteNetwork"></a> 1300 </dl>
1301 <a NAME="IrcNetworkManager.deleteNetwork" ID="IrcNetworkManager.deleteNetwork"></a>
979 <h4>IrcNetworkManager.deleteNetwork</h4> 1302 <h4>IrcNetworkManager.deleteNetwork</h4>
980 <b>deleteNetwork</b>(<i>name</i>) 1303 <b>deleteNetwork</b>(<i>name</i>)
1304
981 <p> 1305 <p>
982 Public method to delete the given network. 1306 Public method to delete the given network.
983 </p><dl> 1307 </p>
1308 <dl>
1309
984 <dt><i>name</i></dt> 1310 <dt><i>name</i></dt>
985 <dd> 1311 <dd>
986 name of the network to delete (string) 1312 name of the network to delete (string)
987 </dd> 1313 </dd>
988 </dl><a NAME="IrcNetworkManager.getIdentities" ID="IrcNetworkManager.getIdentities"></a> 1314 </dl>
1315 <a NAME="IrcNetworkManager.getIdentities" ID="IrcNetworkManager.getIdentities"></a>
989 <h4>IrcNetworkManager.getIdentities</h4> 1316 <h4>IrcNetworkManager.getIdentities</h4>
990 <b>getIdentities</b>(<i></i>) 1317 <b>getIdentities</b>(<i></i>)
1318
991 <p> 1319 <p>
992 Public method to get a copy of all identities. 1320 Public method to get a copy of all identities.
993 </p><dl> 1321 </p>
1322 <dl>
994 <dt>Returns:</dt> 1323 <dt>Returns:</dt>
995 <dd> 1324 <dd>
996 dictionary of all identities (dict of IrcIdentity) 1325 dictionary of all identities (dict of IrcIdentity)
997 </dd> 1326 </dd>
998 </dl><a NAME="IrcNetworkManager.getIdentity" ID="IrcNetworkManager.getIdentity"></a> 1327 </dl>
1328 <a NAME="IrcNetworkManager.getIdentity" ID="IrcNetworkManager.getIdentity"></a>
999 <h4>IrcNetworkManager.getIdentity</h4> 1329 <h4>IrcNetworkManager.getIdentity</h4>
1000 <b>getIdentity</b>(<i>name, create=False</i>) 1330 <b>getIdentity</b>(<i>name, create=False</i>)
1331
1001 <p> 1332 <p>
1002 Public method to get an identity object. 1333 Public method to get an identity object.
1003 </p><dl> 1334 </p>
1335 <dl>
1336
1004 <dt><i>name</i></dt> 1337 <dt><i>name</i></dt>
1005 <dd> 1338 <dd>
1006 name of the identity to get (string) 1339 name of the identity to get (string)
1007 </dd><dt><i>create</i></dt> 1340 </dd>
1341 <dt><i>create</i></dt>
1008 <dd> 1342 <dd>
1009 flag indicating to create a new object, 1343 flag indicating to create a new object,
1010 if none exists (boolean) 1344 if none exists (boolean)
1011 </dd> 1345 </dd>
1012 </dl><dl> 1346 </dl>
1347 <dl>
1013 <dt>Returns:</dt> 1348 <dt>Returns:</dt>
1014 <dd> 1349 <dd>
1015 reference to the identity (IrcIdentity) 1350 reference to the identity (IrcIdentity)
1016 </dd> 1351 </dd>
1017 </dl><a NAME="IrcNetworkManager.getIdentityNames" ID="IrcNetworkManager.getIdentityNames"></a> 1352 </dl>
1353 <a NAME="IrcNetworkManager.getIdentityNames" ID="IrcNetworkManager.getIdentityNames"></a>
1018 <h4>IrcNetworkManager.getIdentityNames</h4> 1354 <h4>IrcNetworkManager.getIdentityNames</h4>
1019 <b>getIdentityNames</b>(<i></i>) 1355 <b>getIdentityNames</b>(<i></i>)
1356
1020 <p> 1357 <p>
1021 Public method to get the names of all identities. 1358 Public method to get the names of all identities.
1022 </p><dl> 1359 </p>
1360 <dl>
1023 <dt>Returns:</dt> 1361 <dt>Returns:</dt>
1024 <dd> 1362 <dd>
1025 names of all identities (list of string) 1363 names of all identities (list of string)
1026 </dd> 1364 </dd>
1027 </dl><a NAME="IrcNetworkManager.getNetwork" ID="IrcNetworkManager.getNetwork"></a> 1365 </dl>
1366 <a NAME="IrcNetworkManager.getNetwork" ID="IrcNetworkManager.getNetwork"></a>
1028 <h4>IrcNetworkManager.getNetwork</h4> 1367 <h4>IrcNetworkManager.getNetwork</h4>
1029 <b>getNetwork</b>(<i>name</i>) 1368 <b>getNetwork</b>(<i>name</i>)
1369
1030 <p> 1370 <p>
1031 Public method to get a network object. 1371 Public method to get a network object.
1032 </p><dl> 1372 </p>
1373 <dl>
1374
1033 <dt><i>name</i></dt> 1375 <dt><i>name</i></dt>
1034 <dd> 1376 <dd>
1035 name of the network (string) 1377 name of the network (string)
1036 </dd> 1378 </dd>
1037 </dl><dl> 1379 </dl>
1380 <dl>
1038 <dt>Returns:</dt> 1381 <dt>Returns:</dt>
1039 <dd> 1382 <dd>
1040 reference to the network object (IrcNetwork) 1383 reference to the network object (IrcNetwork)
1041 </dd> 1384 </dd>
1042 </dl><a NAME="IrcNetworkManager.getNetworkNames" ID="IrcNetworkManager.getNetworkNames"></a> 1385 </dl>
1386 <a NAME="IrcNetworkManager.getNetworkNames" ID="IrcNetworkManager.getNetworkNames"></a>
1043 <h4>IrcNetworkManager.getNetworkNames</h4> 1387 <h4>IrcNetworkManager.getNetworkNames</h4>
1044 <b>getNetworkNames</b>(<i></i>) 1388 <b>getNetworkNames</b>(<i></i>)
1389
1045 <p> 1390 <p>
1046 Public method to get a list of all known network names. 1391 Public method to get a list of all known network names.
1047 </p><dl> 1392 </p>
1393 <dl>
1048 <dt>Returns:</dt> 1394 <dt>Returns:</dt>
1049 <dd> 1395 <dd>
1050 list of network names (list of string) 1396 list of network names (list of string)
1051 </dd> 1397 </dd>
1052 </dl><a NAME="IrcNetworkManager.identityChanged" ID="IrcNetworkManager.identityChanged"></a> 1398 </dl>
1399 <a NAME="IrcNetworkManager.identityChanged" ID="IrcNetworkManager.identityChanged"></a>
1053 <h4>IrcNetworkManager.identityChanged</h4> 1400 <h4>IrcNetworkManager.identityChanged</h4>
1054 <b>identityChanged</b>(<i></i>) 1401 <b>identityChanged</b>(<i></i>)
1402
1055 <p> 1403 <p>
1056 Public method to indicate a change of an identity object. 1404 Public method to indicate a change of an identity object.
1057 </p><a NAME="IrcNetworkManager.networkChanged" ID="IrcNetworkManager.networkChanged"></a> 1405 </p>
1406 <a NAME="IrcNetworkManager.networkChanged" ID="IrcNetworkManager.networkChanged"></a>
1058 <h4>IrcNetworkManager.networkChanged</h4> 1407 <h4>IrcNetworkManager.networkChanged</h4>
1059 <b>networkChanged</b>(<i></i>) 1408 <b>networkChanged</b>(<i></i>)
1409
1060 <p> 1410 <p>
1061 Public method to indicate a change of a network object. 1411 Public method to indicate a change of a network object.
1062 </p><a NAME="IrcNetworkManager.renameIdentity" ID="IrcNetworkManager.renameIdentity"></a> 1412 </p>
1413 <a NAME="IrcNetworkManager.renameIdentity" ID="IrcNetworkManager.renameIdentity"></a>
1063 <h4>IrcNetworkManager.renameIdentity</h4> 1414 <h4>IrcNetworkManager.renameIdentity</h4>
1064 <b>renameIdentity</b>(<i>oldName, newName</i>) 1415 <b>renameIdentity</b>(<i>oldName, newName</i>)
1416
1065 <p> 1417 <p>
1066 Public method to rename an identity. 1418 Public method to rename an identity.
1067 </p><dl> 1419 </p>
1420 <dl>
1421
1068 <dt><i>oldName</i></dt> 1422 <dt><i>oldName</i></dt>
1069 <dd> 1423 <dd>
1070 old name of the identity (string) 1424 old name of the identity (string)
1071 </dd><dt><i>newName</i></dt> 1425 </dd>
1426 <dt><i>newName</i></dt>
1072 <dd> 1427 <dd>
1073 new name of the identity (string) 1428 new name of the identity (string)
1074 </dd> 1429 </dd>
1075 </dl><a NAME="IrcNetworkManager.save" ID="IrcNetworkManager.save"></a> 1430 </dl>
1431 <a NAME="IrcNetworkManager.save" ID="IrcNetworkManager.save"></a>
1076 <h4>IrcNetworkManager.save</h4> 1432 <h4>IrcNetworkManager.save</h4>
1077 <b>save</b>(<i></i>) 1433 <b>save</b>(<i></i>)
1434
1078 <p> 1435 <p>
1079 Public slot to save the IRC data. 1436 Public slot to save the IRC data.
1080 </p><a NAME="IrcNetworkManager.setIdentities" ID="IrcNetworkManager.setIdentities"></a> 1437 </p>
1438 <a NAME="IrcNetworkManager.setIdentities" ID="IrcNetworkManager.setIdentities"></a>
1081 <h4>IrcNetworkManager.setIdentities</h4> 1439 <h4>IrcNetworkManager.setIdentities</h4>
1082 <b>setIdentities</b>(<i>identities</i>) 1440 <b>setIdentities</b>(<i>identities</i>)
1441
1083 <p> 1442 <p>
1084 Public method to set the identities. 1443 Public method to set the identities.
1085 </p><dl> 1444 </p>
1445 <dl>
1446
1086 <dt><i>identities</i></dt> 1447 <dt><i>identities</i></dt>
1087 <dd> 1448 <dd>
1088 dictionary of all identities (dict of IrcIdentity) 1449 dictionary of all identities (dict of IrcIdentity)
1089 </dd> 1450 </dd>
1090 </dl><a NAME="IrcNetworkManager.setNetwork" ID="IrcNetworkManager.setNetwork"></a> 1451 </dl>
1452 <a NAME="IrcNetworkManager.setNetwork" ID="IrcNetworkManager.setNetwork"></a>
1091 <h4>IrcNetworkManager.setNetwork</h4> 1453 <h4>IrcNetworkManager.setNetwork</h4>
1092 <b>setNetwork</b>(<i>network, networkName=""</i>) 1454 <b>setNetwork</b>(<i>network, networkName=""</i>)
1455
1093 <p> 1456 <p>
1094 Public method to set a network. 1457 Public method to set a network.
1095 </p><dl> 1458 </p>
1459 <dl>
1460
1096 <dt><i>network</i></dt> 1461 <dt><i>network</i></dt>
1097 <dd> 1462 <dd>
1098 network object to set (IrcNetwork) 1463 network object to set (IrcNetwork)
1099 </dd><dt><i>networkName</i></dt> 1464 </dd>
1465 <dt><i>networkName</i></dt>
1100 <dd> 1466 <dd>
1101 name the network was known for (string) 1467 name the network was known for (string)
1102 </dd> 1468 </dd>
1103 </dl> 1469 </dl>
1104 <div align="right"><a href="#top">Up</a></div> 1470 <div align="right"><a href="#top">Up</a></div>
1105 <hr /><hr /> 1471 <hr />
1472 <hr />
1106 <a NAME="IrcServer" ID="IrcServer"></a> 1473 <a NAME="IrcServer" ID="IrcServer"></a>
1107 <h2>IrcServer</h2> 1474 <h2>IrcServer</h2>
1475
1108 <p> 1476 <p>
1109 Class implementing the IRC identity object. 1477 Class implementing the IRC identity object.
1110 </p> 1478 </p>
1111 <h3>Derived from</h3> 1479 <h3>Derived from</h3>
1112 object 1480 object
1113 <h3>Class Attributes</h3> 1481 <h3>Class Attributes</h3>
1482
1114 <table> 1483 <table>
1115 <tr><td>DefaultPort</td></tr><tr><td>DefaultSslPort</td></tr> 1484 <tr><td>DefaultPort</td></tr><tr><td>DefaultSslPort</td></tr>
1116 </table> 1485 </table>
1117 <h3>Class Methods</h3> 1486 <h3>Class Methods</h3>
1487
1118 <table> 1488 <table>
1119 <tr><td>None</td></tr> 1489 <tr><td>None</td></tr>
1120 </table> 1490 </table>
1121 <h3>Methods</h3> 1491 <h3>Methods</h3>
1122 <table> 1492
1493 <table>
1494
1123 <tr> 1495 <tr>
1124 <td><a href="#IrcServer.__init__">IrcServer</a></td> 1496 <td><a href="#IrcServer.__init__">IrcServer</a></td>
1125 <td>Constructor</td> 1497 <td>Constructor</td>
1126 </tr><tr> 1498 </tr>
1499 <tr>
1127 <td><a href="#IrcServer.getName">getName</a></td> 1500 <td><a href="#IrcServer.getName">getName</a></td>
1128 <td>Public method to get the server name.</td> 1501 <td>Public method to get the server name.</td>
1129 </tr><tr> 1502 </tr>
1503 <tr>
1130 <td><a href="#IrcServer.getPassword">getPassword</a></td> 1504 <td><a href="#IrcServer.getPassword">getPassword</a></td>
1131 <td>Public method to get the password.</td> 1505 <td>Public method to get the password.</td>
1132 </tr><tr> 1506 </tr>
1507 <tr>
1133 <td><a href="#IrcServer.getPort">getPort</a></td> 1508 <td><a href="#IrcServer.getPort">getPort</a></td>
1134 <td>Public method to get the server port number.</td> 1509 <td>Public method to get the server port number.</td>
1135 </tr><tr> 1510 </tr>
1511 <tr>
1136 <td><a href="#IrcServer.load">load</a></td> 1512 <td><a href="#IrcServer.load">load</a></td>
1137 <td>Public method to load the server data.</td> 1513 <td>Public method to load the server data.</td>
1138 </tr><tr> 1514 </tr>
1515 <tr>
1139 <td><a href="#IrcServer.save">save</a></td> 1516 <td><a href="#IrcServer.save">save</a></td>
1140 <td>Public method to save the server data.</td> 1517 <td>Public method to save the server data.</td>
1141 </tr><tr> 1518 </tr>
1519 <tr>
1142 <td><a href="#IrcServer.setName">setName</a></td> 1520 <td><a href="#IrcServer.setName">setName</a></td>
1143 <td>Public method to set the server name.</td> 1521 <td>Public method to set the server name.</td>
1144 </tr><tr> 1522 </tr>
1523 <tr>
1145 <td><a href="#IrcServer.setPassword">setPassword</a></td> 1524 <td><a href="#IrcServer.setPassword">setPassword</a></td>
1146 <td>Public method to set a new password.</td> 1525 <td>Public method to set a new password.</td>
1147 </tr><tr> 1526 </tr>
1527 <tr>
1148 <td><a href="#IrcServer.setPort">setPort</a></td> 1528 <td><a href="#IrcServer.setPort">setPort</a></td>
1149 <td>Public method to set the server port number.</td> 1529 <td>Public method to set the server port number.</td>
1150 </tr><tr> 1530 </tr>
1531 <tr>
1151 <td><a href="#IrcServer.setUseSSL">setUseSSL</a></td> 1532 <td><a href="#IrcServer.setUseSSL">setUseSSL</a></td>
1152 <td>Public method to set the SSL usage.</td> 1533 <td>Public method to set the SSL usage.</td>
1153 </tr><tr> 1534 </tr>
1535 <tr>
1154 <td><a href="#IrcServer.useSSL">useSSL</a></td> 1536 <td><a href="#IrcServer.useSSL">useSSL</a></td>
1155 <td>Public method to check for SSL usage.</td> 1537 <td>Public method to check for SSL usage.</td>
1156 </tr> 1538 </tr>
1157 </table> 1539 </table>
1158 <h3>Static Methods</h3> 1540 <h3>Static Methods</h3>
1541
1159 <table> 1542 <table>
1160 <tr><td>None</td></tr> 1543 <tr><td>None</td></tr>
1161 </table> 1544 </table>
1545
1162 <a NAME="IrcServer.__init__" ID="IrcServer.__init__"></a> 1546 <a NAME="IrcServer.__init__" ID="IrcServer.__init__"></a>
1163 <h4>IrcServer (Constructor)</h4> 1547 <h4>IrcServer (Constructor)</h4>
1164 <b>IrcServer</b>(<i>name</i>) 1548 <b>IrcServer</b>(<i>name</i>)
1549
1165 <p> 1550 <p>
1166 Constructor 1551 Constructor
1167 </p><dl> 1552 </p>
1553 <dl>
1554
1168 <dt><i>name</i></dt> 1555 <dt><i>name</i></dt>
1169 <dd> 1556 <dd>
1170 name of the server (string) 1557 name of the server (string)
1171 </dd> 1558 </dd>
1172 </dl><a NAME="IrcServer.getName" ID="IrcServer.getName"></a> 1559 </dl>
1560 <a NAME="IrcServer.getName" ID="IrcServer.getName"></a>
1173 <h4>IrcServer.getName</h4> 1561 <h4>IrcServer.getName</h4>
1174 <b>getName</b>(<i></i>) 1562 <b>getName</b>(<i></i>)
1563
1175 <p> 1564 <p>
1176 Public method to get the server name. 1565 Public method to get the server name.
1177 </p><dl> 1566 </p>
1567 <dl>
1178 <dt>Returns:</dt> 1568 <dt>Returns:</dt>
1179 <dd> 1569 <dd>
1180 server name (string) 1570 server name (string)
1181 </dd> 1571 </dd>
1182 </dl><a NAME="IrcServer.getPassword" ID="IrcServer.getPassword"></a> 1572 </dl>
1573 <a NAME="IrcServer.getPassword" ID="IrcServer.getPassword"></a>
1183 <h4>IrcServer.getPassword</h4> 1574 <h4>IrcServer.getPassword</h4>
1184 <b>getPassword</b>(<i></i>) 1575 <b>getPassword</b>(<i></i>)
1576
1185 <p> 1577 <p>
1186 Public method to get the password. 1578 Public method to get the password.
1187 </p><dl> 1579 </p>
1580 <dl>
1188 <dt>Returns:</dt> 1581 <dt>Returns:</dt>
1189 <dd> 1582 <dd>
1190 password (string) 1583 password (string)
1191 </dd> 1584 </dd>
1192 </dl><a NAME="IrcServer.getPort" ID="IrcServer.getPort"></a> 1585 </dl>
1586 <a NAME="IrcServer.getPort" ID="IrcServer.getPort"></a>
1193 <h4>IrcServer.getPort</h4> 1587 <h4>IrcServer.getPort</h4>
1194 <b>getPort</b>(<i></i>) 1588 <b>getPort</b>(<i></i>)
1589
1195 <p> 1590 <p>
1196 Public method to get the server port number. 1591 Public method to get the server port number.
1197 </p><dl> 1592 </p>
1593 <dl>
1198 <dt>Returns:</dt> 1594 <dt>Returns:</dt>
1199 <dd> 1595 <dd>
1200 port number (integer) 1596 port number (integer)
1201 </dd> 1597 </dd>
1202 </dl><a NAME="IrcServer.load" ID="IrcServer.load"></a> 1598 </dl>
1599 <a NAME="IrcServer.load" ID="IrcServer.load"></a>
1203 <h4>IrcServer.load</h4> 1600 <h4>IrcServer.load</h4>
1204 <b>load</b>(<i>settings</i>) 1601 <b>load</b>(<i>settings</i>)
1602
1205 <p> 1603 <p>
1206 Public method to load the server data. 1604 Public method to load the server data.
1207 </p><dl> 1605 </p>
1606 <dl>
1607
1208 <dt><i>settings</i></dt> 1608 <dt><i>settings</i></dt>
1209 <dd> 1609 <dd>
1210 reference to the settings object (QSettings) 1610 reference to the settings object (QSettings)
1211 </dd> 1611 </dd>
1212 </dl><a NAME="IrcServer.save" ID="IrcServer.save"></a> 1612 </dl>
1613 <a NAME="IrcServer.save" ID="IrcServer.save"></a>
1213 <h4>IrcServer.save</h4> 1614 <h4>IrcServer.save</h4>
1214 <b>save</b>(<i>settings</i>) 1615 <b>save</b>(<i>settings</i>)
1616
1215 <p> 1617 <p>
1216 Public method to save the server data. 1618 Public method to save the server data.
1217 </p><dl> 1619 </p>
1620 <dl>
1621
1218 <dt><i>settings</i></dt> 1622 <dt><i>settings</i></dt>
1219 <dd> 1623 <dd>
1220 reference to the settings object (QSettings) 1624 reference to the settings object (QSettings)
1221 </dd> 1625 </dd>
1222 </dl><a NAME="IrcServer.setName" ID="IrcServer.setName"></a> 1626 </dl>
1627 <a NAME="IrcServer.setName" ID="IrcServer.setName"></a>
1223 <h4>IrcServer.setName</h4> 1628 <h4>IrcServer.setName</h4>
1224 <b>setName</b>(<i>name</i>) 1629 <b>setName</b>(<i>name</i>)
1630
1225 <p> 1631 <p>
1226 Public method to set the server name. 1632 Public method to set the server name.
1227 </p><dl> 1633 </p>
1634 <dl>
1635
1228 <dt><i>name</i></dt> 1636 <dt><i>name</i></dt>
1229 <dd> 1637 <dd>
1230 server name (string) 1638 server name (string)
1231 </dd> 1639 </dd>
1232 </dl><a NAME="IrcServer.setPassword" ID="IrcServer.setPassword"></a> 1640 </dl>
1641 <a NAME="IrcServer.setPassword" ID="IrcServer.setPassword"></a>
1233 <h4>IrcServer.setPassword</h4> 1642 <h4>IrcServer.setPassword</h4>
1234 <b>setPassword</b>(<i>password</i>) 1643 <b>setPassword</b>(<i>password</i>)
1644
1235 <p> 1645 <p>
1236 Public method to set a new password. 1646 Public method to set a new password.
1237 </p><dl> 1647 </p>
1648 <dl>
1649
1238 <dt><i>password</i></dt> 1650 <dt><i>password</i></dt>
1239 <dd> 1651 <dd>
1240 password to set (string) 1652 password to set (string)
1241 </dd> 1653 </dd>
1242 </dl><a NAME="IrcServer.setPort" ID="IrcServer.setPort"></a> 1654 </dl>
1655 <a NAME="IrcServer.setPort" ID="IrcServer.setPort"></a>
1243 <h4>IrcServer.setPort</h4> 1656 <h4>IrcServer.setPort</h4>
1244 <b>setPort</b>(<i>port</i>) 1657 <b>setPort</b>(<i>port</i>)
1658
1245 <p> 1659 <p>
1246 Public method to set the server port number. 1660 Public method to set the server port number.
1247 </p><dl> 1661 </p>
1662 <dl>
1663
1248 <dt><i>port</i></dt> 1664 <dt><i>port</i></dt>
1249 <dd> 1665 <dd>
1250 server port number (integer) 1666 server port number (integer)
1251 </dd> 1667 </dd>
1252 </dl><a NAME="IrcServer.setUseSSL" ID="IrcServer.setUseSSL"></a> 1668 </dl>
1669 <a NAME="IrcServer.setUseSSL" ID="IrcServer.setUseSSL"></a>
1253 <h4>IrcServer.setUseSSL</h4> 1670 <h4>IrcServer.setUseSSL</h4>
1254 <b>setUseSSL</b>(<i>on</i>) 1671 <b>setUseSSL</b>(<i>on</i>)
1672
1255 <p> 1673 <p>
1256 Public method to set the SSL usage. 1674 Public method to set the SSL usage.
1257 </p><dl> 1675 </p>
1676 <dl>
1677
1258 <dt><i>on</i></dt> 1678 <dt><i>on</i></dt>
1259 <dd> 1679 <dd>
1260 flag indicating SSL usage (boolean) 1680 flag indicating SSL usage (boolean)
1261 </dd> 1681 </dd>
1262 </dl><a NAME="IrcServer.useSSL" ID="IrcServer.useSSL"></a> 1682 </dl>
1683 <a NAME="IrcServer.useSSL" ID="IrcServer.useSSL"></a>
1263 <h4>IrcServer.useSSL</h4> 1684 <h4>IrcServer.useSSL</h4>
1264 <b>useSSL</b>(<i></i>) 1685 <b>useSSL</b>(<i></i>)
1686
1265 <p> 1687 <p>
1266 Public method to check for SSL usage. 1688 Public method to check for SSL usage.
1267 </p><dl> 1689 </p>
1690 <dl>
1268 <dt>Returns:</dt> 1691 <dt>Returns:</dt>
1269 <dd> 1692 <dd>
1270 flag indicating SSL usage (boolean) 1693 flag indicating SSL usage (boolean)
1271 </dd> 1694 </dd>
1272 </dl> 1695 </dl>

eric ide

mercurial