Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.E5Gui.E5ErrorMessage.html
eric6/Documentation/Source/eric6.E5Gui.E5ErrorMessage.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7204
- cbf6d88004ce
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.E5Gui.E5ErrorMessage</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.E5Gui.E5ErrorMessage</h1> | |
| 23 <p> | |
| 24 Module implementing a specialized error message dialog. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>_defaultFilters</td></tr><tr><td>_filterSettings</td></tr><tr><td>_msgHandlerDialog</td></tr><tr><td>_origMsgHandler</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#E5ErrorMessage">E5ErrorMessage</a></td> | |
| 34 <td>Class implementing a specialized error message dialog.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#editMessageFilters">editMessageFilters</a></td> | |
| 41 <td>Module function to edit the list of message filters.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#filterMessage">filterMessage</a></td> | |
| 44 <td>Module function to filter messages.</td> | |
| 45 </tr><tr> | |
| 46 <td><a href="#messageHandler">messageHandler</a></td> | |
| 47 <td>Module function handling messages.</td> | |
| 48 </tr><tr> | |
| 49 <td><a href="#messageHandlerInstalled">messageHandlerInstalled</a></td> | |
| 50 <td>Module function to check, if a message handler was installed.</td> | |
| 51 </tr><tr> | |
| 52 <td><a href="#qtHandler">qtHandler</a></td> | |
| 53 <td>Module function to install an E5ErrorMessage dialog as the global message handler.</td> | |
| 54 </tr> | |
| 55 </table> | |
| 56 <hr /><hr /> | |
| 57 <a NAME="E5ErrorMessage" ID="E5ErrorMessage"></a> | |
| 58 <h2>E5ErrorMessage</h2> | |
| 59 <p> | |
| 60 Class implementing a specialized error message dialog. | |
| 61 </p> | |
| 62 <h3>Derived from</h3> | |
| 63 QErrorMessage | |
| 64 <h3>Class Attributes</h3> | |
| 65 <table> | |
| 66 <tr><td>None</td></tr> | |
| 67 </table> | |
| 68 <h3>Class Methods</h3> | |
| 69 <table> | |
| 70 <tr><td>None</td></tr> | |
| 71 </table> | |
| 72 <h3>Methods</h3> | |
| 73 <table> | |
| 74 <tr> | |
| 75 <td><a href="#E5ErrorMessage.__init__">E5ErrorMessage</a></td> | |
| 76 <td>Constructor</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#E5ErrorMessage.editMessageFilters">editMessageFilters</a></td> | |
| 79 <td>Public method to edit the list of message filters.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#E5ErrorMessage.showMessage">showMessage</a></td> | |
| 82 <td>Public method to show a message.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <h3>Static Methods</h3> | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <a NAME="E5ErrorMessage.__init__" ID="E5ErrorMessage.__init__"></a> | |
| 90 <h4>E5ErrorMessage (Constructor)</h4> | |
| 91 <b>E5ErrorMessage</b>(<i>parent=None</i>) | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p><dl> | |
| 95 <dt><i>parent</i> (QWidget)</dt> | |
| 96 <dd> | |
| 97 reference to the parent widget | |
| 98 </dd> | |
| 99 </dl><a NAME="E5ErrorMessage.editMessageFilters" ID="E5ErrorMessage.editMessageFilters"></a> | |
| 100 <h4>E5ErrorMessage.editMessageFilters</h4> | |
| 101 <b>editMessageFilters</b>(<i></i>) | |
| 102 <p> | |
| 103 Public method to edit the list of message filters. | |
| 104 </p><a NAME="E5ErrorMessage.showMessage" ID="E5ErrorMessage.showMessage"></a> | |
| 105 <h4>E5ErrorMessage.showMessage</h4> | |
| 106 <b>showMessage</b>(<i>message, msgType=""</i>) | |
| 107 <p> | |
| 108 Public method to show a message. | |
| 109 </p><dl> | |
| 110 <dt><i>message</i> (str)</dt> | |
| 111 <dd> | |
| 112 error message to be shown | |
| 113 </dd><dt><i>msgType</i> (str)</dt> | |
| 114 <dd> | |
| 115 type of the error message | |
| 116 </dd> | |
| 117 </dl> | |
| 118 <div align="right"><a href="#top">Up</a></div> | |
| 119 <hr /><hr /> | |
| 120 <a NAME="editMessageFilters" ID="editMessageFilters"></a> | |
| 121 <h2>editMessageFilters</h2> | |
| 122 <b>editMessageFilters</b>(<i></i>) | |
| 123 <p> | |
| 124 Module function to edit the list of message filters. | |
| 125 </p> | |
| 126 <div align="right"><a href="#top">Up</a></div> | |
| 127 <hr /><hr /> | |
| 128 <a NAME="filterMessage" ID="filterMessage"></a> | |
| 129 <h2>filterMessage</h2> | |
| 130 <b>filterMessage</b>(<i>message</i>) | |
| 131 <p> | |
| 132 Module function to filter messages. | |
| 133 </p><dl> | |
| 134 <dt><i>message</i> (str)</dt> | |
| 135 <dd> | |
| 136 message to be checked | |
| 137 </dd> | |
| 138 </dl><dl> | |
| 139 <dt>Returns:</dt> | |
| 140 <dd> | |
| 141 flag indicating that the message should be filtered out | |
| 142 </dd> | |
| 143 </dl><dl> | |
| 144 <dt>Return Type:</dt> | |
| 145 <dd> | |
| 146 bool | |
| 147 </dd> | |
| 148 </dl> | |
| 149 <div align="right"><a href="#top">Up</a></div> | |
| 150 <hr /><hr /> | |
| 151 <a NAME="messageHandler" ID="messageHandler"></a> | |
| 152 <h2>messageHandler</h2> | |
| 153 <b>messageHandler</b>(<i>msgType, *args</i>) | |
| 154 <p> | |
| 155 Module function handling messages. | |
| 156 </p><dl> | |
| 157 <dt><i>msgType</i> (int, QtMsgType)</dt> | |
| 158 <dd> | |
| 159 type of the message | |
| 160 </dd><dt><i>args</i> (PyQt4: bytes; PyQt5: tuple of (QMessageLogContext, bytes))</dt> | |
| 161 <dd> | |
| 162 message handler arguments, for PyQt4 message to be shown, for | |
| 163 PyQt5 context information and message to be shown | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <div align="right"><a href="#top">Up</a></div> | |
| 167 <hr /><hr /> | |
| 168 <a NAME="messageHandlerInstalled" ID="messageHandlerInstalled"></a> | |
| 169 <h2>messageHandlerInstalled</h2> | |
| 170 <b>messageHandlerInstalled</b>(<i></i>) | |
| 171 <p> | |
| 172 Module function to check, if a message handler was installed. | |
| 173 </p><dl> | |
| 174 <dt>Returns:</dt> | |
| 175 <dd> | |
| 176 flag indicating an installed message handler | |
| 177 </dd> | |
| 178 </dl><dl> | |
| 179 <dt>Return Type:</dt> | |
| 180 <dd> | |
| 181 bool | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <div align="right"><a href="#top">Up</a></div> | |
| 185 <hr /><hr /> | |
| 186 <a NAME="qtHandler" ID="qtHandler"></a> | |
| 187 <h2>qtHandler</h2> | |
| 188 <b>qtHandler</b>(<i></i>) | |
| 189 <p> | |
| 190 Module function to install an E5ErrorMessage dialog as the global | |
| 191 message handler. | |
| 192 </p><dl> | |
| 193 <dt>Returns:</dt> | |
| 194 <dd> | |
| 195 reference to the message handler dialog | |
| 196 </dd> | |
| 197 </dl><dl> | |
| 198 <dt>Return Type:</dt> | |
| 199 <dd> | |
| 200 E5ErrorMessage | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <div align="right"><a href="#top">Up</a></div> | |
| 204 <hr /> | |
| 205 </body></html> |
