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