Documentation/Source/eric6.Network.IRC.IrcWidget.html

changeset 6514
f11a703e4664
parent 4630
7b0e38956b5c
equal deleted inserted replaced
6513:e1fcd71fbda3 6514:f11a703e4664
88 <td>Private slot to edit the network configuration.</td> 88 <td>Private slot to edit the network configuration.</td>
89 </tr><tr> 89 </tr><tr>
90 <td><a href="#IrcWidget.__handleCtcp">__handleCtcp</a></td> 90 <td><a href="#IrcWidget.__handleCtcp">__handleCtcp</a></td>
91 <td>Private method to handle a CTCP command.</td> 91 <td>Private method to handle a CTCP command.</td>
92 </tr><tr> 92 </tr><tr>
93 <td><a href="#IrcWidget.__handleCtcpReply">__handleCtcpReply</a></td>
94 <td>Private method to handle a server message containing a CTCP reply.</td>
95 </tr><tr>
93 <td><a href="#IrcWidget.__handleNamedMessage">__handleNamedMessage</a></td> 96 <td><a href="#IrcWidget.__handleNamedMessage">__handleNamedMessage</a></td>
94 <td>Private method to handle a server message containing a message name.</td> 97 <td>Private method to handle a server message containing a message name.</td>
95 </tr><tr> 98 </tr><tr>
96 <td><a href="#IrcWidget.__handleNickInUse">__handleNickInUse</a></td> 99 <td><a href="#IrcWidget.__handleNickInUse">__handleNickInUse</a></td>
97 <td>Private method to handle a 443 server error.</td> 100 <td>Private method to handle a 443 server error.</td>
115 <td>Private slot to indicate the host was disconnected.</td> 118 <td>Private slot to indicate the host was disconnected.</td>
116 </tr><tr> 119 </tr><tr>
117 <td><a href="#IrcWidget.__hostFound">__hostFound</a></td> 120 <td><a href="#IrcWidget.__hostFound">__hostFound</a></td>
118 <td>Private slot to indicate the host was found.</td> 121 <td>Private slot to indicate the host was found.</td>
119 </tr><tr> 122 </tr><tr>
120 <td><a href="#IrcWidget.__joinChannel">__joinChannel</a></td> 123 <td><a href="#IrcWidget.__leaveAllChannels">__leaveAllChannels</a></td>
121 <td>Private slot to join a channel.</td> 124 <td>Private slot to leave all channels and close their tabs.</td>
122 </tr><tr> 125 </tr><tr>
123 <td><a href="#IrcWidget.__leaveChannel">__leaveChannel</a></td> 126 <td><a href="#IrcWidget.__leaveChannel">__leaveChannel</a></td>
124 <td>Private slot to leave a channel and close the associated tab.</td> 127 <td>Private slot to leave a channel and close the associated tab.</td>
125 </tr><tr> 128 </tr><tr>
129 <td><a href="#IrcWidget.__leaveChannels">__leaveChannels</a></td>
130 <td>Private slot to leave a list of channels and close their associated tabs.</td>
131 </tr><tr>
126 <td><a href="#IrcWidget.__networkDataChanged">__networkDataChanged</a></td> 132 <td><a href="#IrcWidget.__networkDataChanged">__networkDataChanged</a></td>
127 <td>Private slot handling changes of the network and identity definitions.</td> 133 <td>Private slot handling changes of the network and identity definitions.</td>
128 </tr><tr> 134 </tr><tr>
129 <td><a href="#IrcWidget.__openPrivate">__openPrivate</a></td> 135 <td><a href="#IrcWidget.__openPrivate">__openPrivate</a></td>
130 <td>Private slot to open a private chat with the given user.</td> 136 <td>Private slot to open a private chat with the given user.</td>
145 <td>Private slot to send data to the IRC server.</td> 151 <td>Private slot to send data to the IRC server.</td>
146 </tr><tr> 152 </tr><tr>
147 <td><a href="#IrcWidget.__sendCtcpReply">__sendCtcpReply</a></td> 153 <td><a href="#IrcWidget.__sendCtcpReply">__sendCtcpReply</a></td>
148 <td>Private slot to send a CTCP reply.</td> 154 <td>Private slot to send a CTCP reply.</td>
149 </tr><tr> 155 </tr><tr>
156 <td><a href="#IrcWidget.__sendCtcpRequest">__sendCtcpRequest</a></td>
157 <td>Private slot to send a CTCP request.</td>
158 </tr><tr>
150 <td><a href="#IrcWidget.__setChannelTypePrefixes">__setChannelTypePrefixes</a></td> 159 <td><a href="#IrcWidget.__setChannelTypePrefixes">__setChannelTypePrefixes</a></td>
151 <td>Private method to set the channel type prefixes.</td> 160 <td>Private method to set the channel type prefixes.</td>
152 </tr><tr> 161 </tr><tr>
153 <td><a href="#IrcWidget.__setUserPrivilegePrefix">__setUserPrivilegePrefix</a></td> 162 <td><a href="#IrcWidget.__setUserPrivilegePrefix">__setUserPrivilegePrefix</a></td>
154 <td>Private method to set the user privilege prefix.</td> 163 <td>Private method to set the user privilege prefix.</td>
165 <td><a href="#IrcWidget.autoConnect">autoConnect</a></td> 174 <td><a href="#IrcWidget.autoConnect">autoConnect</a></td>
166 <td>Public method to initiate the IRC auto connection.</td> 175 <td>Public method to initiate the IRC auto connection.</td>
167 </tr><tr> 176 </tr><tr>
168 <td><a href="#IrcWidget.isChannelName">isChannelName</a></td> 177 <td><a href="#IrcWidget.isChannelName">isChannelName</a></td>
169 <td>Public method to check, if the given name is a channel name.</td> 178 <td>Public method to check, if the given name is a channel name.</td>
179 </tr><tr>
180 <td><a href="#IrcWidget.joinChannel">joinChannel</a></td>
181 <td>Public slot to join a channel.</td>
170 </tr><tr> 182 </tr><tr>
171 <td><a href="#IrcWidget.on_channelsWidget_tabCloseRequested">on_channelsWidget_tabCloseRequested</a></td> 183 <td><a href="#IrcWidget.on_channelsWidget_tabCloseRequested">on_channelsWidget_tabCloseRequested</a></td>
172 <td>Private slot to close a channel by pressing the close button of the channels widget.</td> 184 <td>Private slot to close a channel by pressing the close button of the channels widget.</td>
173 </tr><tr> 185 </tr><tr>
174 <td><a href="#IrcWidget.shutdown">shutdown</a></td> 186 <td><a href="#IrcWidget.shutdown">shutdown</a></td>
269 </dl><dl> 281 </dl><dl>
270 <dt>Returns:</dt> 282 <dt>Returns:</dt>
271 <dd> 283 <dd>
272 flag indicating, if the message was handled (boolean) 284 flag indicating, if the message was handled (boolean)
273 </dd> 285 </dd>
286 </dl><a NAME="IrcWidget.__handleCtcpReply" ID="IrcWidget.__handleCtcpReply"></a>
287 <h4>IrcWidget.__handleCtcpReply</h4>
288 <b>__handleCtcpReply</b>(<i>match</i>)
289 <p>
290 Private method to handle a server message containing a CTCP reply.
291 </p><dl>
292 <dt><i>match</i></dt>
293 <dd>
294 reference to the match object
295 </dd>
274 </dl><a NAME="IrcWidget.__handleNamedMessage" ID="IrcWidget.__handleNamedMessage"></a> 296 </dl><a NAME="IrcWidget.__handleNamedMessage" ID="IrcWidget.__handleNamedMessage"></a>
275 <h4>IrcWidget.__handleNamedMessage</h4> 297 <h4>IrcWidget.__handleNamedMessage</h4>
276 <b>__handleNamedMessage</b>(<i>match</i>) 298 <b>__handleNamedMessage</b>(<i>match</i>)
277 <p> 299 <p>
278 Private method to handle a server message containing a message name. 300 Private method to handle a server message containing a message name.
367 </p><a NAME="IrcWidget.__hostFound" ID="IrcWidget.__hostFound"></a> 389 </p><a NAME="IrcWidget.__hostFound" ID="IrcWidget.__hostFound"></a>
368 <h4>IrcWidget.__hostFound</h4> 390 <h4>IrcWidget.__hostFound</h4>
369 <b>__hostFound</b>(<i></i>) 391 <b>__hostFound</b>(<i></i>)
370 <p> 392 <p>
371 Private slot to indicate the host was found. 393 Private slot to indicate the host was found.
372 </p><a NAME="IrcWidget.__joinChannel" ID="IrcWidget.__joinChannel"></a> 394 </p><a NAME="IrcWidget.__leaveAllChannels" ID="IrcWidget.__leaveAllChannels"></a>
373 <h4>IrcWidget.__joinChannel</h4> 395 <h4>IrcWidget.__leaveAllChannels</h4>
374 <b>__joinChannel</b>(<i>name, key=""</i>) 396 <b>__leaveAllChannels</b>(<i></i>)
375 <p> 397 <p>
376 Private slot to join a channel. 398 Private slot to leave all channels and close their tabs.
377 </p><dl> 399 </p><a NAME="IrcWidget.__leaveChannel" ID="IrcWidget.__leaveChannel"></a>
378 <dt><i>name</i></dt>
379 <dd>
380 name of the channel (string)
381 </dd><dt><i>key</i></dt>
382 <dd>
383 key of the channel (string)
384 </dd>
385 </dl><a NAME="IrcWidget.__leaveChannel" ID="IrcWidget.__leaveChannel"></a>
386 <h4>IrcWidget.__leaveChannel</h4> 400 <h4>IrcWidget.__leaveChannel</h4>
387 <b>__leaveChannel</b>(<i></i>) 401 <b>__leaveChannel</b>(<i></i>)
388 <p> 402 <p>
389 Private slot to leave a channel and close the associated tab. 403 Private slot to leave a channel and close the associated tab.
390 </p><a NAME="IrcWidget.__networkDataChanged" ID="IrcWidget.__networkDataChanged"></a> 404 </p><a NAME="IrcWidget.__leaveChannels" ID="IrcWidget.__leaveChannels"></a>
405 <h4>IrcWidget.__leaveChannels</h4>
406 <b>__leaveChannels</b>(<i>channelNames</i>)
407 <p>
408 Private slot to leave a list of channels and close their associated
409 tabs.
410 </p><dl>
411 <dt><i>channelNames</i> (list of str)</dt>
412 <dd>
413 list of channels to leave
414 </dd>
415 </dl><a NAME="IrcWidget.__networkDataChanged" ID="IrcWidget.__networkDataChanged"></a>
391 <h4>IrcWidget.__networkDataChanged</h4> 416 <h4>IrcWidget.__networkDataChanged</h4>
392 <b>__networkDataChanged</b>(<i></i>) 417 <b>__networkDataChanged</b>(<i></i>)
393 <p> 418 <p>
394 Private slot handling changes of the network and identity definitions. 419 Private slot handling changes of the network and identity definitions.
395 </p><a NAME="IrcWidget.__openPrivate" ID="IrcWidget.__openPrivate"></a> 420 </p><a NAME="IrcWidget.__openPrivate" ID="IrcWidget.__openPrivate"></a>
456 <h4>IrcWidget.__sendCtcpReply</h4> 481 <h4>IrcWidget.__sendCtcpReply</h4>
457 <b>__sendCtcpReply</b>(<i>receiver, text</i>) 482 <b>__sendCtcpReply</b>(<i>receiver, text</i>)
458 <p> 483 <p>
459 Private slot to send a CTCP reply. 484 Private slot to send a CTCP reply.
460 </p><dl> 485 </p><dl>
461 <dt><i>receiver</i></dt> 486 <dt><i>receiver</i> (str)</dt>
462 <dd> 487 <dd>
463 nick name of the receiver (string) 488 nick name of the receiver
464 </dd><dt><i>text</i></dt> 489 </dd><dt><i>text</i> (str)</dt>
465 <dd> 490 <dd>
466 text to be sent (string) 491 text to be sent
492 </dd>
493 </dl><a NAME="IrcWidget.__sendCtcpRequest" ID="IrcWidget.__sendCtcpRequest"></a>
494 <h4>IrcWidget.__sendCtcpRequest</h4>
495 <b>__sendCtcpRequest</b>(<i>receiver, request, arguments</i>)
496 <p>
497 Private slot to send a CTCP request.
498 </p><dl>
499 <dt><i>receiver</i> (str)</dt>
500 <dd>
501 nick name of the receiver
502 </dd><dt><i>request</i> (str)</dt>
503 <dd>
504 CTCP request to be sent
505 </dd><dt><i>arguments</i> (str)</dt>
506 <dd>
507 arguments to be sent
467 </dd> 508 </dd>
468 </dl><a NAME="IrcWidget.__setChannelTypePrefixes" ID="IrcWidget.__setChannelTypePrefixes"></a> 509 </dl><a NAME="IrcWidget.__setChannelTypePrefixes" ID="IrcWidget.__setChannelTypePrefixes"></a>
469 <h4>IrcWidget.__setChannelTypePrefixes</h4> 510 <h4>IrcWidget.__setChannelTypePrefixes</h4>
470 <b>__setChannelTypePrefixes</b>(<i>prefixes</i>) 511 <b>__setChannelTypePrefixes</b>(<i>prefixes</i>)
471 <p> 512 <p>
532 </dl><dl> 573 </dl><dl>
533 <dt>Returns:</dt> 574 <dt>Returns:</dt>
534 <dd> 575 <dd>
535 flag indicating a channel name (boolean) 576 flag indicating a channel name (boolean)
536 </dd> 577 </dd>
578 </dl><a NAME="IrcWidget.joinChannel" ID="IrcWidget.joinChannel"></a>
579 <h4>IrcWidget.joinChannel</h4>
580 <b>joinChannel</b>(<i>name, key=""</i>)
581 <p>
582 Public slot to join a channel.
583 </p><dl>
584 <dt><i>name</i></dt>
585 <dd>
586 name of the channel (string)
587 </dd><dt><i>key</i></dt>
588 <dd>
589 key of the channel (string)
590 </dd>
537 </dl><a NAME="IrcWidget.on_channelsWidget_tabCloseRequested" ID="IrcWidget.on_channelsWidget_tabCloseRequested"></a> 591 </dl><a NAME="IrcWidget.on_channelsWidget_tabCloseRequested" ID="IrcWidget.on_channelsWidget_tabCloseRequested"></a>
538 <h4>IrcWidget.on_channelsWidget_tabCloseRequested</h4> 592 <h4>IrcWidget.on_channelsWidget_tabCloseRequested</h4>
539 <b>on_channelsWidget_tabCloseRequested</b>(<i>index</i>) 593 <b>on_channelsWidget_tabCloseRequested</b>(<i>index</i>)
540 <p> 594 <p>
541 Private slot to close a channel by pressing the close button of 595 Private slot to close a channel by pressing the close button of

eric ide

mercurial