Pileus Git - ~andy/gtk/blob - gtk/gtkdialog.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_DIALOG_H__
  32 #define __GTK_DIALOG_H__
  33
  34
  35 #include <gdk/gdk.h>
  36 #include <gtk/gtkwindow.h>
  37
  38
  39 G_BEGIN_DECLS
  40
  41 /* Parameters for dialog construction */
  42 typedef enum
  43 {
  44   GTK_DIALOG_MODAL               = 1 << 0, /* call gtk_window_set_modal (win, TRUE) */
  45   GTK_DIALOG_DESTROY_WITH_PARENT = 1 << 1, /* call gtk_window_set_destroy_with_parent () */
  46   GTK_DIALOG_NO_SEPARATOR        = 1 << 2  /* no separator bar above buttons */
  47 } GtkDialogFlags;
  48
  49 /* Convenience enum to use for response_id's.  Positive values are
  50  * totally user-interpreted. GTK will sometimes return
  51  * GTK_RESPONSE_NONE if no response_id is available.
  52  *
  53  *  Typical usage is:
  54  *     if (gtk_dialog_run(dialog) == GTK_RESPONSE_ACCEPT)
  55  *       blah();
  56  */
  57 typedef enum
  58 {
  59   /* GTK returns this if a response widget has no response_id,
  60    * or if the dialog gets programmatically hidden or destroyed.
  61    */
  62   GTK_RESPONSE_NONE = -1,
  63
  64   /* GTK won't return these unless you pass them in
  65    * as the response for an action widget. They are
  66    * for your convenience.
  67    */
  68   GTK_RESPONSE_REJECT = -2,
  69   GTK_RESPONSE_ACCEPT = -3,
  70
  71   /* If the dialog is deleted. */
  72   GTK_RESPONSE_DELETE_EVENT = -4,
  73
  74   /* These are returned from GTK dialogs, and you can also use them
  75    * yourself if you like.
  76    */
  77   GTK_RESPONSE_OK     = -5,
  78   GTK_RESPONSE_CANCEL = -6,
  79   GTK_RESPONSE_CLOSE  = -7,
  80   GTK_RESPONSE_YES    = -8,
  81   GTK_RESPONSE_NO     = -9,
  82   GTK_RESPONSE_APPLY  = -10,
  83   GTK_RESPONSE_HELP   = -11
  84 } GtkResponseType;
  85
  86
  87 #define GTK_TYPE_DIALOG                  (gtk_dialog_get_type ())
  88 #define GTK_DIALOG(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_DIALOG, GtkDialog))
  89 #define GTK_DIALOG_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_DIALOG, GtkDialogClass))
  90 #define GTK_IS_DIALOG(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_DIALOG))
  91 #define GTK_IS_DIALOG_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_DIALOG))
  92 #define GTK_DIALOG_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_DIALOG, GtkDialogClass))
  93
  94
  95 typedef struct _GtkDialog        GtkDialog;
  96 typedef struct _GtkDialogClass   GtkDialogClass;
  97
  98 struct _GtkDialog
  99 {
 100   GtkWindow window;
 101
 102   /*< public >*/
 103   GtkWidget *vbox;
 104   GtkWidget *action_area;
 105
 106   /*< private >*/
 107   GtkWidget *separator;
 108 };
 109
 110 struct _GtkDialogClass
 111 {
 112   GtkWindowClass parent_class;
 113
 114   void (* response) (GtkDialog *dialog, gint response_id);
 115
 116   /* Keybinding signals */
 117
 118   void (* close)    (GtkDialog *dialog);
 119
 120   /* Padding for future expansion */
 121   void (*_gtk_reserved1) (void);
 122   void (*_gtk_reserved2) (void);
 123   void (*_gtk_reserved3) (void);
 124   void (*_gtk_reserved4) (void);
 125 };
 126
 127
 128 GType      gtk_dialog_get_type (void) G_GNUC_CONST;
 129 GtkWidget* gtk_dialog_new      (void);
 130
 131 GtkWidget* gtk_dialog_new_with_buttons (const gchar     *title,
 132                                         GtkWindow       *parent,
 133                                         GtkDialogFlags   flags,
 134                                         const gchar     *first_button_text,
 135                                         ...);
 136
 137 void       gtk_dialog_add_action_widget (GtkDialog   *dialog,
 138                                          GtkWidget   *child,
 139                                          gint         response_id);
 140 GtkWidget* gtk_dialog_add_button        (GtkDialog   *dialog,
 141                                          const gchar *button_text,
 142                                          gint         response_id);
 143 void       gtk_dialog_add_buttons       (GtkDialog   *dialog,
 144                                          const gchar *first_button_text,
 145                                          ...) G_GNUC_NULL_TERMINATED;
 146
 147 void gtk_dialog_set_response_sensitive (GtkDialog *dialog,
 148                                         gint       response_id,
 149                                         gboolean   setting);
 150 void gtk_dialog_set_default_response   (GtkDialog *dialog,
 151                                         gint       response_id);
 152 gint gtk_dialog_get_response_for_widget (GtkDialog *dialog,
 153                                          GtkWidget *widget);
 154
 155 void     gtk_dialog_set_has_separator (GtkDialog *dialog,
 156                                        gboolean   setting);
 157 gboolean gtk_dialog_get_has_separator (GtkDialog *dialog);
 158
 159 gboolean gtk_alternative_dialog_button_order (GdkScreen *screen);
 160 void     gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
 161                                                   gint       first_response_id,
 162                                                   ...);
 163 void     gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
 164                                                              gint       n_params,
 165                                                              gint      *new_order);
 166
 167 /* Emit response signal */
 168 void gtk_dialog_response           (GtkDialog *dialog,
 169                                     gint       response_id);
 170
 171 /* Returns response_id */
 172 gint gtk_dialog_run                (GtkDialog *dialog);
 173
 174
 175 /* For private use only */
 176 void _gtk_dialog_set_ignore_separator (GtkDialog *dialog,
 177                                        gboolean   ignore_separator);
 178
 179 G_END_DECLS
 180
 181 #endif /* __GTK_DIALOG_H__ */