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 #ifndef __GTK_DIALOG_H__
  28 #define __GTK_DIALOG_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkwindow.h>
  33
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif /* __cplusplus */
  38
  39 /* Parameters for dialog construction */
  40 typedef enum
  41 {
  42   GTK_DIALOG_MODAL,               /* call gtk_window_set_modal (win, TRUE) */
  43   GTK_DIALOG_DESTROY_WITH_PARENT, /* call gtk_window_set_destroy_with_parent () */
  44   GTK_DIALOG_NO_SEPARATOR         /* no separator bar above buttons */
  45 } GtkDialogFlags;
  46
  47 /* Convenience enum to use for response_id's.  Positive values are
  48  * totally user-interpreted. GTK will sometimes return
  49  * GTK_RESPONSE_NONE if no response_id is available.
  50  *
  51  *  Typical usage is:
  52  *     if (gtk_dialog_run(dialog) == GTK_RESPONSE_ACCEPT)
  53  *       blah();
  54  */
  55 typedef enum
  56 {
  57   /* GTK returns this if a response widget has no response_id,
  58    * or if the dialog gets programmatically hidden or destroyed.
  59    */
  60   GTK_RESPONSE_NONE = -1,
  61
  62   /* GTK won't return these unless you pass them in
  63    * as the response for an action widget. They are
  64    * for your convenience.
  65    */
  66   GTK_RESPONSE_REJECT = -2,
  67   GTK_RESPONSE_ACCEPT = -3,
  68
  69   /* If the dialog is deleted. */
  70   GTK_RESPONSE_DELETE_EVENT = -4,
  71
  72   /* These are returned from GTK dialogs, and you can also use them
  73    * yourself if you like.
  74    */
  75   GTK_RESPONSE_OK     = -5,
  76   GTK_RESPONSE_CANCEL = -6,
  77   GTK_RESPONSE_CLOSE  = -7,
  78   GTK_RESPONSE_YES    = -8,
  79   GTK_RESPONSE_NO     = -9,
  80   GTK_RESPONSE_APPLY  = -10,
  81   GTK_RESPONSE_HELP   = -11
  82 } GtkResponseType;
  83
  84
  85 #define GTK_TYPE_DIALOG                  (gtk_dialog_get_type ())
  86 #define GTK_DIALOG(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_DIALOG, GtkDialog))
  87 #define GTK_DIALOG_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_DIALOG, GtkDialogClass))
  88 #define GTK_IS_DIALOG(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_DIALOG))
  89 #define GTK_IS_DIALOG_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_DIALOG))
  90 #define GTK_DIALOG_GET_CLASS(obj)        (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_DIALOG, GtkDialogClass))
  91
  92
  93 typedef struct _GtkDialog        GtkDialog;
  94 typedef struct _GtkDialogClass   GtkDialogClass;
  95
  96 struct _GtkDialog
  97 {
  98   GtkWindow window;
  99
 100   GtkWidget *vbox;
 101   GtkWidget *action_area;
 102
 103   /*< private >*/
 104   GtkWidget *separator;
 105 };
 106
 107 struct _GtkDialogClass
 108 {
 109   GtkWindowClass parent_class;
 110
 111   void (* response) (GtkDialog *dialog, gint response_id);
 112 };
 113
 114
 115 GtkType    gtk_dialog_get_type (void) G_GNUC_CONST;
 116 GtkWidget* gtk_dialog_new      (void);
 117
 118 GtkWidget* gtk_dialog_new_with_buttons (const gchar     *title,
 119                                         GtkWindow       *parent,
 120                                         GtkDialogFlags   flags,
 121                                         const gchar     *first_button_text,
 122                                         ...);
 123
 124 void       gtk_dialog_add_action_widget (GtkDialog   *dialog,
 125                                          GtkWidget   *child,
 126                                          gint         response_id);
 127 GtkWidget* gtk_dialog_add_button        (GtkDialog   *dialog,
 128                                          const gchar *button_text,
 129                                          gint         response_id);
 130 void       gtk_dialog_add_buttons       (GtkDialog   *dialog,
 131                                          const gchar *first_button_text,
 132                                          ...);
 133
 134 void gtk_dialog_set_response_sensitive (GtkDialog *dialog,
 135                                         gint       response_id,
 136                                         gboolean   setting);
 137 void gtk_dialog_set_default_response   (GtkDialog *dialog,
 138                                         gint       response_id);
 139
 140 void     gtk_dialog_set_has_separator (GtkDialog *dialog,
 141                                        gboolean   setting);
 142 gboolean gtk_dialog_get_has_separator (GtkDialog *dialog);
 143
 144 /* Emit response signal */
 145 void gtk_dialog_response           (GtkDialog *dialog,
 146                                     gint       response_id);
 147
 148 /* Returns response_id */
 149 gint gtk_dialog_run                (GtkDialog *dialog);
 150
 151 #ifdef __cplusplus
 152 }
 153 #endif /* __cplusplus */
 154
 155
 156 #endif /* __GTK_DIALOG_H__ */