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

changeset 6514
f11a703e4664
parent 3673
e26d7d0c1088
child 6536
c3dca7b0a486
--- a/Documentation/Source/eric6.Network.IRC.IrcChannelWidget.html	Fri Sep 28 20:07:25 2018 +0200
+++ b/Documentation/Source/eric6.Network.IRC.IrcChannelWidget.html	Sat Sep 29 19:32:33 2018 +0200
@@ -48,9 +48,19 @@
     Class implementing the IRC channel widget.
 </p><h3>Signals</h3>
 <dl>
-<dt>channelClosed(str)</dt>
+<dt>awayCommand(str)</dt>
+<dd>
+emitted to set the away status via the /away
+        command
+</dd><dt>channelClosed(str)</dt>
 <dd>
 emitted after the user has left the channel
+</dd><dt>leaveAllChannels()</dt>
+<dd>
+emitted to leave all channels
+</dd><dt>leaveChannels(list)</dt>
+<dd>
+emitted to leave a list of channels
 </dd><dt>openPrivateChat(str)</dt>
 <dd>
 emitted to open a "channel" for private
@@ -58,6 +68,9 @@
 </dd><dt>sendCtcpReply(str, str)</dt>
 <dd>
 emitted to send a CTCP reply
+</dd><dt>sendCtcpRequest(str, str, str)</dt>
+<dd>
+emitted to send a CTCP request
 </dd><dt>sendData(str)</dt>
 <dd>
 emitted to send a message to the channel
@@ -238,6 +251,9 @@
 <td><a href="#IrcChannelWidget.initAutoWho">initAutoWho</a></td>
 <td>Public method to initialize the Auto Who system.</td>
 </tr><tr>
+<td><a href="#IrcChannelWidget.leaveChannel">leaveChannel</a></td>
+<td>Public slot to leave the channel.</td>
+</tr><tr>
 <td><a href="#IrcChannelWidget.name">name</a></td>
 <td>Public method to get the name of the channel.</td>
 </tr><tr>
@@ -966,6 +982,11 @@
 <b>initAutoWho</b>(<i></i>)
 <p>
         Public method to initialize the Auto Who system.
+</p><a NAME="IrcChannelWidget.leaveChannel" ID="IrcChannelWidget.leaveChannel"></a>
+<h4>IrcChannelWidget.leaveChannel</h4>
+<b>leaveChannel</b>(<i></i>)
+<p>
+        Public slot to leave the channel.
 </p><a NAME="IrcChannelWidget.name" ID="IrcChannelWidget.name"></a>
 <h4>IrcChannelWidget.name</h4>
 <b>name</b>(<i></i>)
@@ -1165,6 +1186,9 @@
 <td><a href="#IrcUserItem.__setIcon">__setIcon</a></td>
 <td>Private method to set the icon dependent on user privileges.</td>
 </tr><tr>
+<td><a href="#IrcUserItem.__setText">__setText</a></td>
+<td>Private method to set the user item text.</td>
+</tr><tr>
 <td><a href="#IrcUserItem.canChangeTopic">canChangeTopic</a></td>
 <td>Public method to check, if the user is allowed to change the topic.</td>
 </tr><tr>
@@ -1174,12 +1198,18 @@
 <td><a href="#IrcUserItem.clearPrivileges">clearPrivileges</a></td>
 <td>Public method to clear the user privileges.</td>
 </tr><tr>
+<td><a href="#IrcUserItem.isIgnored">isIgnored</a></td>
+<td>Public method to check, if this user is ignored.</td>
+</tr><tr>
 <td><a href="#IrcUserItem.name">name</a></td>
 <td>Public method to get the user name.</td>
 </tr><tr>
 <td><a href="#IrcUserItem.parseWhoFlags">parseWhoFlags</a></td>
 <td>Public method to parse the user flags reported by a WHO command.</td>
 </tr><tr>
+<td><a href="#IrcUserItem.setIgnored">setIgnored</a></td>
+<td>Public method to set the user status to ignored.</td>
+</tr><tr>
 <td><a href="#IrcUserItem.setName">setName</a></td>
 <td>Public method to set a new nick name.</td>
 </tr>
@@ -1222,6 +1252,11 @@
 <b>__setIcon</b>(<i></i>)
 <p>
         Private method to set the icon dependent on user privileges.
+</p><a NAME="IrcUserItem.__setText" ID="IrcUserItem.__setText"></a>
+<h4>IrcUserItem.__setText</h4>
+<b>__setText</b>(<i></i>)
+<p>
+        Private method to set the user item text.
 </p><a NAME="IrcUserItem.canChangeTopic" ID="IrcUserItem.canChangeTopic"></a>
 <h4>IrcUserItem.canChangeTopic</h4>
 <b>canChangeTopic</b>(<i></i>)
@@ -1247,7 +1282,22 @@
 <b>clearPrivileges</b>(<i></i>)
 <p>
         Public method to clear the user privileges.
-</p><a NAME="IrcUserItem.name" ID="IrcUserItem.name"></a>
+</p><a NAME="IrcUserItem.isIgnored" ID="IrcUserItem.isIgnored"></a>
+<h4>IrcUserItem.isIgnored</h4>
+<b>isIgnored</b>(<i></i>)
+<p>
+        Public method to check, if this user is ignored.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating the ignored status
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="IrcUserItem.name" ID="IrcUserItem.name"></a>
 <h4>IrcUserItem.name</h4>
 <b>name</b>(<i></i>)
 <p>
@@ -1267,6 +1317,16 @@
 <dd>
 user flags as reported by WHO (string)
 </dd>
+</dl><a NAME="IrcUserItem.setIgnored" ID="IrcUserItem.setIgnored"></a>
+<h4>IrcUserItem.setIgnored</h4>
+<b>setIgnored</b>(<i>ignored</i>)
+<p>
+        Public method to set the user status to ignored.
+</p><dl>
+<dt><i>ignored</i> (bool)</dt>
+<dd>
+flag indicating the new ignored status
+</dd>
 </dl><a NAME="IrcUserItem.setName" ID="IrcUserItem.setName"></a>
 <h4>IrcUserItem.setName</h4>
 <b>setName</b>(<i>name</i>)

eric ide

mercurial