Portability | portable (depends on GHC) |
---|---|
Stability | provisional |
Maintainer | gtk2hs-users@lists.sourceforge.net |
Safe Haskell | None |
A convenient message window
- data MessageDialog
- class DialogClass o => MessageDialogClass o
- castToMessageDialog :: GObjectClass obj => obj -> MessageDialog
- gTypeMessageDialog :: GType
- toMessageDialog :: MessageDialogClass o => o -> MessageDialog
- data MessageType
- data ButtonsType
- data DialogFlags
- messageDialogNew :: Maybe Window -> [DialogFlags] -> MessageType -> ButtonsType -> String -> IO MessageDialog
- messageDialogNewWithMarkup :: Maybe Window -> [DialogFlags] -> MessageType -> ButtonsType -> Markup -> IO MessageDialog
- messageDialogSetMarkup :: MessageDialogClass self => self -> Markup -> IO ()
- messageDialogSetImage :: (MessageDialogClass self, WidgetClass image) => self -> image -> IO ()
- messageDialogSetSecondaryMarkup :: MessageDialogClass self => self -> String -> IO ()
- messageDialogSetSecondaryText :: MessageDialogClass self => self -> String -> IO ()
- messageDialogMessageType :: MessageDialogClass self => Attr self MessageType
- messageDialogText :: MessageDialogClass self => Attr self (Maybe String)
- messageDialogUseMarkup :: MessageDialogClass self => Attr self Bool
- messageDialogSecondaryText :: MessageDialogClass self => Attr self (Maybe String)
- messageDialogSecondaryUseMarkup :: MessageDialogClass self => Attr self Bool
- messageDialogImage :: (MessageDialogClass self, WidgetClass widget) => ReadWriteAttr self Widget widget
- messageDialogButtons :: MessageDialogClass self => WriteAttr self ButtonsType
- messageDialogMessageArea :: MessageDialogClass self => ReadAttr self VBox
Detail
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 MessageDialog
from Dialog
without too much effort, but MessageDialog
saves typing.
The easiest way to do a modal message dialog is to use dialogRun
,
though you can also pass in the DialogModal
flag, dialogRun
automatically makes the dialog modal and waits for the user to respond to
it. dialogRun
returns when any dialog button is clicked.
Class Hierarchy
|GObject
| +----Object
| +----Widget
| +----Container
| +----Bin
| +----Window
| +----Dialog
| +----MessageDialog
Types
data MessageDialog Source
castToMessageDialog :: GObjectClass obj => obj -> MessageDialogSource
toMessageDialog :: MessageDialogClass o => o -> MessageDialogSource
data MessageType Source
data ButtonsType Source
Specify what buttons this dialog should show.
- Prebuilt sets of buttons for the dialog. If none of these choices
are appropriate, simply use
ButtonsNone
then calldialogAddButtons
.
data DialogFlags Source
Flags used to influence dialog construction.
- Marking a dialog as model will call
widgetSetModal
on the dialog window, theDialogDestroyWithParent
will callwindowSetDestroyWithParent
on the dialog window. Note that in case the dialog is simply destroyed, no response signal is ever emitted. Finally,DialogNoSeparator
omits the separator between the action area and the dialog content which is preferable for very simple messages, i.e. those that only contain one button.
Constructors
:: Maybe Window | Transient parent of the dialog (or none) |
-> [DialogFlags] | |
-> MessageType | |
-> ButtonsType | |
-> String | The text of the message |
-> IO MessageDialog |
Create a new message dialog, which is a simple dialog with an icon
indicating the dialog type (error, warning, etc.) and some text the
user may want to see. When the user clicks a button a "response" signal
is emitted with response IDs from ResponseType
. See Dialog
for more
details.
messageDialogNewWithMarkupSource
:: Maybe Window | Transient parent of the dialog (or none) |
-> [DialogFlags] | |
-> MessageType | |
-> ButtonsType | |
-> Markup | The text of the message |
-> IO MessageDialog |
Creates a new message dialog, which is a simple dialog with an icon
indicating the dialog type (error, warning, etc.) and some text which
is marked up with the Pango text markup language. When the user clicks
a button a "response" signal is emitted with response IDs from
ResponseType
. See Dialog
and PangoMarkup
for more details.
- Available since Gtk+ version 2.4
Methods
:: MessageDialogClass self | |
=> self | |
-> Markup |
|
-> IO () |
Sets the text of the message dialog to be str
, which is marked up with
the Pango text markup language.
- Available since Gtk+ version 2.4
:: (MessageDialogClass self, WidgetClass image) | |
=> self | |
-> image |
|
-> IO () |
Sets the dialog's image to image
.
- Available since Gtk+ version 2.10
messageDialogSetSecondaryMarkupSource
:: MessageDialogClass self | |
=> self | |
-> String |
|
-> IO () |
messageDialogSetSecondaryTextSource
:: MessageDialogClass self | |
=> self | |
-> String |
|
-> IO () |
Attributes
messageDialogMessageType :: MessageDialogClass self => Attr self MessageTypeSource
The type of message.
Default value: MessageInfo
messageDialogText :: MessageDialogClass self => Attr self (Maybe String)Source
The primary text of the message dialog. If the dialog has a secondary text, this will appear as the title.
Default value: Nothing
- Available since Gtk+ version 2.10
messageDialogUseMarkup :: MessageDialogClass self => Attr self BoolSource
Interpret the string messageDialogText
as markup.
Default value: False
- Available since Gtk+ version 2.10
messageDialogSecondaryText :: MessageDialogClass self => Attr self (Maybe String)Source
The secondary text of the message dialog.
Default value: Nothing
- Available since Gtk+ version 2.10
messageDialogSecondaryUseMarkup :: MessageDialogClass self => Attr self BoolSource
Default value: False
- Available since Gtk+ version 2.10
messageDialogImage :: (MessageDialogClass self, WidgetClass widget) => ReadWriteAttr self Widget widgetSource
The image for this dialog.
- Available since Gtk+ version 2.10
messageDialogButtons :: MessageDialogClass self => WriteAttr self ButtonsTypeSource
The buttons shown in the message dialog.
Default value: ButtonsNone
messageDialogMessageArea :: MessageDialogClass self => ReadAttr self VBoxSource
The VBox
that corresponds to the message area of this dialog.
- Available since Gtk+ version 2.22