|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.EricWidgets.EricErrorMessage</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> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.EricWidgets.EricErrorMessage</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a specialized error message dialog. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>_defaultFilters</td></tr><tr><td>_filterSettings</td></tr><tr><td>_msgHandlerDialog</td></tr><tr><td>_origMsgHandler</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#EricErrorMessage">EricErrorMessage</a></td> |
|
39 <td>Class implementing a specialized error message dialog.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 |
|
46 <tr> |
|
47 <td><a href="#editMessageFilters">editMessageFilters</a></td> |
|
48 <td>Module function to edit the list of message filters.</td> |
|
49 </tr> |
|
50 <tr> |
|
51 <td><a href="#filterMessage">filterMessage</a></td> |
|
52 <td>Module function to filter messages.</td> |
|
53 </tr> |
|
54 <tr> |
|
55 <td><a href="#messageHandler">messageHandler</a></td> |
|
56 <td>Module function handling messages.</td> |
|
57 </tr> |
|
58 <tr> |
|
59 <td><a href="#messageHandlerInstalled">messageHandlerInstalled</a></td> |
|
60 <td>Module function to check, if a message handler was installed.</td> |
|
61 </tr> |
|
62 <tr> |
|
63 <td><a href="#qtHandler">qtHandler</a></td> |
|
64 <td>Module function to install an EricErrorMessage dialog as the global message handler.</td> |
|
65 </tr> |
|
66 </table> |
|
67 <hr /> |
|
68 <hr /> |
|
69 <a NAME="EricErrorMessage" ID="EricErrorMessage"></a> |
|
70 <h2>EricErrorMessage</h2> |
|
71 |
|
72 <p> |
|
73 Class implementing a specialized error message dialog. |
|
74 </p> |
|
75 <h3>Derived from</h3> |
|
76 QErrorMessage |
|
77 <h3>Class Attributes</h3> |
|
78 |
|
79 <table> |
|
80 <tr><td>None</td></tr> |
|
81 </table> |
|
82 <h3>Class Methods</h3> |
|
83 |
|
84 <table> |
|
85 <tr><td>None</td></tr> |
|
86 </table> |
|
87 <h3>Methods</h3> |
|
88 |
|
89 <table> |
|
90 |
|
91 <tr> |
|
92 <td><a href="#EricErrorMessage.__init__">EricErrorMessage</a></td> |
|
93 <td>Constructor</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#EricErrorMessage.editMessageFilters">editMessageFilters</a></td> |
|
97 <td>Public method to edit the list of message filters.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#EricErrorMessage.showMessage">showMessage</a></td> |
|
101 <td>Public method to show a message.</td> |
|
102 </tr> |
|
103 </table> |
|
104 <h3>Static Methods</h3> |
|
105 |
|
106 <table> |
|
107 <tr><td>None</td></tr> |
|
108 </table> |
|
109 |
|
110 <a NAME="EricErrorMessage.__init__" ID="EricErrorMessage.__init__"></a> |
|
111 <h4>EricErrorMessage (Constructor)</h4> |
|
112 <b>EricErrorMessage</b>(<i>parent=None</i>) |
|
113 |
|
114 <p> |
|
115 Constructor |
|
116 </p> |
|
117 <dl> |
|
118 |
|
119 <dt><i>parent</i> (QWidget)</dt> |
|
120 <dd> |
|
121 reference to the parent widget |
|
122 </dd> |
|
123 </dl> |
|
124 <a NAME="EricErrorMessage.editMessageFilters" ID="EricErrorMessage.editMessageFilters"></a> |
|
125 <h4>EricErrorMessage.editMessageFilters</h4> |
|
126 <b>editMessageFilters</b>(<i></i>) |
|
127 |
|
128 <p> |
|
129 Public method to edit the list of message filters. |
|
130 </p> |
|
131 <a NAME="EricErrorMessage.showMessage" ID="EricErrorMessage.showMessage"></a> |
|
132 <h4>EricErrorMessage.showMessage</h4> |
|
133 <b>showMessage</b>(<i>message, msgType=""</i>) |
|
134 |
|
135 <p> |
|
136 Public method to show a message. |
|
137 </p> |
|
138 <dl> |
|
139 |
|
140 <dt><i>message</i> (str)</dt> |
|
141 <dd> |
|
142 error message to be shown |
|
143 </dd> |
|
144 <dt><i>msgType</i> (str)</dt> |
|
145 <dd> |
|
146 type of the error message |
|
147 </dd> |
|
148 </dl> |
|
149 <div align="right"><a href="#top">Up</a></div> |
|
150 <hr /> |
|
151 <hr /> |
|
152 <a NAME="editMessageFilters" ID="editMessageFilters"></a> |
|
153 <h2>editMessageFilters</h2> |
|
154 <b>editMessageFilters</b>(<i></i>) |
|
155 |
|
156 <p> |
|
157 Module function to edit the list of message filters. |
|
158 </p> |
|
159 <div align="right"><a href="#top">Up</a></div> |
|
160 <hr /> |
|
161 <hr /> |
|
162 <a NAME="filterMessage" ID="filterMessage"></a> |
|
163 <h2>filterMessage</h2> |
|
164 <b>filterMessage</b>(<i>message</i>) |
|
165 |
|
166 <p> |
|
167 Module function to filter messages. |
|
168 </p> |
|
169 <dl> |
|
170 |
|
171 <dt><i>message</i> (str)</dt> |
|
172 <dd> |
|
173 message to be checked |
|
174 </dd> |
|
175 </dl> |
|
176 <dl> |
|
177 <dt>Return:</dt> |
|
178 <dd> |
|
179 flag indicating that the message should be filtered out |
|
180 </dd> |
|
181 </dl> |
|
182 <dl> |
|
183 <dt>Return Type:</dt> |
|
184 <dd> |
|
185 bool |
|
186 </dd> |
|
187 </dl> |
|
188 <div align="right"><a href="#top">Up</a></div> |
|
189 <hr /> |
|
190 <hr /> |
|
191 <a NAME="messageHandler" ID="messageHandler"></a> |
|
192 <h2>messageHandler</h2> |
|
193 <b>messageHandler</b>(<i>msgType, context, message</i>) |
|
194 |
|
195 <p> |
|
196 Module function handling messages. |
|
197 </p> |
|
198 <dl> |
|
199 |
|
200 <dt><i>msgType</i> (int, QtMsgType)</dt> |
|
201 <dd> |
|
202 type of the message |
|
203 </dd> |
|
204 <dt><i>context</i> (QMessageLogContext)</dt> |
|
205 <dd> |
|
206 context information |
|
207 </dd> |
|
208 <dt><i>message</i> (bytes)</dt> |
|
209 <dd> |
|
210 message to be shown |
|
211 </dd> |
|
212 </dl> |
|
213 <div align="right"><a href="#top">Up</a></div> |
|
214 <hr /> |
|
215 <hr /> |
|
216 <a NAME="messageHandlerInstalled" ID="messageHandlerInstalled"></a> |
|
217 <h2>messageHandlerInstalled</h2> |
|
218 <b>messageHandlerInstalled</b>(<i></i>) |
|
219 |
|
220 <p> |
|
221 Module function to check, if a message handler was installed. |
|
222 </p> |
|
223 <dl> |
|
224 <dt>Return:</dt> |
|
225 <dd> |
|
226 flag indicating an installed message handler |
|
227 </dd> |
|
228 </dl> |
|
229 <dl> |
|
230 <dt>Return Type:</dt> |
|
231 <dd> |
|
232 bool |
|
233 </dd> |
|
234 </dl> |
|
235 <div align="right"><a href="#top">Up</a></div> |
|
236 <hr /> |
|
237 <hr /> |
|
238 <a NAME="qtHandler" ID="qtHandler"></a> |
|
239 <h2>qtHandler</h2> |
|
240 <b>qtHandler</b>(<i></i>) |
|
241 |
|
242 <p> |
|
243 Module function to install an EricErrorMessage dialog as the global |
|
244 message handler. |
|
245 </p> |
|
246 <dl> |
|
247 <dt>Return:</dt> |
|
248 <dd> |
|
249 reference to the message handler dialog |
|
250 </dd> |
|
251 </dl> |
|
252 <dl> |
|
253 <dt>Return Type:</dt> |
|
254 <dd> |
|
255 EricErrorMessage |
|
256 </dd> |
|
257 </dl> |
|
258 <div align="right"><a href="#top">Up</a></div> |
|
259 <hr /> |
|
260 </body></html> |