eric6.E5Gui.E5MessageBox

Module implementing QMessageBox replacements and more convenience function.

Global Attributes

Abort

AcceptRole

ActionRole

Apply

ApplyRole

Cancel

Critical

DestructiveRole

Discard

Help

HelpRole

Ignore

Information

InvalidRole

NoButton

NoIcon

NoRole

NoToAll

Open

Question

RejectRole

Reset

ResetRole

RestoreDefaults

Retry

Save

SaveAll

StandardButtons

Warning

Yes

YesRole

YesToAll

about

aboutQt

Classes

E5MessageBox

Class implementing a replacement for QMessageBox.

Functions

__messageBox	Private module function to show a modal message box.
critical	Function to show a modal critical message box.
information	Function to show a modal information message box.
okToClearData	Function to show a model message box to ask for clearing the data.
question	Function to show a modal question message box.
retryAbort	Function to show a model abort/retry message box.
warning	Function to show a modal warning message box.
yesNo	Function to show a model yes/no message box.

E5MessageBox

Class implementing a replacement for QMessageBox.

Derived from

QMessageBox

Class Attributes

None

Class Methods

None

Methods

E5MessageBox

Constructor

Static Methods

None

E5MessageBox (Constructor)

E5MessageBox(icon, title, text, modal=False, buttons=QMessageBox.NoButton, parent=None)

Constructor

icon: type of icon to be shown (QMessageBox.Icon)
title: caption of the message box (string)
text: text to be shown by the message box (string)
modal=: flag indicating a modal dialog (boolean)
buttons=: set of standard buttons to generate (StandardButtons)
parent=: parent widget of the message box (QWidget)

__messageBox

__messageBox(parent, title, text, icon, buttons=QMessageBox.Ok, defaultButton=QMessageBox.NoButton, textFormat=Qt.AutoText)

Private module function to show a modal message box.

parent: parent widget of the message box (QWidget)
title: caption of the message box (string)
text: text to be shown by the message box (string)
icon: type of icon to be shown (QMessageBox.Icon)
buttons: flags indicating which buttons to show (QMessageBox.StandardButtons)
defaultButton: flag indicating the default button (QMessageBox.StandardButton)
textFormat: format of the text (Qt.TextFormat)

Returns:: button pressed by the user (QMessageBox.StandardButton)

critical

critical(parent, title, text, buttons=QMessageBox.Ok, defaultButton=QMessageBox.NoButton)

Function to show a modal critical message box.

parent: parent widget of the message box (QWidget)
title: caption of the message box (string)
text: text to be shown by the message box (string)
buttons: flags indicating which buttons to show (QMessageBox.StandardButtons)
defaultButton: flag indicating the default button (QMessageBox.StandardButton)

Returns:: button pressed by the user (QMessageBox.StandardButton)

information

information(parent, title, text, buttons=QMessageBox.Ok, defaultButton=QMessageBox.NoButton)

Function to show a modal information message box.

parent: parent widget of the message box (QWidget)
title: caption of the message box (string)
text: text to be shown by the message box (string)
buttons: flags indicating which buttons to show (QMessageBox.StandardButtons)
defaultButton: flag indicating the default button (QMessageBox.StandardButton)

Returns:: button pressed by the user (QMessageBox.StandardButton)

okToClearData

okToClearData(parent, title, text, saveFunc, textFormat=Qt.AutoText)

Function to show a model message box to ask for clearing the data.

parent: parent widget of the message box (QWidget)
title: caption of the message box (string)
text: text to be shown by the message box (string)
saveFunc: reference to a function performing the save action. It must be a parameterless function returning a flag indicating success.
textFormat: format of the text (Qt.TextFormat)

Returns:: flag indicating that it is ok to clear the data (boolean)

question

question(parent, title, text, buttons=QMessageBox.Ok, defaultButton=QMessageBox.NoButton)

Function to show a modal question message box.

parent: parent widget of the message box (QWidget)
title: caption of the message box (string)
text: text to be shown by the message box (string)
buttons: flags indicating which buttons to show (QMessageBox.StandardButtons)
defaultButton: flag indicating the default button (QMessageBox.StandardButton)

Returns:: button pressed by the user (QMessageBox.StandardButton)

retryAbort

retryAbort(parent, title, text, icon=Question, textFormat=Qt.AutoText)

Function to show a model abort/retry message box.

parent: parent widget of the message box (QWidget)
title: caption of the message box (string)
text: text to be shown by the message box (string)
icon=: icon for the dialog (Critical, Information, Question or Warning)
textFormat: format of the text (Qt.TextFormat)

Returns:: flag indicating the selection of the Retry button (boolean)

Raises ValueError:: raised to indicate a bad parameter value

warning

warning(parent, title, text, buttons=QMessageBox.Ok, defaultButton=QMessageBox.NoButton)

Function to show a modal warning message box.

parent: parent widget of the message box (QWidget)
title: caption of the message box (string)
text: text to be shown by the message box (string)
buttons: flags indicating which buttons to show (QMessageBox.StandardButtons)
defaultButton: flag indicating the default button (QMessageBox.StandardButton)

Returns:: button pressed by the user (QMessageBox.StandardButton)

yesNo

yesNo(parent, title, text, icon=Question, yesDefault=False, textFormat=Qt.AutoText)

Function to show a model yes/no message box.

parent: parent widget of the message box (QWidget)
title: caption of the message box (string)
text: text to be shown by the message box (string)
icon=: icon for the dialog (Critical, Information, Question or Warning)
yesDefault=: flag indicating that the Yes button should be the default button (boolean)
textFormat: format of the text (Qt.TextFormat)

Returns:: flag indicating the selection of the Yes button (boolean)

Raises ValueError:: raised to indicate a bad parameter value

Home ⌂Doc Index ◂Up ▴