src/eric7/Documentation/Source/eric7.Network.IRC.IrcWidget.html

branch
eric7
changeset 10428
a071d4065202
parent 10070
9f5758c0fec1
child 10478
de9106c55c3d
--- a/src/eric7/Documentation/Source/eric7.Network.IRC.IrcWidget.html	Wed Dec 20 11:06:38 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Network.IRC.IrcWidget.html	Wed Dec 20 14:58:58 2023 +0100
@@ -242,9 +242,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="IrcWidget.__autoJoinChannels" ID="IrcWidget.__autoJoinChannels"></a>
@@ -264,9 +264,9 @@
 </p>
 <dl>
 
-<dt><i>isAway</i></dt>
+<dt><i>isAway</i> (bool)</dt>
 <dd>
-flag indicating the current away state (boolean)
+flag indicating the current away state
 </dd>
 </dl>
 <a NAME="IrcWidget.__changeNick" ID="IrcWidget.__changeNick"></a>
@@ -278,9 +278,9 @@
 </p>
 <dl>
 
-<dt><i>nick</i></dt>
+<dt><i>nick</i> (str)</dt>
 <dd>
-nick name to use (str)
+nick name to use
 </dd>
 </dl>
 <a NAME="IrcWidget.__closeAllChannels" ID="IrcWidget.__closeAllChannels"></a>
@@ -299,9 +299,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the closed channel (string)
+name of the closed channel
 </dd>
 </dl>
 <a NAME="IrcWidget.__connectNetwork" ID="IrcWidget.__connectNetwork"></a>
@@ -313,17 +313,17 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the network to connect to (string)
+name of the network to connect to
 </dd>
-<dt><i>connect</i></dt>
+<dt><i>connect</i> (bool)</dt>
 <dd>
-flag indicating to connect (boolean)
+flag indicating to connect
 </dd>
-<dt><i>silent</i></dt>
+<dt><i>silent</i> (bool)</dt>
 <dd>
-flag indicating a silent connect/disconnect (boolean)
+flag indicating a silent connect/disconnect
 </dd>
 </dl>
 <a NAME="IrcWidget.__editNetwork" ID="IrcWidget.__editNetwork"></a>
@@ -342,7 +342,7 @@
 </p>
 <dl>
 
-<dt><i>match</i></dt>
+<dt><i>match</i> (re.Match)</dt>
 <dd>
 reference to the match object
 </dd>
@@ -350,7 +350,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, if the message was handled (boolean)
+flag indicating, if the message was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IrcWidget.__handleCtcpReply" ID="IrcWidget.__handleCtcpReply"></a>
@@ -362,7 +368,7 @@
 </p>
 <dl>
 
-<dt><i>match</i></dt>
+<dt><i>match</i> (re.Match)</dt>
 <dd>
 reference to the match object
 </dd>
@@ -376,7 +382,7 @@
 </p>
 <dl>
 
-<dt><i>match</i></dt>
+<dt><i>match</i> (re.Match)</dt>
 <dd>
 reference to the match object
 </dd>
@@ -384,7 +390,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, if the message was handled (boolean)
+flag indicating, if the message was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IrcWidget.__handleNickInUse" ID="IrcWidget.__handleNickInUse"></a>
@@ -410,7 +422,7 @@
 </p>
 <dl>
 
-<dt><i>match</i></dt>
+<dt><i>match</i> (re.Match)</dt>
 <dd>
 reference to the match object
 </dd>
@@ -418,7 +430,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, if the message was handled (boolean)
+flag indicating, if the message was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IrcWidget.__handleServerError" ID="IrcWidget.__handleServerError"></a>
@@ -430,19 +448,25 @@
 </p>
 <dl>
 
-<dt><i>code</i></dt>
+<dt><i>code</i> (int)</dt>
 <dd>
-numerical code sent by the server (integer)
+numerical code sent by the server
 </dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-message sent by the server (string)
+message sent by the server
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, if the message was handled (boolean)
+flag indicating, if the message was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IrcWidget.__handleServerReply" ID="IrcWidget.__handleServerReply"></a>
@@ -454,23 +478,29 @@
 </p>
 <dl>
 
-<dt><i>code</i></dt>
+<dt><i>code</i> (int)</dt>
 <dd>
-numerical code sent by the server (integer)
+numerical code sent by the server
 </dd>
-<dt><i>server</i></dt>
+<dt><i>server</i> (str)</dt>
 <dd>
