src/eric7/Documentation/Source/eric7.EricWidgets.EricMessageBox.html

branch
eric7
changeset 10423
299802979277
parent 9757
ab6e87f6f1c4
child 10479
856476537696
equal deleted inserted replaced
10422:e28b89693f37 10423:299802979277
104 <p> 104 <p>
105 Constructor 105 Constructor
106 </p> 106 </p>
107 <dl> 107 <dl>
108 108
109 <dt><i>icon</i></dt> 109 <dt><i>icon</i> (QMessageBox.Icon)</dt>
110 <dd> 110 <dd>
111 type of icon to be shown (QMessageBox.Icon) 111 type of icon to be shown
112 </dd> 112 </dd>
113 <dt><i>title</i></dt> 113 <dt><i>title</i> (str)</dt>
114 <dd> 114 <dd>
115 caption of the message box (string) 115 caption of the message box
116 </dd> 116 </dd>
117 <dt><i>text</i></dt> 117 <dt><i>text</i> (str)</dt>
118 <dd> 118 <dd>
119 text to be shown by the message box (string) 119 text to be shown by the message box
120 </dd> 120 </dd>
121 <dt><i>modal</i></dt> 121 <dt><i>modal</i> (bool)</dt>
122 <dd> 122 <dd>
123 flag indicating a modal dialog (boolean) 123 flag indicating a modal dialog
124 </dd> 124 </dd>
125 <dt><i>buttons</i></dt> 125 <dt><i>buttons</i> (StandardButtons)</dt>
126 <dd> 126 <dd>
127 set of standard buttons to generate (StandardButtons) 127 set of standard buttons to generate
128 </dd> 128 </dd>
129 <dt><i>parent</i></dt> 129 <dt><i>parent</i> (QWidget)</dt>
130 <dd> 130 <dd>
131 parent widget of the message box (QWidget) 131 parent widget of the message box
132 </dd> 132 </dd>
133 </dl> 133 </dl>
134 <div align="right"><a href="#top">Up</a></div> 134 <div align="right"><a href="#top">Up</a></div>
135 <hr /> 135 <hr />
136 <hr /> 136 <hr />
141 <p> 141 <p>
142 Private module function to show a modal message box. 142 Private module function to show a modal message box.
143 </p> 143 </p>
144 <dl> 144 <dl>
145 145
146 <dt><i>parent</i></dt> 146 <dt><i>parent</i> (QWidget)</dt>
147 <dd> 147 <dd>
148 parent widget of the message box (QWidget) 148 parent widget of the message box
149 </dd> 149 </dd>
150 <dt><i>title</i></dt> 150 <dt><i>title</i> (str)</dt>
151 <dd> 151 <dd>
152 caption of the message box (string) 152 caption of the message box
153 </dd> 153 </dd>
154 <dt><i>text</i></dt> 154 <dt><i>text</i> (str)</dt>
155 <dd> 155 <dd>
156 text to be shown by the message box (string) 156 text to be shown by the message box
157 </dd> 157 </dd>
158 <dt><i>icon</i></dt> 158 <dt><i>icon</i> (QMessageBox.Icon)</dt>
159 <dd> 159 <dd>
160 type of icon to be shown (QMessageBox.Icon) 160 type of icon to be shown
161 </dd> 161 </dd>
162 <dt><i>buttons</i></dt> 162 <dt><i>buttons</i> (QMessageBox.StandardButtons)</dt>
163 <dd> 163 <dd>
164 flags indicating which buttons to show 164 flags indicating which buttons to show
165 (QMessageBox.StandardButtons) 165 </dd>
166 </dd> 166 <dt><i>defaultButton</i> (QMessageBox.StandardButton)</dt>
167 <dt><i>defaultButton</i></dt>
168 <dd> 167 <dd>
169 flag indicating the default button 168 flag indicating the default button
170 (QMessageBox.StandardButton) 169 </dd>
171 </dd> 170 <dt><i>textFormat</i> (Qt.TextFormat)</dt>
172 <dt><i>textFormat</i></dt> 171 <dd>
173 <dd> 172 format of the text
174 format of the text (Qt.TextFormat) 173 </dd>
175 </dd> 174 </dl>
176 </dl> 175 <dl>
177 <dl> 176 <dt>Return:</dt>
178 <dt>Return:</dt> 177 <dd>
179 <dd> 178 button pressed by the user
180 button pressed by the user (QMessageBox.StandardButton) 179 </dd>
180 </dl>
181 <dl>
182 <dt>Return Type:</dt>
183 <dd>
184 QMessageBox.StandardButton
181 </dd> 185 </dd>
182 </dl> 186 </dl>
183 <div align="right"><a href="#top">Up</a></div> 187 <div align="right"><a href="#top">Up</a></div>
184 <hr /> 188 <hr />
185 <hr /> 189 <hr />
190 <p> 194 <p>
191 Function to show a modal critical message box. 195 Function to show a modal critical message box.
192 </p> 196 </p>
193 <dl> 197 <dl>
194 198
195 <dt><i>parent</i></dt> 199 <dt><i>parent</i> (QWidget)</dt>
196 <dd> 200 <dd>
197 parent widget of the message box (QWidget) 201 parent widget of the message box
198 </dd> 202 </dd>
199 <dt><i>title</i></dt> 203 <dt><i>title</i> (str)</dt>
200 <dd> 204 <dd>
201 caption of the message box (string) 205 caption of the message box
202 </dd> 206 </dd>
203 <dt><i>text</i></dt> 207 <dt><i>text</i> (str)</dt>
204 <dd> 208 <dd>
205 text to be shown by the message box (string) 209 text to be shown by the message box
206 </dd> 210 </dd>
207 <dt><i>buttons</i></dt> 211 <dt><i>buttons</i> (QMessageBox.StandardButtons)</dt>
208 <dd> 212 <dd>
209 flags indicating which buttons to show 213 flags indicating which buttons to show
210 (QMessageBox.StandardButtons) 214 </dd>
211 </dd> 215 <dt><i>defaultButton</i> (QMessageBox.StandardButton)</dt>
212 <dt><i>defaultButton</i></dt>
213 <dd> 216 <dd>
214 flag indicating the default button 217 flag indicating the default button
215 (QMessageBox.StandardButton) 218 </dd>
216 </dd> 219 </dl>
217 </dl> 220 <dl>
218 <dl> 221 <dt>Return:</dt>
219 <dt>Return:</dt> 222 <dd>
220 <dd> 223 button pressed by the user
221 button pressed by the user (QMessageBox.StandardButton) 224 </dd>
225 </dl>
226 <dl>
227 <dt>Return Type:</dt>
228 <dd>
229 QMessageBox.StandardButton
222 </dd> 230 </dd>
223 </dl> 231 </dl>
224 <div align="right"><a href="#top">Up</a></div> 232 <div align="right"><a href="#top">Up</a></div>
225 <hr /> 233 <hr />
226 <hr /> 234 <hr />
231 <p> 239 <p>
232 Function to show a modal information message box. 240 Function to show a modal information message box.
233 </p> 241 </p>
234 <dl> 242 <dl>
235 243
236 <dt><i>parent</i></dt> 244 <dt><i>parent</i> (QWidget)</dt>
237 <dd> 245 <dd>
238 parent widget of the message box (QWidget) 246 parent widget of the message box
239 </dd> 247 </dd>
240 <dt><i>title</i></dt> 248 <dt><i>title</i> (str)</dt>
241 <dd> 249 <dd>
242 caption of the message box (string) 250 caption of the message box
243 </dd> 251 </dd>
244 <dt><i>text</i></dt> 252 <dt><i>text</i> (str)</dt>
245 <dd> 253 <dd>
246 text to be shown by the message box (string) 254 text to be shown by the message box
247 </dd> 255 </dd>
248 <dt><i>buttons</i></dt> 256 <dt><i>buttons</i> (QMessageBox.StandardButtons)</dt>
249 <dd> 257 <dd>
250 flags indicating which buttons to show 258 flags indicating which buttons to show
251 (QMessageBox.StandardButtons) 259 </dd>
252 </dd> 260 <dt><i>defaultButton</i> (QMessageBox.StandardButton)</dt>
253 <dt><i>defaultButton</i></dt>
254 <dd> 261 <dd>
255 flag indicating the default button 262 flag indicating the default button
256 (QMessageBox.StandardButton) 263 </dd>
257 </dd> 264 </dl>
258 </dl> 265 <dl>
259 <dl> 266 <dt>Return:</dt>
260 <dt>Return:</dt> 267 <dd>
261 <dd> 268 button pressed by the user
262 button pressed by the user (QMessageBox.StandardButton) 269 </dd>
270 </dl>
271 <dl>
272 <dt>Return Type:</dt>
273 <dd>
274 QMessageBox.StandardButton
263 </dd> 275 </dd>
264 </dl> 276 </dl>
265 <div align="right"><a href="#top">Up</a></div> 277 <div align="right"><a href="#top">Up</a></div>
266 <hr /> 278 <hr />
267 <hr /> 279 <hr />
272 <p> 284 <p>
273 Function to show a modal message box to ask for clearing the data. 285 Function to show a modal message box to ask for clearing the data.
274 </p> 286 </p>
275 <dl> 287 <dl>
276 288
277 <dt><i>parent</i></dt> 289 <dt><i>parent</i> (QWidget)</dt>
278 <dd> 290 <dd>
279 parent widget of the message box (QWidget) 291 parent widget of the message box
280 </dd> 292 </dd>
281 <dt><i>title</i></dt> 293 <dt><i>title</i> (str)</dt>
282 <dd> 294 <dd>
283 caption of the message box (string) 295 caption of the message box
284 </dd> 296 </dd>
285 <dt><i>text</i></dt> 297 <dt><i>text</i> (str)</dt>
286 <dd> 298 <dd>
287 text to be shown by the message box (string) 299 text to be shown by the message box
288 </dd> 300 </dd>
289 <dt><i>saveFunc</i></dt> 301 <dt><i>saveFunc</i> (function)</dt>
290 <dd> 302 <dd>
291 reference to a function performing the save action. It 303 reference to a function performing the save action. It
292 must be a parameterless function returning a flag indicating success. 304 must be a parameterless function returning a flag indicating success.
293 </dd> 305 </dd>
294 <dt><i>textFormat</i></dt> 306 <dt><i>textFormat</i> (Qt.TextFormat)</dt>
295 <dd> 307 <dd>
296 format of the text (Qt.TextFormat) 308 format of the text
297 </dd> 309 </dd>
298 </dl> 310 </dl>
299 <dl> 311 <dl>
300 <dt>Return:</dt> 312 <dt>Return:</dt>
301 <dd> 313 <dd>
302 flag indicating that it is ok to clear the data (boolean) 314 flag indicating that it is ok to clear the data
315 </dd>
316 </dl>
317 <dl>
318 <dt>Return Type:</dt>
319 <dd>
320 bool
303 </dd> 321 </dd>
304 </dl> 322 </dl>
305 <div align="right"><a href="#top">Up</a></div> 323 <div align="right"><a href="#top">Up</a></div>
306 <hr /> 324 <hr />
307 <hr /> 325 <hr />
312 <p> 330 <p>
313 Function to show a modal question message box. 331 Function to show a modal question message box.
314 </p> 332 </p>
315 <dl> 333 <dl>
316 334
317 <dt><i>parent</i></dt> 335 <dt><i>parent</i> (QWidget)</dt>
318 <dd> 336 <dd>
319 parent widget of the message box (QWidget) 337 parent widget of the message box
320 </dd> 338 </dd>
321 <dt><i>title</i></dt> 339 <dt><i>title</i> (str)</dt>
322 <dd> 340 <dd>
323 caption of the message box (string) 341 caption of the message box
324 </dd> 342 </dd>
325 <dt><i>text</i></dt> 343 <dt><i>text</i> (str)</dt>
326 <dd> 344 <dd>
327 text to be shown by the message box (string) 345 text to be shown by the message box
328 </dd> 346 </dd>
329 <dt><i>buttons</i></dt> 347 <dt><i>buttons</i> (QMessageBox.StandardButtons)</dt>
330 <dd> 348 <dd>
331 flags indicating which buttons to show 349 flags indicating which buttons to show
332 (QMessageBox.StandardButtons) 350 </dd>
333 </dd> 351 <dt><i>defaultButton</i> (QMessageBox.StandardButton)</dt>
334 <dt><i>defaultButton</i></dt>
335 <dd> 352 <dd>
336 flag indicating the default button 353 flag indicating the default button
337 (QMessageBox.StandardButton) 354 </dd>
338 </dd> 355 </dl>
339 </dl> 356 <dl>
340 <dl> 357 <dt>Return:</dt>
341 <dt>Return:</dt> 358 <dd>
342 <dd> 359 button pressed by the user
343 button pressed by the user (QMessageBox.StandardButton) 360 </dd>
361 </dl>
362 <dl>
363 <dt>Return Type:</dt>
364 <dd>
365 QMessageBox.StandardButton
344 </dd> 366 </dd>
345 </dl> 367 </dl>
346 <div align="right"><a href="#top">Up</a></div> 368 <div align="right"><a href="#top">Up</a></div>
347 <hr /> 369 <hr />
348 <hr /> 370 <hr />
353 <p> 375 <p>
354 Function to show a model abort/retry message box. 376 Function to show a model abort/retry message box.
355 </p> 377 </p>
356 <dl> 378 <dl>
357 379
358 <dt><i>parent</i></dt> 380 <dt><i>parent</i> (QWidget)</dt>
359 <dd> 381 <dd>
360 parent widget of the message box (QWidget) 382 parent widget of the message box
361 </dd> 383 </dd>
362 <dt><i>title</i></dt> 384 <dt><i>title</i> (str)</dt>
363 <dd> 385 <dd>
364 caption of the message box (string) 386 caption of the message box
365 </dd> 387 </dd>
366 <dt><i>text</i></dt> 388 <dt><i>text</i> (str)</dt>
367 <dd> 389 <dd>
368 text to be shown by the message box (string) 390 text to be shown by the message box
369 </dd> 391 </dd>
370 <dt><i>icon</i></dt> 392 <dt><i>icon</i> (QMessageBox.Icon)</dt>
371 <dd> 393 <dd>
372 icon for the dialog (Critical, Information, Question or 394 icon for the dialog (Critical, Information, Question or
373 Warning) 395 Warning)
374 </dd> 396 </dd>
375 <dt><i>textFormat</i></dt> 397 <dt><i>textFormat</i> (Qt.TextFormat)</dt>
376 <dd> 398 <dd>
377 format of the text (Qt.TextFormat) 399 format of the text
378 </dd> 400 </dd>
379 </dl> 401 </dl>
380 <dl> 402 <dl>
381 <dt>Return:</dt> 403 <dt>Return:</dt>
382 <dd> 404 <dd>
383 flag indicating the selection of the Retry button (boolean) 405 flag indicating the selection of the Retry button
406 </dd>
407 </dl>
408 <dl>
409 <dt>Return Type:</dt>
410 <dd>
411 bool
384 </dd> 412 </dd>
385 </dl> 413 </dl>
386 <dl> 414 <dl>
387 415
388 <dt>Raises <b>ValueError</b>:</dt> 416 <dt>Raises <b>ValueError</b>:</dt>
400 <p> 428 <p>
401 Function to show a modal warning message box. 429 Function to show a modal warning message box.
402 </p> 430 </p>
403 <dl> 431 <dl>
404 432
405 <dt><i>parent</i></dt> 433 <dt><i>parent</i> (QWidget)</dt>
406 <dd> 434 <dd>
407 parent widget of the message box (QWidget) 435 parent widget of the message box
408 </dd> 436 </dd>
409 <dt><i>title</i></dt> 437 <dt><i>title</i> (str)</dt>
410 <dd> 438 <dd>
411 caption of the message box (string) 439 caption of the message box
412 </dd> 440 </dd>
413 <dt><i>text</i></dt> 441 <dt><i>text</i> (str)</dt>
414 <dd> 442 <dd>
415 text to be shown by the message box (string) 443 text to be shown by the message box
416 </dd> 444 </dd>
417 <dt><i>buttons</i></dt> 445 <dt><i>buttons</i> (QMessageBox.StandardButtons)</dt>
418 <dd> 446 <dd>
419 flags indicating which buttons to show 447 flags indicating which buttons to show
420 (QMessageBox.StandardButtons) 448 </dd>
421 </dd> 449 <dt><i>defaultButton</i> (QMessageBox.StandardButton)</dt>
422 <dt><i>defaultButton</i></dt>
423 <dd> 450 <dd>
424 flag indicating the default button 451 flag indicating the default button
425 (QMessageBox.StandardButton) 452 </dd>
426 </dd> 453 </dl>
427 </dl> 454 <dl>
428 <dl> 455 <dt>Return:</dt>
429 <dt>Return:</dt> 456 <dd>
430 <dd> 457 button pressed by the user
431 button pressed by the user (QMessageBox.StandardButton) 458 </dd>
459 </dl>
460 <dl>
461 <dt>Return Type:</dt>
462 <dd>
463 QMessageBox.StandardButton
432 </dd> 464 </dd>
433 </dl> 465 </dl>
434 <div align="right"><a href="#top">Up</a></div> 466 <div align="right"><a href="#top">Up</a></div>
435 <hr /> 467 <hr />
436 <hr /> 468 <hr />
441 <p> 473 <p>
442 Function to show a model yes/no message box. 474 Function to show a model yes/no message box.
443 </p> 475 </p>
444 <dl> 476 <dl>
445 477
446 <dt><i>parent</i></dt> 478 <dt><i>parent</i> (QWidget)</dt>
447 <dd> 479 <dd>
448 parent widget of the message box (QWidget) 480 parent widget of the message box
449 </dd> 481 </dd>
450 <dt><i>title</i></dt> 482 <dt><i>title</i> (str)</dt>
451 <dd> 483 <dd>
452 caption of the message box (string) 484 caption of the message box
453 </dd> 485 </dd>
454 <dt><i>text</i></dt> 486 <dt><i>text</i> (str)</dt>
455 <dd> 487 <dd>
456 text to be shown by the message box (string) 488 text to be shown by the message box
457 </dd> 489 </dd>
458 <dt><i>icon</i></dt> 490 <dt><i>icon</i> (QMessageBox.Icon)</dt>
459 <dd> 491 <dd>
460 icon for the dialog (Critical, Information, Question or 492 icon for the dialog (Critical, Information, Question or
461 Warning) 493 Warning)
462 </dd> 494 </dd>
463 <dt><i>yesDefault</i></dt> 495 <dt><i>yesDefault</i> (bool)</dt>
464 <dd> 496 <dd>
465 flag indicating that the Yes button should be the 497 flag indicating that the Yes button should be the
466 default button (boolean) 498 default button
467 </dd> 499 </dd>
468 <dt><i>textFormat</i></dt> 500 <dt><i>textFormat</i> (Qt.TextFormat)</dt>
469 <dd> 501 <dd>
470 format of the text (Qt.TextFormat) 502 format of the text
471 </dd> 503 </dd>
472 </dl> 504 </dl>
473 <dl> 505 <dl>
474 <dt>Return:</dt> 506 <dt>Return:</dt>
475 <dd> 507 <dd>
476 flag indicating the selection of the Yes button (boolean) 508 flag indicating the selection of the Yes button
509 </dd>
510 </dl>
511 <dl>
512 <dt>Return Type:</dt>
513 <dd>
514 bool
477 </dd> 515 </dd>
478 </dl> 516 </dl>
479 <dl> 517 <dl>
480 518
481 <dt>Raises <b>ValueError</b>:</dt> 519 <dt>Raises <b>ValueError</b>:</dt>

eric ide

mercurial