gtk-0.12.2: Binding to the Gtk+ graphical user interface library.

Portability | portable (depends on GHC)
Stability | provisional
Maintainer | gtk2hs-users@lists.sourceforge.net

Graphics.UI.Gtk.Windows.Dialog

Contents

- Detail
- Class Hierarchy
- Types
- Enums
- Constructors
- Methods
- Attributes
- Signals
- Deprecated

Description

Create popup windows

NOTE: Now FFI haven't support variadic function `gtk_dialog_set_alternative_button_order`

Synopsis

- data Dialog
- class WindowClass o => DialogClass o
- castToDialog :: GObjectClass obj => obj -> Dialog
- gTypeDialog :: GType
- toDialog :: DialogClass o => o -> Dialog
- data ResponseId
  - = ResponseNone
  - | ResponseReject
  - | ResponseAccept
  - | ResponseDeleteEvent
  - | ResponseOk
  - | ResponseCancel
  - | ResponseClose
  - | ResponseYes
  - | ResponseNo
  - | ResponseApply
  - | ResponseHelp
  - | ResponseUser Int
- dialogNew :: IO Dialog
- dialogGetUpper :: DialogClass dc => dc -> IO VBox
- dialogGetActionArea :: DialogClass dc => dc -> IO HBox
- dialogRun :: DialogClass self => self -> IO ResponseId
- dialogResponse :: DialogClass self => self -> ResponseId -> IO ()
- dialogAddButton :: DialogClass self => self -> String -> ResponseId -> IO Button
- dialogAddActionWidget :: (DialogClass self, WidgetClass child) => self -> child -> ResponseId -> IO ()
- dialogGetHasSeparator :: DialogClass self => self -> IO Bool
- dialogSetDefaultResponse :: DialogClass self => self -> ResponseId -> IO ()
- dialogSetHasSeparator :: DialogClass self => self -> Bool -> IO ()
- dialogSetResponseSensitive :: DialogClass self => self -> ResponseId -> Bool -> IO ()
- dialogGetResponseForWidget :: (DialogClass self, WidgetClass widget) => self -> widget -> IO ResponseId
- dialogAlternativeDialogButtonOrder :: Maybe Screen -> IO Bool
- dialogSetAlternativeButtonOrderFromArray :: DialogClass self => self -> [ResponseId] -> IO ()
- dialogGetWidgetForResponse :: DialogClass self => self -> ResponseId -> IO (Maybe Widget)
- dialogHasSeparator :: DialogClass self => Attr self Bool
- dialogActionAreaBorder :: DialogClass self => ReadAttr self Int
- dialogButtonSpacing :: DialogClass self => ReadAttr self Int
- dialogContentAreaBorder :: DialogClass self => ReadAttr self Int
- dialogContentAreaSpacing :: DialogClass self => ReadAttr self Int
- response :: DialogClass self => Signal self (ResponseId -> IO ())
- onResponse :: DialogClass self => self -> (ResponseId -> IO ()) -> IO (ConnectId self)
- afterResponse :: DialogClass self => self -> (ResponseId -> IO ()) -> IO (ConnectId self)

# Detail

Dialog boxes are a convenient way to prompt the user for a small amount of input, e.g. to display a message, ask a question, or anything else that does not require extensive effort on the user's part.

Gtk+ treats a dialog as a window split vertically. The top section is a `VBox`, and is where widgets such as a `Label` or a `Entry` should be packed. The bottom area is known as the action_area. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two areas are separated by a `HSeparator`.

`Dialog` boxes are created with a call to `dialogNew` or `dialogNewWithButtons`. `dialogNewWithButtons` is recommended; it allows you to set the dialog title, some convenient flags, and add simple buttons.

If 'dialog' is a newly created dialog, the two primary areas of the window can be accessed using `dialogGetUpper` and `dialogGetActionArea`.

A 'modal' dialog (that is, one which freezes the rest of the application from user input), can be created by calling `windowSetModal` on the dialog. When using `dialogNewWithButtons` you can also pass the `DialogModal` flag to make a dialog modal.

If you add buttons to `Dialog` using `dialogNewWithButtons`, `dialogAddButton`, `dialogAddButtons`, or `dialogAddActionWidget`, clicking the button will emit a signal called "response" with a response ID that you specified. Gtk+ will never assign a meaning to positive response IDs; these are entirely user-defined. But for convenience, you can use the response IDs in the `ResponseType` enumeration (these all have values less than zero). If a dialog receives a delete event, the "response" signal will be emitted with a response ID of `ResponseNone`.

If you want to block waiting for a dialog to return before returning control flow to your code, you can call `dialogRun`. This function enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked.

For a simple message box, you probably want to use `Graphics.UI.Gtk.Windows.MessageDialog.MessageDialog` which provides convenience functions for creating standard dialogs containing simple messages to inform or ask the user.