-name of the server (string)
+name of the server
 </dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-message sent by the server (string)
+message sent by the server
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, if the message was handled (boolean)
+flag indicating, if the message was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IrcWidget.__hostConnected" ID="IrcWidget.__hostConnected"></a>
@@ -540,9 +570,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the user (string)
+name of the user
 </dd>
 </dl>
 <a NAME="IrcWidget.__ping" ID="IrcWidget.__ping"></a>
@@ -554,7 +584,7 @@
 </p>
 <dl>
 
-<dt><i>match</i></dt>
+<dt><i>match</i> (re.Match)</dt>
 <dd>
 reference to the match object
 </dd>
@@ -562,7 +592,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, if the message was handled (boolean)
+flag indicating, if the message was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IrcWidget.__query" ID="IrcWidget.__query"></a>
@@ -574,7 +610,7 @@
 </p>
 <dl>
 
-<dt><i>match</i></dt>
+<dt><i>match</i> (re.Match)</dt>
 <dd>
 reference to the match object
 </dd>
@@ -582,7 +618,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, if the message was handled (boolean)
+flag indicating, if the message was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IrcWidget.__readyRead" ID="IrcWidget.__readyRead"></a>
@@ -608,9 +650,9 @@
 </p>
 <dl>
 
-<dt><i>data</i></dt>
+<dt><i>data</i> (str)</dt>
 <dd>
-data to be sent (string)
+data to be sent
 </dd>
 </dl>
 <a NAME="IrcWidget.__sendCtcpReply" ID="IrcWidget.__sendCtcpReply"></a>
@@ -662,9 +704,9 @@
 </p>
 <dl>
 
-<dt><i>prefixes</i></dt>
+<dt><i>prefixes</i> (str)</dt>
 <dd>
-channel prefix characters (string)
+channel prefix characters
 </dd>
 </dl>
 <a NAME="IrcWidget.__setUserPrivilegePrefix" ID="IrcWidget.__setUserPrivilegePrefix"></a>
@@ -676,13 +718,13 @@
 </p>
 <dl>
 
-<dt><i>prefix1</i></dt>
+<dt><i>prefix1</i> (str)</dt>
 <dd>
-first part of the prefix (string)
+first part of the prefix
 </dd>
-<dt><i>prefix2</i></dt>
+<dt><i>prefix2</i> (str)</dt>
 <dd>
-indictors the first part gets mapped to (string)
+indictors the first part gets mapped to
 </dd>
 </dl>
 <a NAME="IrcWidget.__sslErrors" ID="IrcWidget.__sslErrors"></a>
@@ -694,9 +736,9 @@
 </p>
 <dl>
 
-<dt><i>errors</i></dt>
+<dt><i>errors</i> (list of QSslError)</dt>
 <dd>
-list of SSL errors (list of QSslError)
+list of SSL errors
 </dd>
 </dl>
 <a NAME="IrcWidget.__tcpError" ID="IrcWidget.__tcpError"></a>
@@ -708,10 +750,9 @@
 </p>
 <dl>
 
-<dt><i>error</i></dt>
+<dt><i>error</i> (QAbstractSocket.SocketError)</dt>
 <dd>
 error code reported by the socket
-            (QAbstractSocket.SocketError)
 </dd>
 </dl>
 <a NAME="IrcWidget.__updateUsersCount" ID="IrcWidget.__updateUsersCount"></a>
@@ -737,15 +778,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name to check (string)
+name to check
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a channel name (boolean)
+flag indicating a channel name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IrcWidget.joinChannel" ID="IrcWidget.joinChannel"></a>
@@ -757,13 +804,13 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the channel (string)
+name of the channel
 </dd>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
-key of the channel (string)
+key of the channel
 </dd>
 </dl>
 <a NAME="IrcWidget.on_channelsWidget_tabCloseRequested" ID="IrcWidget.on_channelsWidget_tabCloseRequested"></a>
@@ -776,9 +823,9 @@
 </p>
 <dl>
 
-<dt><i>index</i></dt>
+<dt><i>index</i> (int)</dt>
 <dd>
-index of the tab to be closed (integer)
+index of the tab to be closed
 </dd>
 </dl>
 <a NAME="IrcWidget.shutdown" ID="IrcWidget.shutdown"></a>
@@ -791,7 +838,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating successful shutdown (boolean)
+flag indicating successful shutdown
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial