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

changeset 6514
f11a703e4664
parent 4630
7b0e38956b5c
diff -r e1fcd71fbda3 -r f11a703e4664 Documentation/Source/eric6.Network.IRC.IrcWidget.html
--- a/Documentation/Source/eric6.Network.IRC.IrcWidget.html	Fri Sep 28 20:07:25 2018 +0200
+++ b/Documentation/Source/eric6.Network.IRC.IrcWidget.html	Sat Sep 29 19:32:33 2018 +0200
@@ -90,6 +90,9 @@
 <td><a href="#IrcWidget.__handleCtcp">__handleCtcp</a></td>
 <td>Private method to handle a CTCP command.</td>
 </tr><tr>
+<td><a href="#IrcWidget.__handleCtcpReply">__handleCtcpReply</a></td>
+<td>Private method to handle a server message containing a CTCP reply.</td>
+</tr><tr>
 <td><a href="#IrcWidget.__handleNamedMessage">__handleNamedMessage</a></td>
 <td>Private method to handle a server message containing a message name.</td>
 </tr><tr>
@@ -117,12 +120,15 @@
 <td><a href="#IrcWidget.__hostFound">__hostFound</a></td>
 <td>Private slot to indicate the host was found.</td>
 </tr><tr>
-<td><a href="#IrcWidget.__joinChannel">__joinChannel</a></td>
-<td>Private slot to join a channel.</td>
+<td><a href="#IrcWidget.__leaveAllChannels">__leaveAllChannels</a></td>
+<td>Private slot to leave all channels and close their tabs.</td>
 </tr><tr>
 <td><a href="#IrcWidget.__leaveChannel">__leaveChannel</a></td>
 <td>Private slot to leave a channel and close the associated tab.</td>
 </tr><tr>
+<td><a href="#IrcWidget.__leaveChannels">__leaveChannels</a></td>
+<td>Private slot to leave a list of channels and close their associated tabs.</td>
+</tr><tr>
 <td><a href="#IrcWidget.__networkDataChanged">__networkDataChanged</a></td>
 <td>Private slot handling changes of the network and identity definitions.</td>
 </tr><tr>
@@ -147,6 +153,9 @@
 <td><a href="#IrcWidget.__sendCtcpReply">__sendCtcpReply</a></td>
 <td>Private slot to send a CTCP reply.</td>
 </tr><tr>
+<td><a href="#IrcWidget.__sendCtcpRequest">__sendCtcpRequest</a></td>
+<td>Private slot to send a CTCP request.</td>
+</tr><tr>
 <td><a href="#IrcWidget.__setChannelTypePrefixes">__setChannelTypePrefixes</a></td>
 <td>Private method to set the channel type prefixes.</td>
 </tr><tr>
@@ -168,6 +177,9 @@
 <td><a href="#IrcWidget.isChannelName">isChannelName</a></td>
 <td>Public method to check, if the given name is a channel name.</td>
 </tr><tr>
+<td><a href="#IrcWidget.joinChannel">joinChannel</a></td>
+<td>Public slot to join a channel.</td>
+</tr><tr>
 <td><a href="#IrcWidget.on_channelsWidget_tabCloseRequested">on_channelsWidget_tabCloseRequested</a></td>
 <td>Private slot to close a channel by pressing the close button of the channels widget.</td>
 </tr><tr>
@@ -271,6 +283,16 @@
 <dd>
 flag indicating, if the message was handled (boolean)
 </dd>
+</dl><a NAME="IrcWidget.__handleCtcpReply" ID="IrcWidget.__handleCtcpReply"></a>
+<h4>IrcWidget.__handleCtcpReply</h4>
+<b>__handleCtcpReply</b>(<i>match</i>)
+<p>
+        Private method to handle a server message containing a CTCP reply.
+</p><dl>
+<dt><i>match</i></dt>
+<dd>
+reference to the match object
+</dd>
 </dl><a NAME="IrcWidget.__handleNamedMessage" ID="IrcWidget.__handleNamedMessage"></a>
 <h4>IrcWidget.__handleNamedMessage</h4>
 <b>__handleNamedMessage</b>(<i>match</i>)
@@ -369,25 +391,28 @@
 <b>__hostFound</b>(<i></i>)
 <p>
         Private slot to indicate the host was found.
