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