Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Gtk.Objects.MessageDialog
Contents
Description
MessageDialog
presents a dialog with some message text. It’s simply a
convenience widget; you could construct the equivalent of MessageDialog
from Dialog
without too much effort, but MessageDialog
saves typing.
One difference from Dialog
is that MessageDialog
sets the
Window
:skip-taskbar-hint
property to True
, so that the dialog is hidden
from the taskbar by default.
The easiest way to do a modal message dialog is to use dialogRun
, though
you can also pass in the DialogFlagsModal
flag, dialogRun
automatically
makes the dialog modal and waits for the user to respond to it. dialogRun
returns when any dialog button is clicked.
An example for using a modal dialog:
C code
GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT; dialog = gtk_message_dialog_new (parent_window, flags, GTK_MESSAGE_ERROR, GTK_BUTTONS_CLOSE, "Error reading “%s”: %s", filename, g_strerror (errno)); gtk_dialog_run (GTK_DIALOG (dialog)); gtk_widget_destroy (dialog);
You might do a non-modal MessageDialog
as follows:
An example for a non-modal dialog:
C code
GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT; dialog = gtk_message_dialog_new (parent_window, flags, GTK_MESSAGE_ERROR, GTK_BUTTONS_CLOSE, "Error reading “%s”: %s", filename, g_strerror (errno)); // Destroy the dialog when the user responds to it // (e.g. clicks a button) g_signal_connect_swapped (dialog, "response", G_CALLBACK (gtk_widget_destroy), dialog);
GtkMessageDialog as GtkBuildable
The GtkMessageDialog implementation of the GtkBuildable interface exposes the message area as an internal child with the name “message_area”.
- newtype MessageDialog = MessageDialog (ManagedPtr MessageDialog)
- class GObject o => IsMessageDialog o
- toMessageDialog :: (MonadIO m, IsMessageDialog o) => o -> m MessageDialog
- noMessageDialog :: Maybe MessageDialog
- messageDialogGetImage :: (HasCallStack, MonadIO m, IsMessageDialog a) => a -> m Widget
- messageDialogGetMessageArea :: (HasCallStack, MonadIO m, IsMessageDialog a) => a -> m Widget
- messageDialogSetImage :: (HasCallStack, MonadIO m, IsMessageDialog a, IsWidget b) => a -> b -> m ()
- messageDialogSetMarkup :: (HasCallStack, MonadIO m, IsMessageDialog a) => a -> Text -> m ()
- constructMessageDialogButtons :: IsMessageDialog o => ButtonsType -> IO (GValueConstruct o)
- constructMessageDialogImage :: (IsMessageDialog o, IsWidget a) => a -> IO (GValueConstruct o)
- getMessageDialogImage :: (MonadIO m, IsMessageDialog o) => o -> m Widget
- setMessageDialogImage :: (MonadIO m, IsMessageDialog o, IsWidget a) => o -> a -> m ()
- getMessageDialogMessageArea :: (MonadIO m, IsMessageDialog o) => o -> m Widget
- constructMessageDialogMessageType :: IsMessageDialog o => MessageType -> IO (GValueConstruct o)
- getMessageDialogMessageType :: (MonadIO m, IsMessageDialog o) => o -> m MessageType
- setMessageDialogMessageType :: (MonadIO m, IsMessageDialog o) => o -> MessageType -> m ()
- clearMessageDialogSecondaryText :: (MonadIO m, IsMessageDialog o) => o -> m ()
- constructMessageDialogSecondaryText :: IsMessageDialog o => Text -> IO (GValueConstruct o)
- getMessageDialogSecondaryText :: (MonadIO m, IsMessageDialog o) => o -> m (Maybe Text)
- setMessageDialogSecondaryText :: (MonadIO m, IsMessageDialog o) => o -> Text -> m ()
- constructMessageDialogSecondaryUseMarkup :: IsMessageDialog o => Bool -> IO (GValueConstruct o)
- getMessageDialogSecondaryUseMarkup :: (MonadIO m, IsMessageDialog o) => o -> m Bool
- setMessageDialogSecondaryUseMarkup :: (MonadIO m, IsMessageDialog o) => o -> Bool -> m ()
- clearMessageDialogText :: (MonadIO m, IsMessageDialog o) => o -> m ()
- constructMessageDialogText :: IsMessageDialog o => Text -> IO (GValueConstruct o)
- getMessageDialogText :: (MonadIO m, IsMessageDialog o) => o -> m (Maybe Text)
- setMessageDialogText :: (MonadIO m, IsMessageDialog o) => o -> Text -> m ()
- constructMessageDialogUseMarkup :: IsMessageDialog o => Bool -> IO (GValueConstruct o)
- getMessageDialogUseMarkup :: (MonadIO m, IsMessageDialog o) => o -> m Bool
- setMessageDialogUseMarkup :: (MonadIO m, IsMessageDialog o) => o -> Bool -> m ()
Exported types
newtype MessageDialog Source #
Constructors
MessageDialog (ManagedPtr MessageDialog) |
Instances
class GObject o => IsMessageDialog o Source #
Instances
toMessageDialog :: (MonadIO m, IsMessageDialog o) => o -> m MessageDialog Source #
Methods
getImage
messageDialogGetImage Source #
Arguments
:: (HasCallStack, MonadIO m, IsMessageDialog a) | |
=> a |
|
-> m Widget | Returns: the dialog’s image |
Deprecated: (Since version 3.12)Use Dialog
for dialogs with images
Gets the dialog’s image.
Since: 2.14
getMessageArea
messageDialogGetMessageArea Source #
Arguments
:: (HasCallStack, MonadIO m, IsMessageDialog a) | |
=> a |
|
-> m Widget | Returns: A |
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.
See dialogGetContentArea
for the corresponding
function in the parent Dialog
.
Since: 2.22
setImage
messageDialogSetImage Source #
Arguments
:: (HasCallStack, MonadIO m, IsMessageDialog a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Deprecated: (Since version 3.12)Use Dialog
to create dialogs with images
Sets the dialog’s image to image
.
Since: 2.10
setMarkup
messageDialogSetMarkup Source #
Arguments
:: (HasCallStack, MonadIO m, IsMessageDialog a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the text of the message dialog to be str
, which is marked
up with the [Pango text markup language][PangoMarkupFormat].
Since: 2.4
Properties
buttons
constructMessageDialogButtons :: IsMessageDialog o => ButtonsType -> IO (GValueConstruct o) Source #
image
constructMessageDialogImage :: (IsMessageDialog o, IsWidget a) => a -> IO (GValueConstruct o) Source #
getMessageDialogImage :: (MonadIO m, IsMessageDialog o) => o -> m Widget Source #
setMessageDialogImage :: (MonadIO m, IsMessageDialog o, IsWidget a) => o -> a -> m () Source #
messageArea
getMessageDialogMessageArea :: (MonadIO m, IsMessageDialog o) => o -> m Widget Source #
messageType
constructMessageDialogMessageType :: IsMessageDialog o => MessageType -> IO (GValueConstruct o) Source #
getMessageDialogMessageType :: (MonadIO m, IsMessageDialog o) => o -> m MessageType Source #
setMessageDialogMessageType :: (MonadIO m, IsMessageDialog o) => o -> MessageType -> m () Source #
secondaryText
clearMessageDialogSecondaryText :: (MonadIO m, IsMessageDialog o) => o -> m () Source #
constructMessageDialogSecondaryText :: IsMessageDialog o => Text -> IO (GValueConstruct o) Source #
getMessageDialogSecondaryText :: (MonadIO m, IsMessageDialog o) => o -> m (Maybe Text) Source #
setMessageDialogSecondaryText :: (MonadIO m, IsMessageDialog o) => o -> Text -> m () Source #
secondaryUseMarkup
constructMessageDialogSecondaryUseMarkup :: IsMessageDialog o => Bool -> IO (GValueConstruct o) Source #
getMessageDialogSecondaryUseMarkup :: (MonadIO m, IsMessageDialog o) => o -> m Bool Source #
setMessageDialogSecondaryUseMarkup :: (MonadIO m, IsMessageDialog o) => o -> Bool -> m () Source #
text
clearMessageDialogText :: (MonadIO m, IsMessageDialog o) => o -> m () Source #
constructMessageDialogText :: IsMessageDialog o => Text -> IO (GValueConstruct o) Source #
getMessageDialogText :: (MonadIO m, IsMessageDialog o) => o -> m (Maybe Text) Source #
setMessageDialogText :: (MonadIO m, IsMessageDialog o) => o -> Text -> m () Source #
useMarkup
constructMessageDialogUseMarkup :: IsMessageDialog o => Bool -> IO (GValueConstruct o) Source #
getMessageDialogUseMarkup :: (MonadIO m, IsMessageDialog o) => o -> m Bool Source #
setMessageDialogUseMarkup :: (MonadIO m, IsMessageDialog o) => o -> Bool -> m () Source #