Documentation/Source/eric6.E5Gui.E5ErrorMessage.html

changeset 6391
0b91857640ed
parent 3991
73731c4bf5bd
diff -r 355b89e9bfad -r 0b91857640ed Documentation/Source/eric6.E5Gui.E5ErrorMessage.html
--- a/Documentation/Source/eric6.E5Gui.E5ErrorMessage.html	Sat Jun 30 17:02:52 2018 +0200
+++ b/Documentation/Source/eric6.E5Gui.E5ErrorMessage.html	Sat Jun 30 17:40:08 2018 +0200
@@ -25,7 +25,7 @@
 </p>
 <h3>Global Attributes</h3>
 <table>
-<tr><td>__msgHandlerDialog</td></tr><tr><td>__origMsgHandler</td></tr>
+<tr><td>_defaultFilters</td></tr><tr><td>_filterSettings</td></tr><tr><td>_msgHandlerDialog</td></tr><tr><td>_origMsgHandler</td></tr>
 </table>
 <h3>Classes</h3>
 <table>
@@ -40,6 +40,9 @@
 <td><a href="#editMessageFilters">editMessageFilters</a></td>
 <td>Module function to edit the list of message filters.</td>
 </tr><tr>
+<td><a href="#filterMessage">filterMessage</a></td>
+<td>Module function to filter messages.</td>
+</tr><tr>
 <td><a href="#messageHandler">messageHandler</a></td>
 <td>Module function handling messages.</td>
 </tr><tr>
@@ -72,9 +75,6 @@
 <td><a href="#E5ErrorMessage.__init__">E5ErrorMessage</a></td>
 <td>Constructor</td>
 </tr><tr>
-<td><a href="#E5ErrorMessage.__filterMessage">__filterMessage</a></td>
-<td>Private method to filter messages.</td>
-</tr><tr>
 <td><a href="#E5ErrorMessage.editMessageFilters">editMessageFilters</a></td>
 <td>Public method to edit the list of message filters.</td>
 </tr><tr>
@@ -92,25 +92,9 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
-</dd>
-</dl><a NAME="E5ErrorMessage.__filterMessage" ID="E5ErrorMessage.__filterMessage"></a>
-<h4>E5ErrorMessage.__filterMessage</h4>
-<b>__filterMessage</b>(<i>message</i>)
-<p>
-        Private method to filter messages.
-</p><dl>
-<dt><i>message</i></dt>
-<dd>
-message to be checked (string)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating that the message should be filtered out
-            (boolean)
+reference to the parent widget
 </dd>
 </dl><a NAME="E5ErrorMessage.editMessageFilters" ID="E5ErrorMessage.editMessageFilters"></a>
 <h4>E5ErrorMessage.editMessageFilters</h4>
@@ -123,12 +107,12 @@
 <p>
         Public method to show a message.
 </p><dl>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-error message to be shown (string)
-</dd><dt><i>msgType</i></dt>
+error message to be shown
+</dd><dt><i>msgType</i> (str)</dt>
 <dd>
-type of the error message (string)
+type of the error message
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -141,20 +125,42 @@
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="filterMessage" ID="filterMessage"></a>
+<h2>filterMessage</h2>
+<b>filterMessage</b>(<i>message</i>)
+<p>
+    Module function to filter messages.
+</p><dl>
+<dt><i>message</i> (str)</dt>
+<dd>
+message to be checked
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating that the message should be filtered out
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="messageHandler" ID="messageHandler"></a>
 <h2>messageHandler</h2>
 <b>messageHandler</b>(<i>msgType, *args</i>)
 <p>
     Module function handling messages.
 </p><dl>
-<dt><i>msgType</i></dt>
+<dt><i>msgType</i> (int, QtMsgType)</dt>
 <dd>
-type of the message (integer, QtMsgType)
-</dd><dt><i>args</i></dt>
+type of the message
+</dd><dt><i>args</i> (PyQt4: bytes; PyQt5: tuple of (QMessageLogContext, bytes))</dt>
 <dd>
-message handler arguments, for PyQt4 message to be shown
-        (bytes), for PyQt5 context information (QMessageLogContext) and
-        message to be shown (bytes)
+message handler arguments, for PyQt4 message to be shown, for
+        PyQt5 context information and message to be shown
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -167,7 +173,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating an installed message handler (boolean)
+flag indicating an installed message handler
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -181,7 +192,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-reference to the message handler dialog (E5ErrorMessage)
+reference to the message handler dialog
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+E5ErrorMessage
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial