gtkdialog.h 6.39 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * 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 29 30
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
31 32 33 34 35 36 37
#ifndef __GTK_DIALOG_H__
#define __GTK_DIALOG_H__


#include <gtk/gtkwindow.h>


38
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
39

40 41 42
/* Parameters for dialog construction */
typedef enum
{
43 44 45
  GTK_DIALOG_MODAL               = 1 << 0, /* call gtk_window_set_modal (win, TRUE) */
  GTK_DIALOG_DESTROY_WITH_PARENT = 1 << 1, /* call gtk_window_set_destroy_with_parent () */
  GTK_DIALOG_NO_SEPARATOR        = 1 << 2  /* no separator bar above buttons */
46 47
} GtkDialogFlags;

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 55 56 57 58
 *       blah();
 */
typedef enum
{
  /* 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 65
   * as the response for an action widget. They are
   * for your convenience.
66 67
   */
  GTK_RESPONSE_REJECT = -2,
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
  GTK_RESPONSE_ACCEPT = -3,

  /* If the dialog is deleted. */
  GTK_RESPONSE_DELETE_EVENT = -4,

  /* These are returned from GTK dialogs, and you can also use them
   * yourself if you like.
   */
  GTK_RESPONSE_OK     = -5,
  GTK_RESPONSE_CANCEL = -6,
  GTK_RESPONSE_CLOSE  = -7,
  GTK_RESPONSE_YES    = -8,
  GTK_RESPONSE_NO     = -9,
  GTK_RESPONSE_APPLY  = -10,
  GTK_RESPONSE_HELP   = -11
83 84
} GtkResponseType;

Elliot Lee's avatar
Elliot Lee committed
85

Tim Janik's avatar
Tim Janik committed
86
#define GTK_TYPE_DIALOG                  (gtk_dialog_get_type ())
Manish Singh's avatar
Manish Singh committed
87 88 89 90 91
#define GTK_DIALOG(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_DIALOG, GtkDialog))
#define GTK_DIALOG_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_DIALOG, GtkDialogClass))
#define GTK_IS_DIALOG(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_DIALOG))
#define GTK_IS_DIALOG_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_DIALOG))
#define GTK_DIALOG_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_DIALOG, GtkDialogClass))
Elliot Lee's avatar
Elliot Lee committed
92 93


94 95 96
typedef struct _GtkDialog              GtkDialog;
typedef struct _GtkDialogPrivate       GtkDialogPrivate;
typedef struct _GtkDialogClass         GtkDialogClass;
Elliot Lee's avatar
Elliot Lee committed
97 98 99 100 101

struct _GtkDialog
{
  GtkWindow window;

102
  /*< private >*/
103
  GtkDialogPrivate *priv;
Elliot Lee's avatar
Elliot Lee committed
104 105 106 107 108
};

struct _GtkDialogClass
{
  GtkWindowClass parent_class;
109 110

  void (* response) (GtkDialog *dialog, gint response_id);
111 112 113 114

  /* Keybinding signals */

  void (* close)    (GtkDialog *dialog);
115 116 117 118 119 120

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
Elliot Lee's avatar
Elliot Lee committed
121 122 123
};


Manish Singh's avatar
Manish Singh committed
124
GType      gtk_dialog_get_type (void) G_GNUC_CONST;
Elliot Lee's avatar
Elliot Lee committed
125 126
GtkWidget* gtk_dialog_new      (void);

127 128 129 130
GtkWidget* gtk_dialog_new_with_buttons (const gchar     *title,
                                        GtkWindow       *parent,
                                        GtkDialogFlags   flags,
                                        const gchar     *first_button_text,
131
                                        ...);
132

133 134 135 136 137 138 139 140
void       gtk_dialog_add_action_widget (GtkDialog   *dialog,
                                         GtkWidget   *child,
                                         gint         response_id);
GtkWidget* gtk_dialog_add_button        (GtkDialog   *dialog,
                                         const gchar *button_text,
                                         gint         response_id);
void       gtk_dialog_add_buttons       (GtkDialog   *dialog,
                                         const gchar *first_button_text,
141
                                         ...) G_GNUC_NULL_TERMINATED;
142

143 144 145 146 147
void gtk_dialog_set_response_sensitive (GtkDialog *dialog,
                                        gint       response_id,
                                        gboolean   setting);
void gtk_dialog_set_default_response   (GtkDialog *dialog,
                                        gint       response_id);
148 149
GtkWidget* gtk_dialog_get_widget_for_response (GtkDialog *dialog,
                                               gint       response_id);
150 151
gint gtk_dialog_get_response_for_widget (GtkDialog *dialog,
					 GtkWidget *widget);
152

153 154 155 156
void     gtk_dialog_set_has_separator (GtkDialog *dialog,
                                       gboolean   setting);
gboolean gtk_dialog_get_has_separator (GtkDialog *dialog);

157 158 159 160
gboolean gtk_alternative_dialog_button_order (GdkScreen *screen);
void     gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
						  gint       first_response_id,
						  ...);
161 162 163
void     gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
                                                             gint       n_params,
                                                             gint      *new_order);
164

165 166 167 168 169 170
/* Emit response signal */
void gtk_dialog_response           (GtkDialog *dialog,
                                    gint       response_id);

/* Returns response_id */
gint gtk_dialog_run                (GtkDialog *dialog);
Elliot Lee's avatar
Elliot Lee committed
171

172 173
GtkWidget * gtk_dialog_get_action_area  (GtkDialog *dialog);
GtkWidget * gtk_dialog_get_content_area (GtkDialog *dialog);
Federico Mena Quintero's avatar
Federico Mena Quintero committed
174 175 176 177 178

/* For private use only */
void _gtk_dialog_set_ignore_separator (GtkDialog *dialog,
				       gboolean   ignore_separator);

179
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
180 181

#endif /* __GTK_DIALOG_H__ */