# Class Hierarchy

     | GObject
     | +----Object
     | +----Widget
     | +----Container
     | +----Bin
     | +----Window
     | +----Dialog
     | +----AboutDialog
     | +----ColorSelectionDialog
     | +----FileChooserDialog
     | +----FileSelection
     | +----FontSelectionDialog
     | +----InputDialog
     | +----MessageDialog

# Types

data Dialog

Instances

Eq Dialog |
Ord Dialog |
GObjectClass Dialog |
DialogClass Dialog |
WindowClass Dialog |
BinClass Dialog |
ContainerClass Dialog |
WidgetClass Dialog |
ObjectClass Dialog |

class WindowClass o => DialogClass o

Instances

DialogClass MessageDialog |
DialogClass InputDialog |
DialogClass FontSelectionDialog |
DialogClass FileChooserDialog |
DialogClass FileSelection |
DialogClass ColorSelectionDialog |
DialogClass AboutDialog |
DialogClass Dialog |

castToDialog :: GObjectClass obj => obj -> Dialog

gTypeDialog :: GType

toDialog :: DialogClass o => o -> Dialog

# Enums

data ResponseId

Some constructors that can be used as response numbers for dialogs.

Constructors

ResponseNone | GTK returns this if a response widget has no `response_id`, or if the dialog gets programmatically hidden or destroyed.
ResponseReject | GTK won't return these unless you pass them in as the response for an action widget. They are for your convenience.
ResponseAccept | (as above)
ResponseDeleteEvent | If the dialog is deleted.
ResponseOk | "Ok" was pressed. This value is returned from the "Ok" stock dialog button.
ResponseCancel | "Cancel" was pressed. These value is returned from the "Cancel" stock dialog button.
ResponseClose | "Close" was pressed. This value is returned from the "Close" stock dialog button.
ResponseYes | "Yes" was pressed. This value is returned from the "Yes" stock dialog button.
ResponseNo | "No" was pressed. This value is returned from the "No" stock dialog button.
ResponseApply | "Apply" was pressed. This value is returned from the "Apply" stock dialog button.
ResponseHelp | "Help" was pressed. This value is returned from the "Help" stock dialog button.
ResponseUser Int | A user-defined response This value is returned from a user defined button

Instances

Eq ResponseId |
Show ResponseId |

# Constructors

dialogNew :: IO Dialog

Creates a new dialog box. Widgets should not be packed into this `Window` directly, but into the "upper" and "action area", which are obtained using `dialogGetUpper` and `dialogGetActionArea`.

# Methods

dialogGetUpper :: DialogClass dc => dc -> IO VBox

Get the upper part of a dialog.

- The upper part of a dialog window consists of a `VBox`. Add the required widgets into this box.

dialogGetActionArea :: DialogClass dc => dc -> IO HBox

Extract the action area of a dialog box.

- This is useful to add some special widgets that cannot be added with dialogAddActionWidget.

dialogRun :: DialogClass self => self -> IO ResponseId

Blocks in a recursive main loop until the dialog either emits the response signal, or is destroyed. If the dialog is destroyed during the call to `dialogRun`, it returns `ResponseNone`. Otherwise, it returns the response ID from the "response" signal emission. Before entering the recursive main loop, `dialogRun` calls `widgetShow` on the dialog for you. Note that you still need to show any children of the dialog yourself.

During `dialogRun`, the default behavior of "delete_event" is disabled; if the dialog receives "delete_event", it will not be destroyed as windows usually are, and `dialogRun` will return `ResponseDeleteEvent`. Also, during `dialogRun` the dialog will be modal. You can force `dialogRun` to return at any time by calling `dialogResponse` to emit the "response" signal. Destroying the dialog during `dialogRun` is a very bad idea, because your post-run code won't know whether the dialog was destroyed or not. Hence, you should not call `Graphics.UI.Gtk.Abstract.widgetDestroy` before `dialogRun` has returned.

After `dialogRun` returns, you are responsible for hiding or destroying the dialog if you wish to do so.

Note that even though the recursive main loop gives the effect of a modal dialog (it prevents the user from interacting with other windows while the dialog is run), callbacks such as timeouts, IO channel watches, DND drops, etc, will be triggered during a `dialogRun` call.

dialogResponse :: DialogClass self => self -> ResponseId -> IO ()

Emits the "response" signal with the given response ID. Used to indicate that the user has responded to the dialog in some way; typically either you or `dialogRun` will be monitoring the "response" signal and take appropriate action.

This function can be used to add a custom widget to the action area that should close the dialog when activated or to close the dialog otherwise.

dialogAddButton

Arguments

:: DialogClass self |
=> self |
-> String | `buttonText` - text of button, or stock ID
-> ResponseId | `responseId` - response ID for the button
-> IO Button | returns the button widget that was added

