1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" The implementation of a dialog that displays a message. """
# Import the toolkit specific version.
from .toolkit import toolkit_object
MessageDialog = toolkit_object("message_dialog:MessageDialog")
# Convenience functions.
def information(
parent,
message,
title="Information",
detail="",
informative="",
text_format="auto"
):
""" Convenience method to show an information message dialog.
Parameters
----------
parent : toolkit control or None
The toolkit control that should be the parent of the dialog.
message : str
The text of the message to display.
title : str
The text of the dialog title.
detail : str
Further details about the message (displayed when the user clicks
"Show details").
informative : str
Explanatory text to display along with the message.
text_format : str
Specifies what text format to use in the resulting message dialog.
One of "auto", "plain", or "rich". Only supported on the qt backend.
"""
dialog = MessageDialog(
parent=parent,
message=message,
title=title,
severity="information",
detail=detail,
informative=informative,
text_format=text_format,
)
dialog.open()
def warning(
parent,
message,
title="Warning",
detail="",
informative="",
text_format="auto"
):
""" Convenience function to show a warning message dialog.
Parameters
----------
parent : toolkit control or None
The toolkit control that should be the parent of the dialog.
message : str
The text of the message to display.
title : str
The text of the dialog title.
detail : str
Further details about the message (displayed when the user clicks
"Show details").
informative : str
Explanatory text to display along with the message.
text_format : str
Specifies what text format to use in the resulting message dialog.
One of "auto", "plain", or "rich". Only supported on the qt backend.
"""
dialog = MessageDialog(
parent=parent,
message=message,
title=title,
severity="warning",
detail=detail,
informative=informative,
text_format=text_format,
)
dialog.open()
def error(
parent,
message,
title="Error",
detail="",
informative="",
text_format="auto"
):
""" Convenience function to show an error message dialog.
Parameters
----------
parent : toolkit control or None
The toolkit control that should be the parent of the dialog.
message : str
The text of the message to display.
title : str
The text of the dialog title.
detail : str
Further details about the message (displayed when the user clicks
"Show details").
informative : str
Explanatory text to display along with the message.
text_format : str
Specifies what text format to use in the resulting message dialog.
One of "auto", "plain", or "rich". Only supported on the qt backend.
"""
dialog = MessageDialog(
parent=parent,
message=message,
title=title,
severity="error",
detail=detail,
informative=informative,
text_format=text_format,
)
dialog.open()
|