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 #include <gtk/gtkhbbox.h>
  38
  39
  40 G_BEGIN_DECLS
  41
  42 /* Parameters for dialog construction */
  43 typedef enum
  44 {
  45   GTK_DIALOG_MODAL               = 1 << 0, /* call gtk_window_set_modal (win, TRUE) */
  46   GTK_DIALOG_DESTROY_WITH_PARENT = 1 << 1, /* call gtk_window_set_destroy_with_parent () */
  47   GTK_DIALOG_NO_SEPARATOR        = 1 << 2  /* no separator bar above buttons */
  48 } GtkDialogFlags;
  49
  50 /* Convenience enum to use for response_id's.  Positive values are
  51  * totally user-interpreted. GTK will sometimes return
  52  * GTK_RESPONSE_NONE if no response_id is available.
  53  *
  54  *  Typical usage is:
  55  *     if (gtk_dialog_run(dialog) == GTK_RESPONSE_ACCEPT)
  56  *       blah();
  57  */
  58 typedef enum
  59 {
  60   /* GTK returns this if a response widget has no response_id,
  61    * or if the dialog gets programmatically hidden or destroyed.
  62    */
  63   GTK_RESPONSE_NONE = -1,
  64
  65   /* GTK won't return these unless you pass them in
  66    * as the response for an action widget. They are
  67    * for your convenience.
  68    */
  69   GTK_RESPONSE_REJECT = -2,
  70   GTK_RESPONSE_ACCEPT = -3,
  71
  72   /* If the dialog is deleted. */
  73   GTK_RESPONSE_DELETE_EVENT = -4,
  74
  75   /* These are returned from GTK dialogs, and you can also use them
  76    * yourself if you like.
  77    */
  78   GTK_RESPONSE_OK     = -5,
  79   GTK_RESPONSE_CANCEL = -6,
  80   GTK_RESPONSE_CLOSE  = -7,
  81   GTK_RESPONSE_YES    = -8,
  82   GTK_RESPONSE_NO     = -9,
  83   GTK_RESPONSE_APPLY  = -10,
  84   GTK_RESPONSE_HELP   = -11
  85 } GtkResponseType;
  86
  87
  88 #define GTK_TYPE_DIALOG                  (gtk_dialog_get_type ())
  89 #define GTK_DIALOG(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_DIALOG, GtkDialog))
  90 #define GTK_DIALOG_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_DIALOG, GtkDialogClass))
  91 #define GTK_IS_DIALOG(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_DIALOG))
  92 #define GTK_IS_DIALOG_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_DIALOG))
  93 #define GTK_DIALOG_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_DIALOG, GtkDialogClass))
  94
  95
  96 typedef struct _GtkDialog        GtkDialog;
  97 typedef struct _GtkDialogClass   GtkDialogClass;
  98
  99 struct _GtkDialog
 100 {
 101   GtkWindow window;
 102
 103   /*< public >*/
 104   GtkWidget *vbox;
 105   GtkWidget *action_area;
 106
 107   /*< private >*/
 108   GtkWidget *separator;
 109 };
 110
 111 struct _GtkDialogClass
 112 {
 113   GtkWindowClass parent_class;
 114
 115   void (* response) (GtkDialog *dialog, gint response_id);
 116
 117   /* Keybinding signals */
 118
 119   void (* close)    (GtkDialog *dialog);
 120
 121   /* Padding for future expansion */
 122   void (*_gtk_reserved1) (void);
 123   void (*_gtk_reserved2) (void);
 124   void (*_gtk_reserved3) (void);
 125   void (*_gtk_reserved4) (void);
 126 };
 127
 128
 129 GType      gtk_dialog_get_type (void) G_GNUC_CONST;
 130 GtkWidget* gtk_dialog_new      (void);
 131
 132 GtkWidget* gtk_dialog_new_with_buttons (const gchar     *title,
 133                                         GtkWindow       *parent,
 134                                         GtkDialogFlags   flags,
 135                                         const gchar     *first_button_text,
 136                                         ...);
 137
 138 void       gtk_dialog_add_action_widget (GtkDialog   *dialog,
 139                                          GtkWidget   *child,
 140                                          gint         response_id);
 141 GtkWidget* gtk_dialog_add_button        (GtkDialog   *dialog,
 142                                          const gchar *button_text,
 143                                          gint         response_id);
 144 void       gtk_dialog_add_buttons       (GtkDialog   *dialog,
 145                                          const gchar *first_button_text,
 146                                          ...) G_GNUC_NULL_TERMINATED;
 147
 148 void gtk_dialog_set_response_sensitive (GtkDialog *dialog,
 149                                         gint       response_id,
 150                                         gboolean   setting);
 151 void gtk_dialog_set_default_response   (GtkDialog *dialog,
 152                                         gint       response_id);
 153 gint gtk_dialog_get_response_for_widget (GtkDialog *dialog,
 154                                          GtkWidget *widget);
 155
 156 void     gtk_dialog_set_has_separator (GtkDialog *dialog,
 157                                        gboolean   setting);
 158 gboolean gtk_dialog_get_has_separator (GtkDialog *dialog);
 159
 160 gboolean gtk_alternative_dialog_button_order (GdkScreen *screen);
 161 void     gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
 162                                                   gint       first_response_id,
 163                                                   ...);
 164 void     gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
 165                                                              gint       n_params,
 166                                                              gint      *new_order);
 167
 168 /* Emit response signal */
 169 void gtk_dialog_response           (GtkDialog *dialog,
 170                                     gint       response_id);
 171
 172 /* Returns response_id */
 173 gint gtk_dialog_run                (GtkDialog *dialog);
 174
 175 GtkHButtonBox* gtk_dialog_get_action_area (GtkDialog *dialog);
 176 void           gtk_dialog_pack_start      (GtkDialog *dialog,
 177                                            GtkWidget *widget,
 178                                            gboolean   expand,
 179                                            gboolean   fill,
 180                                            guint      padding);
 181 void           gtk_dialog_pack_end        (GtkDialog *dialog,
 182                                            GtkWidget *widget,
 183                                            gboolean   expand,
 184                                            gboolean   fill,
 185                                            guint      padding);
 186
 187 /* For private use only */
 188 void _gtk_dialog_set_ignore_separator (GtkDialog *dialog,
 189                                        gboolean   ignore_separator);
 190
 191 G_END_DECLS
 192
 193 #endif /* __GTK_DIALOG_H__ */