Adds a button with the given text (or a stock button, if `buttonText` is a stock ID) and sets things up so that clicking the button will emit the "response" signal with the given `responseId`. The button is appended to the end of the dialog's action area. The button widget is returned, but usually you don't need it.

dialogAddActionWidget

Arguments

:: (DialogClass self, WidgetClass child) |
=> self |
-> child | `child` - an activatable widget
-> ResponseId | `responseId` - response ID for `child`
-> IO () |

Adds an activatable widget to the action area of a `Dialog`, connecting a signal handler that will emit the "response" signal on the dialog when the widget is activated. The widget is appended to the end of the dialog's action area. If you want to add a non-activatable widget, simply pack it into the action area.

dialogGetHasSeparator :: DialogClass self => self -> IO Bool

Query if the dialog has a visible horizontal separator.

dialogSetDefaultResponse :: DialogClass self => self -> ResponseId -> IO ()

Sets the last widget in the dialog's action area with the given `ResponseId` as the default widget for the dialog. Pressing "Enter" normally activates the default widget.

- The default response is reset once it is triggered. Hence, if you hide the dialog (rather than closing it) and re-display it later, you need to call this function again.

dialogSetHasSeparator :: DialogClass self => self -> Bool -> IO ()

Sets whether the dialog has a separator above the buttons. `True` by default.

dialogSetResponseSensitive

Arguments

:: DialogClass self |
=> self |
-> ResponseId | `responseId` - a response ID
-> Bool | `setting` - `True` for sensitive
-> IO () |

Calls ``widgetSetSensitive` widget setting` for each widget in the dialog's action area with the given `responseId`. A convenient way to sensitize/desensitize dialog buttons.

dialogGetResponseForWidget

Arguments

:: (DialogClass self, WidgetClass widget) |
=> self |
-> widget | `widget` - a widget in the action area of dialog
-> IO ResponseId | return the response id of widget, or `ResponseNone` if widget doesn't have a response id set.

Gets the response id of a widget in the action area of a dialog.

dialogAlternativeDialogButtonOrder

Arguments

:: Maybe Screen | `screen` - a `Screen`, or `Nothing` to use the default screen
-> IO Bool | returns whether the alternative button order should be used

Returns `True` if dialogs are expected to use an alternative button order on the screen screen. See `dialogSetAlternativeButtonOrder` for more details about alternative button order.

If you need to use this function, you should probably connect to the `alternativeButtonOrder` signal on the GtkSettings object associated to screen, in order to be notified if the button order setting changes.

- Available since Gtk+ version 2.6

dialogSetAlternativeButtonOrderFromArray

Arguments

:: DialogClass self |
=> self |
-> [ResponseId] | `newOrder` - an array of response ids of dialog's buttons
-> IO () |

Sets an alternative button order.

If the `alternativeButtonOrder` setting is set to `True`, the dialog buttons are reordered according to the order of the response ids in `newOrder`.

See `dialogSetAlternativeButtonOrder` for more information.

This function is for use by language bindings.

- Available since Gtk+ version 2.6

dialogGetWidgetForResponse

Arguments

:: DialogClass self |
=> self |
-> ResponseId | `responseId` the response ID used by the dialog widget
-> IO (Maybe Widget) | returns the widget button that uses the given `responseId`, or `Nothing`.

Gets the widget button that uses the given response ID in the action area of a dialog.

# Attributes

dialogHasSeparator :: DialogClass self => Attr self Bool

The dialog has a separator bar above its buttons.

Default value: `True`

dialogActionAreaBorder :: DialogClass self => ReadAttr self Int

Width of border around the button area at the bottom of the dialog.

Allowed values: >= 0

Default value: 5

dialogButtonSpacing :: DialogClass self => ReadAttr self Int

Spacing between buttons.

Allowed values: >= 0

Default value: 6

dialogContentAreaBorder :: DialogClass self => ReadAttr self Int

Width of border around the main dialog area.

Allowed values: >= 0

Default value: 2

dialogContentAreaSpacing :: DialogClass self => ReadAttr self Int

The default spacing used between elements of the content area of the dialog, as returned by `dialogSetContentArea`, unless `boxSetSpacing` was called on that widget directly.

Allowed values: >= 0

Default value: 0

- Available since Gtk+ version 2.16

# Signals

response :: DialogClass self => Signal self (ResponseId -> IO ())

Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls `dialogResponse`. On a delete event, the response ID is `ResponseNone`. Otherwise, it depends on which action widget was clicked.

# Deprecated

onResponse :: DialogClass self => self -> (ResponseId -> IO ()) -> IO (ConnectId self)

afterResponse :: DialogClass self => self -> (ResponseId -> IO ()) -> IO (ConnectId self)

Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls `dialogResponse`. On a delete event, the response ID is `ResponseNone`. Otherwise, it depends on which action widget was clicked.