gtk.MessageDialog — a convenient message window
class gtk.MessageDialog(gtk.Dialog): |
+--gobject.GObject +-- gtk.Object +-- gtk.Widget +-- gtk.Container +-- gtk.Bin +-- gtk.Window +-- gtk.Dialog +-- gtk.MessageDialog
|
|
The gtk.MessageDialog
presents a dialog with an image representing the type of message (Error,
Question, etc.) alongside some message text. It's simply a convenience
widget; you could construct the equivalent of gtk.MessageDialog
from gtk.Dialog
without
too much effort, but gtk.MessageDialog
saves time.
The gtk.MessageDialog
types are listed in the GTK Message Type Constants.
A selection of predefined button sets is available for use in a message dialog. See the GTK Buttons Type Constants.
See the gtk.Dialog
reference
page for additional methods to be used with the gtk.MessageDialog
.
gtk.MessageDialog(parent
=None, flags
=0, type
=gtk.MESSAGE_INFO, buttons
=gtk.BUTTONS_NONE, message_format
=None)
| the transient parent, or None if none |
| the dialog flags - a combination of:
gtk.DIALOG_MODAL ,
gtk.DIALOG_DESTROY_WITH_PARENT or 0 for no
flags |
| the type of message:
gtk.MESSAGE_INFO , gtk.MESSAGE_WARNING ,
gtk.MESSAGE_QUESTION or
gtk.MESSAGE_ERROR . |
| the predefined set of buttons to use:
gtk.BUTTONS_NONE , gtk.BUTTONS_OK ,
gtk.BUTTONS_CLOSE , gtk.BUTTONS_CANCEL ,
gtk.BUTTONS_YES_NO ,
gtk.BUTTONS_OK_CANCEL |
| a string containing the message text or None |
Returns : | a new gtk.MessageDialog
widget |
Creates a new gtk.MessageDialog
,
which is a simple dialog with an icon indicating the dialog type (error,
warning, etc.) specified by type
and some text
(message_format
) the user may want to see.
parent
if specified indicates the transient parent of
the dialog. The flags
allow the specification special
dialog characteristics: make the dialog modal
(gtk.DIALOG_MODAL
) and destroy the dialog when the parent is
destroyed (gtk.DIALOG_DESTROY_WITH_PARENT
). When the user
clicks a button a "response" signal is emitted with response IDs.
buttons
specifies the set of predefined buttons to
use: gtk.BUTTONS_NONE
, gtk.BUTTONS_OK
,
gtk.BUTTONS_CLOSE
, gtk.BUTTONS_CANCEL
,
gtk.BUTTONS_YES_NO
,
gtk.BUTTONS_OK_CANCEL
. See gtk.Dialog
for more
details.
def set_markup(str
)
| a markup string (see the Pango markup language reference) |
This method is available in PyGTK 2.4 and above.
The set_markup
() method sets the text
of the message dialog to the contents of str
. If
str
contains text marked up with Pango markup (see
The Pango Markup Language), it will be displayed with
those attributes. Note the '<', '>' and '&' characters must be
replaced with '<', '>' and '&' respectively to be
displayed literally.
def format_secondary_text(message_format
)
| The text to be displayed as the secondary text
or None . |
This method is available in PyGTK 2.6 and above.
The format_secondary_text
() method sets
the secondary text of the message dialog to the text specified by
message_format
. Note that setting a secondary text
makes the primary text bold, unless you have provided explicit
markup.
def format_secondary_markup(message_format
)
| A string containing the pango markup to use as secondary text. |
This method is available in PyGTK 2.6 and above.
The format_secondary_markup
() method
sets the secondary text to the markup text specified by
message_format
. Note that setting a secondary text
makes the primary text become bold, unless you have provided explicit
markup.
def set_image(image
)
| the image widget |
This method is available in PyGTK 2.10 and above.
The set_image
() method sets the
dialog's image to the gtk.Widget
specified by image
.
def get_image()
Returns : | the dialog's image. |
This method is available in PyGTK 2.14 and above.
The get_image
() method gets the dialog's image.
def get_message_area()
Returns : | A gtk.VBox corresponding to the "message area" in the message_dialog. |
This method is available in PyGTK 2.22 and above.
The get_message_area
() method returns the message area of the dialog.
This is the box where the dialog's primary and secondary labels are packed. You can add your own
extra content to that box and it will appear below those labels, on the right side of the dialog's
image (or on the left for right-to-left languages). See
get_content_area
for the corresponding function in the parent
gtk.Dialog
.