GimpDialog

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

Synopsis




            GimpDialog;
GtkWidget*  gimp_dialog_new                 (const gchar *title,
                                             const gchar *role,
                                             GtkWidget *parent,
                                             GtkDialogFlags flags,
                                             GimpHelpFunc help_func,
                                             const gchar *help_id,
                                             ...);
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);
void        gimp_dialog_add_buttons_valist  (GimpDialog *dialog,
                                             va_list args);
gint        gimp_dialog_run                 (GimpDialog *dialog);
void        gimp_dialogs_show_help_button   (gboolean show);

Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GtkDialog
                                             +----GimpDialog

Implemented Interfaces

GimpDialog implements AtkImplementorIface.

Properties


  "help-func"            gpointer              : Read / Write / Construct Only
  "help-id"              gchararray            : Read / Write / Construct Only

Description

Details

GimpDialog

typedef struct _GimpDialog GimpDialog;

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().

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().

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_buttons_valist ()

void        gimp_dialog_add_buttons_valist  (GimpDialog *dialog,
                                             va_list args);

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

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.

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.

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

Since GIMP 2.2

Property Details

The "help-func" property

  "help-func"            gpointer              : Read / Write / Construct Only

The "help-id" property

  "help-id"              gchararray            : Read / Write / Construct Only

Default value: NULL