Documentation/Source/eric6.E5Gui.E5ErrorMessage.html

changeset 6391
0b91857640ed
parent 3991
73731c4bf5bd
equal deleted inserted replaced
6390:355b89e9bfad 6391:0b91857640ed
23 <p> 23 <p>
24 Module implementing a specialized error message dialog. 24 Module implementing a specialized error message dialog.
25 </p> 25 </p>
26 <h3>Global Attributes</h3> 26 <h3>Global Attributes</h3>
27 <table> 27 <table>
28 <tr><td>__msgHandlerDialog</td></tr><tr><td>__origMsgHandler</td></tr> 28 <tr><td>_defaultFilters</td></tr><tr><td>_filterSettings</td></tr><tr><td>_msgHandlerDialog</td></tr><tr><td>_origMsgHandler</td></tr>
29 </table> 29 </table>
30 <h3>Classes</h3> 30 <h3>Classes</h3>
31 <table> 31 <table>
32 <tr> 32 <tr>
33 <td><a href="#E5ErrorMessage">E5ErrorMessage</a></td> 33 <td><a href="#E5ErrorMessage">E5ErrorMessage</a></td>
37 <h3>Functions</h3> 37 <h3>Functions</h3>
38 <table> 38 <table>
39 <tr> 39 <tr>
40 <td><a href="#editMessageFilters">editMessageFilters</a></td> 40 <td><a href="#editMessageFilters">editMessageFilters</a></td>
41 <td>Module function to edit the list of message filters.</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>
42 </tr><tr> 45 </tr><tr>
43 <td><a href="#messageHandler">messageHandler</a></td> 46 <td><a href="#messageHandler">messageHandler</a></td>
44 <td>Module function handling messages.</td> 47 <td>Module function handling messages.</td>
45 </tr><tr> 48 </tr><tr>
46 <td><a href="#messageHandlerInstalled">messageHandlerInstalled</a></td> 49 <td><a href="#messageHandlerInstalled">messageHandlerInstalled</a></td>
70 <table> 73 <table>
71 <tr> 74 <tr>
72 <td><a href="#E5ErrorMessage.__init__">E5ErrorMessage</a></td> 75 <td><a href="#E5ErrorMessage.__init__">E5ErrorMessage</a></td>
73 <td>Constructor</td> 76 <td>Constructor</td>
74 </tr><tr> 77 </tr><tr>
75 <td><a href="#E5ErrorMessage.__filterMessage">__filterMessage</a></td>
76 <td>Private method to filter messages.</td>
77 </tr><tr>
78 <td><a href="#E5ErrorMessage.editMessageFilters">editMessageFilters</a></td> 78 <td><a href="#E5ErrorMessage.editMessageFilters">editMessageFilters</a></td>
79 <td>Public method to edit the list of message filters.</td> 79 <td>Public method to edit the list of message filters.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#E5ErrorMessage.showMessage">showMessage</a></td> 81 <td><a href="#E5ErrorMessage.showMessage">showMessage</a></td>
82 <td>Public method to show a message.</td> 82 <td>Public method to show a message.</td>
90 <h4>E5ErrorMessage (Constructor)</h4> 90 <h4>E5ErrorMessage (Constructor)</h4>
91 <b>E5ErrorMessage</b>(<i>parent=None</i>) 91 <b>E5ErrorMessage</b>(<i>parent=None</i>)
92 <p> 92 <p>
93 Constructor 93 Constructor
94 </p><dl> 94 </p><dl>
95 <dt><i>parent</i></dt> 95 <dt><i>parent</i> (QWidget)</dt>
96 <dd> 96 <dd>
97 reference to the parent widget (QWidget) 97 reference to the parent widget
98 </dd>
99 </dl><a NAME="E5ErrorMessage.__filterMessage" ID="E5ErrorMessage.__filterMessage"></a>
100 <h4>E5ErrorMessage.__filterMessage</h4>
101 <b>__filterMessage</b>(<i>message</i>)
102 <p>
103 Private method to filter messages.
104 </p><dl>
105 <dt><i>message</i></dt>
106 <dd>
107 message to be checked (string)
108 </dd>
109 </dl><dl>
110 <dt>Returns:</dt>
111 <dd>
112 flag indicating that the message should be filtered out
113 (boolean)
114 </dd> 98 </dd>
115 </dl><a NAME="E5ErrorMessage.editMessageFilters" ID="E5ErrorMessage.editMessageFilters"></a> 99 </dl><a NAME="E5ErrorMessage.editMessageFilters" ID="E5ErrorMessage.editMessageFilters"></a>
116 <h4>E5ErrorMessage.editMessageFilters</h4> 100 <h4>E5ErrorMessage.editMessageFilters</h4>
117 <b>editMessageFilters</b>(<i></i>) 101 <b>editMessageFilters</b>(<i></i>)
118 <p> 102 <p>
121 <h4>E5ErrorMessage.showMessage</h4> 105 <h4>E5ErrorMessage.showMessage</h4>
122 <b>showMessage</b>(<i>message, msgType=""</i>) 106 <b>showMessage</b>(<i>message, msgType=""</i>)
123 <p> 107 <p>
124 Public method to show a message. 108 Public method to show a message.
125 </p><dl> 109 </p><dl>
126 <dt><i>message</i></dt> 110 <dt><i>message</i> (str)</dt>
127 <dd> 111 <dd>
128 error message to be shown (string) 112 error message to be shown
129 </dd><dt><i>msgType</i></dt> 113 </dd><dt><i>msgType</i> (str)</dt>
130 <dd> 114 <dd>
131 type of the error message (string) 115 type of the error message
132 </dd> 116 </dd>
133 </dl> 117 </dl>
134 <div align="right"><a href="#top">Up</a></div> 118 <div align="right"><a href="#top">Up</a></div>
135 <hr /><hr /> 119 <hr /><hr />
136 <a NAME="editMessageFilters" ID="editMessageFilters"></a> 120 <a NAME="editMessageFilters" ID="editMessageFilters"></a>
139 <p> 123 <p>
140 Module function to edit the list of message filters. 124 Module function to edit the list of message filters.
141 </p> 125 </p>
142 <div align="right"><a href="#top">Up</a></div> 126 <div align="right"><a href="#top">Up</a></div>
143 <hr /><hr /> 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 />
144 <a NAME="messageHandler" ID="messageHandler"></a> 151 <a NAME="messageHandler" ID="messageHandler"></a>
145 <h2>messageHandler</h2> 152 <h2>messageHandler</h2>
146 <b>messageHandler</b>(<i>msgType, *args</i>) 153 <b>messageHandler</b>(<i>msgType, *args</i>)
147 <p> 154 <p>
148 Module function handling messages. 155 Module function handling messages.
149 </p><dl> 156 </p><dl>
150 <dt><i>msgType</i></dt> 157 <dt><i>msgType</i> (int, QtMsgType)</dt>
151 <dd> 158 <dd>
152 type of the message (integer, QtMsgType) 159 type of the message
153 </dd><dt><i>args</i></dt> 160 </dd><dt><i>args</i> (PyQt4: bytes; PyQt5: tuple of (QMessageLogContext, bytes))</dt>
154 <dd> 161 <dd>
155 message handler arguments, for PyQt4 message to be shown 162 message handler arguments, for PyQt4 message to be shown, for
156 (bytes), for PyQt5 context information (QMessageLogContext) and 163 PyQt5 context information and message to be shown
157 message to be shown (bytes)
158 </dd> 164 </dd>
159 </dl> 165 </dl>
160 <div align="right"><a href="#top">Up</a></div> 166 <div align="right"><a href="#top">Up</a></div>
161 <hr /><hr /> 167 <hr /><hr />
162 <a NAME="messageHandlerInstalled" ID="messageHandlerInstalled"></a> 168 <a NAME="messageHandlerInstalled" ID="messageHandlerInstalled"></a>
165 <p> 171 <p>
166 Module function to check, if a message handler was installed. 172 Module function to check, if a message handler was installed.
167 </p><dl> 173 </p><dl>
168 <dt>Returns:</dt> 174 <dt>Returns:</dt>
169 <dd> 175 <dd>
170 flag indicating an installed message handler (boolean) 176 flag indicating an installed message handler
177 </dd>
178 </dl><dl>
179 <dt>Return Type:</dt>
180 <dd>
181 bool
171 </dd> 182 </dd>
172 </dl> 183 </dl>
173 <div align="right"><a href="#top">Up</a></div> 184 <div align="right"><a href="#top">Up</a></div>
174 <hr /><hr /> 185 <hr /><hr />
175 <a NAME="qtHandler" ID="qtHandler"></a> 186 <a NAME="qtHandler" ID="qtHandler"></a>
179 Module function to install an E5ErrorMessage dialog as the global 190 Module function to install an E5ErrorMessage dialog as the global
180 message handler. 191 message handler.
181 </p><dl> 192 </p><dl>
182 <dt>Returns:</dt> 193 <dt>Returns:</dt>
183 <dd> 194 <dd>
184 reference to the message handler dialog (E5ErrorMessage) 195 reference to the message handler dialog
196 </dd>
197 </dl><dl>
198 <dt>Return Type:</dt>
199 <dd>
200 E5ErrorMessage
185 </dd> 201 </dd>
186 </dl> 202 </dl>
187 <div align="right"><a href="#top">Up</a></div> 203 <div align="right"><a href="#top">Up</a></div>
188 <hr /> 204 <hr />
189 </body></html> 205 </body></html>

eric ide

mercurial