GimpDialog: GIMP Widgets Library Reference Manual

## GimpDialog GimpDialog — Constructors for GtkDialog's and action_areas as well as other dialog-related stuff. |

## Functions

GtkWidget * | gimp_dialog_new ()
GtkWidget * | gimp_dialog_new_valist ()
GtkWidget * | gimp_dialog_add_button ()
void | gimp_dialog_add_buttons ()
void | gimp_dialog_add_buttons_valist ()
gint | gimp_dialog_run ()
void | gimp_dialogs_show_help_button ()

## Properties

gpointer | help-func | Read / Write / Construct Only
char * | help-id | Read / Write / Construct
GtkWidget * | parent | Write / Construct Only

## Types and Values

| GimpDialog

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkObject
                ╰── GtkWidget
                    ╰── GtkContainer
                        ╰── GtkBin
                            ╰── GtkWindow
                                ╰── GtkDialog
                                    ╰── GimpDialog

## Implemented Interfaces

GimpDialog implements AtkImplementorIface and GtkBuildable.

## Description

Constructors for GtkDialog's and action_areas as well as other dialog-related stuff.

## Functions

### gimp_dialog_new ()

    GtkWidget *
    gimp_dialog_new (const gchar *title,
                     const gchar *role,
                     GtkWidget *parent,
                     GtkDialogFlags flags,
                     GimpHelpFunc help_func,
                     const gchar *help_id,
                     ...);

Creates a new `GimpDialog` widget.

This function simply packs the action_area arguments passed in "..." into a `va_list` variable and passes everything to `gimp_dialog_new_valist()`.

For a description of the format of the `va_list` describing the action_area buttons see `gtk_dialog_new_with_buttons()`.

#### Parameters

title | The dialog's title which will be set with `gtk_window_set_title()`. |
role | The dialog's `role` which will be set with `gtk_window_set_role()`. |
parent | The `parent` widget of this dialog. |
flags | The `flags` (see the GtkDialog documentation). |
help_func | The function which will be called if the user presses "F1". |
help_id | The help_id which will be passed to `help_func` . |
... | A `NULL`-terminated `va_list` destribing the action_area buttons. |

#### Returns

A GimpDialog.

### gimp_dialog_new_valist ()

    GtkWidget *
    gimp_dialog_new_valist (const gchar *title,
                            const gchar *role,
                            GtkWidget *parent,
                            GtkDialogFlags flags,
                            GimpHelpFunc help_func,
                            const gchar *help_id,
                            va_list args);

Creates a new `GimpDialog` widget. If a GtkWindow is specified as `parent` then the dialog will be made transient for this window.

For a description of the format of the `va_list` describing the action_area buttons see `gtk_dialog_new_with_buttons()`.

#### Parameters

title | The dialog's title which will be set with `gtk_window_set_title()`. |
role | The dialog's `role` which will be set with `gtk_window_set_role()`. |
parent | The `parent` widget of this dialog or `NULL`. |
flags | The `flags` (see the GtkDialog documentation). |
help_func | The function which will be called if the user presses "F1". |
help_id | The help_id which will be passed to `help_func` . |
args | A `va_list` destribing the action_area buttons. |

#### Returns

A GimpDialog.

### gimp_dialog_add_button ()

    GtkWidget *
    gimp_dialog_add_button (GimpDialog *dialog,
                            const gchar *button_text,
                            gint response_id);

This function is essentially the same as `gtk_dialog_add_button()` except it ensures there is only one help button and automatically sets the RESPONSE_OK widget as the default response.

#### Parameters

dialog | The `dialog` to add a button to. |
button_text | text of button, or stock ID. |
response_id | response ID for the button. |

#### Returns

the button widget that was added.

### gimp_dialog_add_buttons ()

    void
    gimp_dialog_add_buttons (GimpDialog *dialog,
                             ...);

This function is essentially the same as `gtk_dialog_add_buttons()` except it calls `gimp_dialog_add_button()` instead of `gtk_dialog_add_button()`

#### Parameters

dialog | The `dialog` to add buttons to. |
... | button_text-response_id pairs. |

### gimp_dialog_add_buttons_valist ()

    void
    gimp_dialog_add_buttons_valist (GimpDialog *dialog,
                                    va_list args);

This function is essentially the same as `gimp_dialog_add_buttons()` except it takes a va_list instead of '...'

#### Parameters

dialog | The `dialog` to add buttons to. |
args | The buttons as va_list. |

### gimp_dialog_run ()

    gint
    gimp_dialog_run (GimpDialog *dialog);

This function does exactly the same as `gtk_dialog_run()` except it does not make the dialog modal while the GMainLoop is running.

#### Parameters

dialog | a GimpDialog |

#### Returns

response ID

### gimp_dialogs_show_help_button ()

    void
    gimp_dialogs_show_help_button (gboolean show);

This function is for internal use only.

#### Parameters

show | whether a help button should be added when creating a GimpDialog |

Since: 2.2

## Types and Values

### GimpDialog

    typedef struct _GimpDialog GimpDialog;

## Property Details

### The `“help-func”` property

      “help-func”                gpointer

The help function to call when F1 is hit.

Owner: GimpDialog

Flags: Read / Write / Construct Only

Since: 2.2

### The `“help-id”` property

      “help-id”                  char *

The help ID to pass to help-func.

Owner: GimpDialog

Flags: Read / Write / Construct

Default value: NULL

Since: 2.2

### The `“parent”` property

      “parent”                   GtkWidget *

The dialog's parent widget.

Owner: GimpDialog

Flags: Write / Construct Only

Since: 2.8