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

changeset 6514
f11a703e4664
parent 3673
e26d7d0c1088
child 6536
c3dca7b0a486
equal deleted inserted replaced
6513:e1fcd71fbda3 6514:f11a703e4664
46 <h2>IrcChannelWidget</h2> 46 <h2>IrcChannelWidget</h2>
47 <p> 47 <p>
48 Class implementing the IRC channel widget. 48 Class implementing the IRC channel widget.
49 </p><h3>Signals</h3> 49 </p><h3>Signals</h3>
50 <dl> 50 <dl>
51 <dt>channelClosed(str)</dt> 51 <dt>awayCommand(str)</dt>
52 <dd>
53 emitted to set the away status via the /away
54 command
55 </dd><dt>channelClosed(str)</dt>
52 <dd> 56 <dd>
53 emitted after the user has left the channel 57 emitted after the user has left the channel
58 </dd><dt>leaveAllChannels()</dt>
59 <dd>
60 emitted to leave all channels
61 </dd><dt>leaveChannels(list)</dt>
62 <dd>
63 emitted to leave a list of channels
54 </dd><dt>openPrivateChat(str)</dt> 64 </dd><dt>openPrivateChat(str)</dt>
55 <dd> 65 <dd>
56 emitted to open a "channel" for private 66 emitted to open a "channel" for private
57 messages 67 messages
58 </dd><dt>sendCtcpReply(str, str)</dt> 68 </dd><dt>sendCtcpReply(str, str)</dt>
59 <dd> 69 <dd>
60 emitted to send a CTCP reply 70 emitted to send a CTCP reply
71 </dd><dt>sendCtcpRequest(str, str, str)</dt>
72 <dd>
73 emitted to send a CTCP request
61 </dd><dt>sendData(str)</dt> 74 </dd><dt>sendData(str)</dt>
62 <dd> 75 <dd>
63 emitted to send a message to the channel 76 emitted to send a message to the channel
64 </dd> 77 </dd>
65 </dl> 78 </dl>
236 <td>Protected method handling hide events.</td> 249 <td>Protected method handling hide events.</td>
237 </tr><tr> 250 </tr><tr>
238 <td><a href="#IrcChannelWidget.initAutoWho">initAutoWho</a></td> 251 <td><a href="#IrcChannelWidget.initAutoWho">initAutoWho</a></td>
239 <td>Public method to initialize the Auto Who system.</td> 252 <td>Public method to initialize the Auto Who system.</td>
240 </tr><tr> 253 </tr><tr>
254 <td><a href="#IrcChannelWidget.leaveChannel">leaveChannel</a></td>
255 <td>Public slot to leave the channel.</td>
256 </tr><tr>
241 <td><a href="#IrcChannelWidget.name">name</a></td> 257 <td><a href="#IrcChannelWidget.name">name</a></td>
242 <td>Public method to get the name of the channel.</td> 258 <td>Public method to get the name of the channel.</td>
243 </tr><tr> 259 </tr><tr>
244 <td><a href="#IrcChannelWidget.on_editTopicButton_clicked">on_editTopicButton_clicked</a></td> 260 <td><a href="#IrcChannelWidget.on_editTopicButton_clicked">on_editTopicButton_clicked</a></td>
245 <td>Private slot to change the topic of the channel.</td> 261 <td>Private slot to change the topic of the channel.</td>
964 </dl><a NAME="IrcChannelWidget.initAutoWho" ID="IrcChannelWidget.initAutoWho"></a> 980 </dl><a NAME="IrcChannelWidget.initAutoWho" ID="IrcChannelWidget.initAutoWho"></a>
965 <h4>IrcChannelWidget.initAutoWho</h4> 981 <h4>IrcChannelWidget.initAutoWho</h4>
966 <b>initAutoWho</b>(<i></i>) 982 <b>initAutoWho</b>(<i></i>)
967 <p> 983 <p>
968 Public method to initialize the Auto Who system. 984 Public method to initialize the Auto Who system.
985 </p><a NAME="IrcChannelWidget.leaveChannel" ID="IrcChannelWidget.leaveChannel"></a>
986 <h4>IrcChannelWidget.leaveChannel</h4>
987 <b>leaveChannel</b>(<i></i>)
988 <p>
989 Public slot to leave the channel.
969 </p><a NAME="IrcChannelWidget.name" ID="IrcChannelWidget.name"></a> 990 </p><a NAME="IrcChannelWidget.name" ID="IrcChannelWidget.name"></a>
970 <h4>IrcChannelWidget.name</h4> 991 <h4>IrcChannelWidget.name</h4>
971 <b>name</b>(<i></i>) 992 <b>name</b>(<i></i>)
972 <p> 993 <p>
973 Public method to get the name of the channel. 994 Public method to get the name of the channel.
1163 <td>Private method to convert an icon to an away icon.</td> 1184 <td>Private method to convert an icon to an away icon.</td>
1164 </tr><tr> 1185 </tr><tr>
1165 <td><a href="#IrcUserItem.__setIcon">__setIcon</a></td> 1186 <td><a href="#IrcUserItem.__setIcon">__setIcon</a></td>
1166 <td>Private method to set the icon dependent on user privileges.</td> 1187 <td>Private method to set the icon dependent on user privileges.</td>
1167 </tr><tr> 1188 </tr><tr>
1189 <td><a href="#IrcUserItem.__setText">__setText</a></td>
1190 <td>Private method to set the user item text.</td>
1191 </tr><tr>
1168 <td><a href="#IrcUserItem.canChangeTopic">canChangeTopic</a></td> 1192 <td><a href="#IrcUserItem.canChangeTopic">canChangeTopic</a></td>
1169 <td>Public method to check, if the user is allowed to change the topic.</td> 1193 <td>Public method to check, if the user is allowed to change the topic.</td>
1170 </tr><tr> 1194 </tr><tr>
1171 <td><a href="#IrcUserItem.changePrivilege">changePrivilege</a></td> 1195 <td><a href="#IrcUserItem.changePrivilege">changePrivilege</a></td>
1172 <td>Public method to set or unset a user privilege.</td> 1196 <td>Public method to set or unset a user privilege.</td>
1173 </tr><tr> 1197 </tr><tr>
1174 <td><a href="#IrcUserItem.clearPrivileges">clearPrivileges</a></td> 1198 <td><a href="#IrcUserItem.clearPrivileges">clearPrivileges</a></td>
1175 <td>Public method to clear the user privileges.</td> 1199 <td>Public method to clear the user privileges.</td>
1176 </tr><tr> 1200 </tr><tr>
1201 <td><a href="#IrcUserItem.isIgnored">isIgnored</a></td>
1202 <td>Public method to check, if this user is ignored.</td>
1203 </tr><tr>
1177 <td><a href="#IrcUserItem.name">name</a></td> 1204 <td><a href="#IrcUserItem.name">name</a></td>
1178 <td>Public method to get the user name.</td> 1205 <td>Public method to get the user name.</td>
1179 </tr><tr> 1206 </tr><tr>
1180 <td><a href="#IrcUserItem.parseWhoFlags">parseWhoFlags</a></td> 1207 <td><a href="#IrcUserItem.parseWhoFlags">parseWhoFlags</a></td>
1181 <td>Public method to parse the user flags reported by a WHO command.</td> 1208 <td>Public method to parse the user flags reported by a WHO command.</td>
1209 </tr><tr>
1210 <td><a href="#IrcUserItem.setIgnored">setIgnored</a></td>
1211 <td>Public method to set the user status to ignored.</td>
1182 </tr><tr> 1212 </tr><tr>
1183 <td><a href="#IrcUserItem.setName">setName</a></td> 1213 <td><a href="#IrcUserItem.setName">setName</a></td>
1184 <td>Public method to set a new nick name.</td> 1214 <td>Public method to set a new nick name.</td>
1185 </tr> 1215 </tr>
1186 </table> 1216 </table>
1220 </dl><a NAME="IrcUserItem.__setIcon" ID="IrcUserItem.__setIcon"></a> 1250 </dl><a NAME="IrcUserItem.__setIcon" ID="IrcUserItem.__setIcon"></a>
1221 <h4>IrcUserItem.__setIcon</h4> 1251 <h4>IrcUserItem.__setIcon</h4>
1222 <b>__setIcon</b>(<i></i>) 1252 <b>__setIcon</b>(<i></i>)
1223 <p> 1253 <p>
1224 Private method to set the icon dependent on user privileges. 1254 Private method to set the icon dependent on user privileges.
1255 </p><a NAME="IrcUserItem.__setText" ID="IrcUserItem.__setText"></a>
1256 <h4>IrcUserItem.__setText</h4>
1257 <b>__setText</b>(<i></i>)
1258 <p>
1259 Private method to set the user item text.
1225 </p><a NAME="IrcUserItem.canChangeTopic" ID="IrcUserItem.canChangeTopic"></a> 1260 </p><a NAME="IrcUserItem.canChangeTopic" ID="IrcUserItem.canChangeTopic"></a>
1226 <h4>IrcUserItem.canChangeTopic</h4> 1261 <h4>IrcUserItem.canChangeTopic</h4>
1227 <b>canChangeTopic</b>(<i></i>) 1262 <b>canChangeTopic</b>(<i></i>)
1228 <p> 1263 <p>
1229 Public method to check, if the user is allowed to change the topic. 1264 Public method to check, if the user is allowed to change the topic.
1245 </dl><a NAME="IrcUserItem.clearPrivileges" ID="IrcUserItem.clearPrivileges"></a> 1280 </dl><a NAME="IrcUserItem.clearPrivileges" ID="IrcUserItem.clearPrivileges"></a>
1246 <h4>IrcUserItem.clearPrivileges</h4> 1281 <h4>IrcUserItem.clearPrivileges</h4>
1247 <b>clearPrivileges</b>(<i></i>) 1282 <b>clearPrivileges</b>(<i></i>)
1248 <p> 1283 <p>
1249 Public method to clear the user privileges. 1284 Public method to clear the user privileges.
1250 </p><a NAME="IrcUserItem.name" ID="IrcUserItem.name"></a> 1285 </p><a NAME="IrcUserItem.isIgnored" ID="IrcUserItem.isIgnored"></a>
1286 <h4>IrcUserItem.isIgnored</h4>
1287 <b>isIgnored</b>(<i></i>)
1288 <p>
1289 Public method to check, if this user is ignored.
1290 </p><dl>
1291 <dt>Returns:</dt>
1292 <dd>
1293 flag indicating the ignored status
1294 </dd>
1295 </dl><dl>
1296 <dt>Return Type:</dt>
1297 <dd>
1298 bool
1299 </dd>
1300 </dl><a NAME="IrcUserItem.name" ID="IrcUserItem.name"></a>
1251 <h4>IrcUserItem.name</h4> 1301 <h4>IrcUserItem.name</h4>
1252 <b>name</b>(<i></i>) 1302 <b>name</b>(<i></i>)
1253 <p> 1303 <p>
1254 Public method to get the user name. 1304 Public method to get the user name.
1255 </p><dl> 1305 </p><dl>
1264 Public method to parse the user flags reported by a WHO command. 1314 Public method to parse the user flags reported by a WHO command.
1265 </p><dl> 1315 </p><dl>
1266 <dt><i>flags</i></dt> 1316 <dt><i>flags</i></dt>
1267 <dd> 1317 <dd>
1268 user flags as reported by WHO (string) 1318 user flags as reported by WHO (string)
1319 </dd>
1320 </dl><a NAME="IrcUserItem.setIgnored" ID="IrcUserItem.setIgnored"></a>
1321 <h4>IrcUserItem.setIgnored</h4>
1322 <b>setIgnored</b>(<i>ignored</i>)
1323 <p>
1324 Public method to set the user status to ignored.
1325 </p><dl>
1326 <dt><i>ignored</i> (bool)</dt>
1327 <dd>
1328 flag indicating the new ignored status
1269 </dd> 1329 </dd>
1270 </dl><a NAME="IrcUserItem.setName" ID="IrcUserItem.setName"></a> 1330 </dl><a NAME="IrcUserItem.setName" ID="IrcUserItem.setName"></a>
1271 <h4>IrcUserItem.setName</h4> 1331 <h4>IrcUserItem.setName</h4>
1272 <b>setName</b>(<i>name</i>) 1332 <b>setName</b>(<i>name</i>)
1273 <p> 1333 <p>

eric ide

mercurial