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

branch
eric7
changeset 10428
a071d4065202
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Network.IRC.IrcNetworkWidget.html	Wed Dec 20 11:06:38 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Network.IRC.IrcNetworkWidget.html	Wed Dec 20 14:58:58 2023 +0100
@@ -231,9 +231,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="IrcNetworkWidget.__autoConnect" ID="IrcNetworkWidget.__autoConnect"></a>
@@ -318,13 +318,13 @@
 </p>
 <dl>
 
-<dt><i>msgType</i></dt>
+<dt><i>msgType</i> (str)</dt>
 <dd>
-txpe of the message (string)
+txpe of the message
 </dd>
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-message to be added (string)
+message to be added
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.addMessage" ID="IrcNetworkWidget.addMessage"></a>
@@ -336,9 +336,9 @@
 </p>
 <dl>
 
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-message to be added (string)
+message to be added
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.addServerMessage" ID="IrcNetworkWidget.addServerMessage"></a>
@@ -350,17 +350,17 @@
 </p>
 <dl>
 
-<dt><i>msgType</i></dt>
+<dt><i>msgType</i> (str)</dt>
 <dd>
-txpe of the message (string)
+txpe of the message
 </dd>
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-message to be added (string)
+message to be added
 </dd>
-<dt><i>filterMsg</i></dt>
+<dt><i>filterMsg</i> (bool)</dt>
 <dd>
-flag indicating to filter the message (boolean)
+flag indicating to filter the message
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.autoConnect" ID="IrcNetworkWidget.autoConnect"></a>
@@ -381,7 +381,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-associated channels (list of IrcChannel)
+associated channels
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of IrcChannel
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.getNickname" ID="IrcNetworkWidget.getNickname"></a>
@@ -394,7 +400,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-selected nick name (string)
+selected nick name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.handleAwayCommand" ID="IrcNetworkWidget.handleAwayCommand"></a>
@@ -420,9 +432,9 @@
 </p>
 <dl>
 
-<dt><i>manager</i></dt>
+<dt><i>manager</i> (IrcNetworkManager)</dt>
 <dd>
-reference to the network manager (IrcNetworkManager)
+reference to the network manager
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.isConnected" ID="IrcNetworkWidget.isConnected"></a>
@@ -435,7 +447,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a connected network (boolean)
+flag indicating a connected network
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.on_awayButton_clicked" ID="IrcNetworkWidget.on_awayButton_clicked"></a>
@@ -454,9 +472,9 @@
 </p>
 <dl>
 
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-current text of the channel combo (string)
+current text of the channel combo
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.on_connectButton_clicked" ID="IrcNetworkWidget.on_connectButton_clicked"></a>
@@ -489,9 +507,9 @@
 </p>
 <dl>
 
-<dt><i>url</i></dt>
+<dt><i>url</i> (QUrl)</dt>
 <dd>
-URL to be opened (QUrl)
+URL to be opened
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.on_messages_copyAvailable" ID="IrcNetworkWidget.on_messages_copyAvailable"></a>
@@ -504,9 +522,9 @@
 </p>
 <dl>
 
-<dt><i>yes</i></dt>
+<dt><i>yes</i> (bool)</dt>
 <dd>
-flag signaling the availability of selected text (boolean)
+flag signaling the availability of selected text
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.on_messages_customContextMenuRequested" ID="IrcNetworkWidget.on_messages_customContextMenuRequested"></a>
@@ -518,9 +536,9 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
 <dd>
-position the menu should be opened at (QPoint)
+position the menu should be opened at
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.on_networkCombo_currentIndexChanged" ID="IrcNetworkWidget.on_networkCombo_currentIndexChanged"></a>
@@ -546,7 +564,7 @@
 </p>
 <dl>
 
-<dt><i>nick</i></dt>
+<dt><i>nick</i> (int)</dt>
 <dd>
 index of the selected nick name (unused)
 </dd>
@@ -560,9 +578,9 @@
 </p>
 <dl>
 
-<dt><i>connected</i></dt>
+<dt><i>connected</i> (bool)</dt>
 <dd>
-flag indicating the connection state (boolean)
+flag indicating the connection state
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.setNickName" ID="IrcNetworkWidget.setNickName"></a>
@@ -574,9 +592,9 @@
 </p>
 <dl>
 
-<dt><i>nick</i></dt>
+<dt><i>nick</i> (str)</dt>
 <dd>
-nick name in use (string)
+nick name in use
 </dd>
 </dl>
 <a NAME="IrcNetworkWidget.setRegistered" ID="IrcNetworkWidget.setRegistered"></a>
@@ -588,9 +606,9 @@
 </p>
 <dl>
 
-<dt><i>registered</i></dt>
+<dt><i>registered</i> (bool)</dt>
 <dd>
-flag indicating the registration state (boolean)
+flag indicating the registration state
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial