|
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>__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="#messageHandler">messageHandler</a></td> |
|
44 <td>Module function handling messages.</td> |
|
45 </tr><tr> |
|
46 <td><a href="#messageHandlerInstalled">messageHandlerInstalled</a></td> |
|
47 <td>Module function to check, if a message handler was installed.</td> |
|
48 </tr><tr> |
|
49 <td><a href="#qtHandler">qtHandler</a></td> |
|
50 <td>Module function to install an E5ErrorMessage dialog as the global message handler.</td> |
|
51 </tr> |
|
52 </table> |
|
53 <hr /><hr /> |
|
54 <a NAME="E5ErrorMessage" ID="E5ErrorMessage"></a> |
|
55 <h2>E5ErrorMessage</h2> |
|
56 <p> |
|
57 Class implementing a specialized error message dialog. |
|
58 </p> |
|
59 <h3>Derived from</h3> |
|
60 QErrorMessage |
|
61 <h3>Class Attributes</h3> |
|
62 <table> |
|
63 <tr><td>None</td></tr> |
|
64 </table> |
|
65 <h3>Class Methods</h3> |
|
66 <table> |
|
67 <tr><td>None</td></tr> |
|
68 </table> |
|
69 <h3>Methods</h3> |
|
70 <table> |
|
71 <tr> |
|
72 <td><a href="#E5ErrorMessage.__init__">E5ErrorMessage</a></td> |
|
73 <td>Constructor</td> |
|
74 </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> |
|
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></dt> |
|
96 <dd> |
|
97 reference to the parent widget (QWidget) |
|
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> |
|
115 </dl><a NAME="E5ErrorMessage.editMessageFilters" ID="E5ErrorMessage.editMessageFilters"></a> |
|
116 <h4>E5ErrorMessage.editMessageFilters</h4> |
|
117 <b>editMessageFilters</b>(<i></i>) |
|
118 <p> |
|
119 Public method to edit the list of message filters. |
|
120 </p><a NAME="E5ErrorMessage.showMessage" ID="E5ErrorMessage.showMessage"></a> |
|
121 <h4>E5ErrorMessage.showMessage</h4> |
|
122 <b>showMessage</b>(<i>message, msgType=""</i>) |
|
123 <p> |
|
124 Public method to show a message. |
|
125 </p><dl> |
|
126 <dt><i>message</i></dt> |
|
127 <dd> |
|
128 error message to be shown (string) |
|
129 </dd><dt><i>msgType</i></dt> |
|
130 <dd> |
|
131 type of the error message (string) |
|
132 </dd> |
|
133 </dl> |
|
134 <div align="right"><a href="#top">Up</a></div> |
|
135 <hr /><hr /> |
|
136 <a NAME="editMessageFilters" ID="editMessageFilters"></a> |
|
137 <h2>editMessageFilters</h2> |
|
138 <b>editMessageFilters</b>(<i></i>) |
|
139 <p> |
|
140 Module function to edit the list of message filters. |
|
141 </p> |
|
142 <div align="right"><a href="#top">Up</a></div> |
|
143 <hr /><hr /> |
|
144 <a NAME="messageHandler" ID="messageHandler"></a> |
|
145 <h2>messageHandler</h2> |
|
146 <b>messageHandler</b>(<i>msgType, context, message</i>) |
|
147 <p> |
|
148 Module function handling messages. |
|
149 </p><dl> |
|
150 <dt><i>msgType</i></dt> |
|
151 <dd> |
|
152 type of the message (integer, QtMsgType) |
|
153 </dd><dt><i>message</i></dt> |
|
154 <dd> |
|
155 message to be shown (bytes) |
|
156 </dd> |
|
157 </dl> |
|
158 <div align="right"><a href="#top">Up</a></div> |
|
159 <hr /><hr /> |
|
160 <a NAME="messageHandlerInstalled" ID="messageHandlerInstalled"></a> |
|
161 <h2>messageHandlerInstalled</h2> |
|
162 <b>messageHandlerInstalled</b>(<i></i>) |
|
163 <p> |
|
164 Module function to check, if a message handler was installed. |
|
165 </p><dl> |
|
166 <dt>Returns:</dt> |
|
167 <dd> |
|
168 flag indicating an installed message handler (boolean) |
|
169 </dd> |
|
170 </dl> |
|
171 <div align="right"><a href="#top">Up</a></div> |
|
172 <hr /><hr /> |
|
173 <a NAME="qtHandler" ID="qtHandler"></a> |
|
174 <h2>qtHandler</h2> |
|
175 <b>qtHandler</b>(<i></i>) |
|
176 <p> |
|
177 Module function to install an E5ErrorMessage dialog as the global |
|
178 message handler. |
|
179 </p><dl> |
|
180 <dt>Returns:</dt> |
|
181 <dd> |
|
182 reference to the message handler dialog (E5ErrorMessage) |
|
183 </dd> |
|
184 </dl> |
|
185 <div align="right"><a href="#top">Up</a></div> |
|
186 <hr /> |
|
187 </body></html> |