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

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2000 Red Hat, Inc.
   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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2003.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __GTK_MESSAGE_DIALOG_H__
  26 #define __GTK_MESSAGE_DIALOG_H__
  27
  28 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  29 #error "Only <gtk/gtk.h> can be included directly."
  30 #endif
  31
  32 #include <gtk/gtkdialog.h>
  33 #include <gtk/gtkenums.h>
  34
  35 G_BEGIN_DECLS
  36
  37
  38 #define GTK_TYPE_MESSAGE_DIALOG                  (gtk_message_dialog_get_type ())
  39 #define GTK_MESSAGE_DIALOG(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_MESSAGE_DIALOG, GtkMessageDialog))
  40 #define GTK_MESSAGE_DIALOG_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_MESSAGE_DIALOG, GtkMessageDialogClass))
  41 #define GTK_IS_MESSAGE_DIALOG(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_MESSAGE_DIALOG))
  42 #define GTK_IS_MESSAGE_DIALOG_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MESSAGE_DIALOG))
  43 #define GTK_MESSAGE_DIALOG_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_MESSAGE_DIALOG, GtkMessageDialogClass))
  44
  45 typedef struct _GtkMessageDialog              GtkMessageDialog;
  46 typedef struct _GtkMessageDialogPrivate       GtkMessageDialogPrivate;
  47 typedef struct _GtkMessageDialogClass         GtkMessageDialogClass;
  48
  49 struct _GtkMessageDialog
  50 {
  51   GtkDialog parent_instance;
  52
  53   /*< private >*/
  54   GtkMessageDialogPrivate *priv;
  55 };
  56
  57 struct _GtkMessageDialogClass
  58 {
  59   GtkDialogClass parent_class;
  60
  61   /* Padding for future expansion */
  62   void (*_gtk_reserved1) (void);
  63   void (*_gtk_reserved2) (void);
  64   void (*_gtk_reserved3) (void);
  65   void (*_gtk_reserved4) (void);
  66 };
  67
  68 /**
  69  * GtkButtonsType:
  70  * @GTK_BUTTONS_NONE: no buttons at all
  71  * @GTK_BUTTONS_OK: an OK button
  72  * @GTK_BUTTONS_CLOSE: a Close button
  73  * @GTK_BUTTONS_CANCEL: a Cancel button
  74  * @GTK_BUTTONS_YES_NO: Yes and No buttons
  75  * @GTK_BUTTONS_OK_CANCEL: OK and Cancel buttons
  76  *
  77  * Prebuilt sets of buttons for the dialog. If
  78  * none of these choices are appropriate, simply use %GTK_BUTTONS_NONE
  79  * then call gtk_dialog_add_buttons().
  80  * <note>
  81  *  Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO
  82  *  and %GTK_BUTTONS_OK_CANCEL are discouraged by the
  83  *  <ulink url="http://library.gnome.org/devel/hig-book/stable/">GNOME HIG</ulink>.
  84  * </note>
  85  */
  86 typedef enum
  87 {
  88   GTK_BUTTONS_NONE,
  89   GTK_BUTTONS_OK,
  90   GTK_BUTTONS_CLOSE,
  91   GTK_BUTTONS_CANCEL,
  92   GTK_BUTTONS_YES_NO,
  93   GTK_BUTTONS_OK_CANCEL
  94 } GtkButtonsType;
  95
  96 GType      gtk_message_dialog_get_type (void) G_GNUC_CONST;
  97
  98 GtkWidget* gtk_message_dialog_new      (GtkWindow      *parent,
  99                                         GtkDialogFlags  flags,
 100                                         GtkMessageType  type,
 101                                         GtkButtonsType  buttons,
 102                                         const gchar    *message_format,
 103                                         ...) G_GNUC_PRINTF (5, 6);
 104
 105 GtkWidget* gtk_message_dialog_new_with_markup   (GtkWindow      *parent,
 106                                                  GtkDialogFlags  flags,
 107                                                  GtkMessageType  type,
 108                                                  GtkButtonsType  buttons,
 109                                                  const gchar    *message_format,
 110                                                  ...) G_GNUC_PRINTF (5, 6);
 111
 112 void       gtk_message_dialog_set_image    (GtkMessageDialog *dialog,
 113                                             GtkWidget        *image);
 114
 115 GtkWidget * gtk_message_dialog_get_image   (GtkMessageDialog *dialog);
 116
 117 void       gtk_message_dialog_set_markup  (GtkMessageDialog *message_dialog,
 118                                            const gchar      *str);
 119
 120 void       gtk_message_dialog_format_secondary_text (GtkMessageDialog *message_dialog,
 121                                                      const gchar      *message_format,
 122                                                      ...) G_GNUC_PRINTF (2, 3);
 123
 124 void       gtk_message_dialog_format_secondary_markup (GtkMessageDialog *message_dialog,
 125                                                        const gchar      *message_format,
 126                                                        ...) G_GNUC_PRINTF (2, 3);
 127
 128 GtkWidget *gtk_message_dialog_get_message_area (GtkMessageDialog *message_dialog);
 129
 130 G_END_DECLS
 131
 132 #endif /* __GTK_MESSAGE_DIALOG_H__ */