-</p><a NAME="IrcWidget.__joinChannel" ID="IrcWidget.__joinChannel"></a>
-<h4>IrcWidget.__joinChannel</h4>
-<b>__joinChannel</b>(<i>name, key=""</i>)
+</p><a NAME="IrcWidget.__leaveAllChannels" ID="IrcWidget.__leaveAllChannels"></a>
+<h4>IrcWidget.__leaveAllChannels</h4>
+<b>__leaveAllChannels</b>(<i></i>)
 <p>
-        Private slot to join a channel.
-</p><dl>
-<dt><i>name</i></dt>
-<dd>
-name of the channel (string)
-</dd><dt><i>key</i></dt>
-<dd>
-key of the channel (string)
-</dd>
-</dl><a NAME="IrcWidget.__leaveChannel" ID="IrcWidget.__leaveChannel"></a>
+        Private slot to leave all channels and close their tabs.
+</p><a NAME="IrcWidget.__leaveChannel" ID="IrcWidget.__leaveChannel"></a>
 <h4>IrcWidget.__leaveChannel</h4>
 <b>__leaveChannel</b>(<i></i>)
 <p>
         Private slot to leave a channel and close the associated tab.
-</p><a NAME="IrcWidget.__networkDataChanged" ID="IrcWidget.__networkDataChanged"></a>
+</p><a NAME="IrcWidget.__leaveChannels" ID="IrcWidget.__leaveChannels"></a>
+<h4>IrcWidget.__leaveChannels</h4>
+<b>__leaveChannels</b>(<i>channelNames</i>)
+<p>
+        Private slot to leave a list of channels and close their associated
+        tabs.
+</p><dl>
+<dt><i>channelNames</i> (list of str)</dt>
+<dd>
+list of channels to leave
+</dd>
+</dl><a NAME="IrcWidget.__networkDataChanged" ID="IrcWidget.__networkDataChanged"></a>
 <h4>IrcWidget.__networkDataChanged</h4>
 <b>__networkDataChanged</b>(<i></i>)
 <p>
@@ -458,12 +483,28 @@
 <p>
         Private slot to send a CTCP reply.
 </p><dl>
-<dt><i>receiver</i></dt>
+<dt><i>receiver</i> (str)</dt>
+<dd>
+nick name of the receiver
+</dd><dt><i>text</i> (str)</dt>
 <dd>
-nick name of the receiver (string)
-</dd><dt><i>text</i></dt>
+text to be sent
+</dd>
+</dl><a NAME="IrcWidget.__sendCtcpRequest" ID="IrcWidget.__sendCtcpRequest"></a>
+<h4>IrcWidget.__sendCtcpRequest</h4>
+<b>__sendCtcpRequest</b>(<i>receiver, request, arguments</i>)
+<p>
+        Private slot to send a CTCP request.
+</p><dl>
+<dt><i>receiver</i> (str)</dt>
 <dd>
-text to be sent (string)
+nick name of the receiver
+</dd><dt><i>request</i> (str)</dt>
+<dd>
+CTCP request to be sent
+</dd><dt><i>arguments</i> (str)</dt>
+<dd>
+arguments to be sent
 </dd>
 </dl><a NAME="IrcWidget.__setChannelTypePrefixes" ID="IrcWidget.__setChannelTypePrefixes"></a>
 <h4>IrcWidget.__setChannelTypePrefixes</h4>
@@ -534,6 +575,19 @@
 <dd>
 flag indicating a channel name (boolean)
 </dd>
+</dl><a NAME="IrcWidget.joinChannel" ID="IrcWidget.joinChannel"></a>
+<h4>IrcWidget.joinChannel</h4>
+<b>joinChannel</b>(<i>name, key=""</i>)
+<p>
+        Public slot to join a channel.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the channel (string)
+</dd><dt><i>key</i></dt>
+<dd>
+key of the channel (string)
+</dd>
 </dl><a NAME="IrcWidget.on_channelsWidget_tabCloseRequested" ID="IrcWidget.on_channelsWidget_tabCloseRequested"></a>
 <h4>IrcWidget.on_channelsWidget_tabCloseRequested</h4>
 <b>on_channelsWidget_tabCloseRequested</b>(<i>index</i>)

eric ide

mercurial