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, 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-2003.  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_MESSAGE_DIALOG_H__
  32 #define __GTK_MESSAGE_DIALOG_H__
  33
  34 #include <gtk/gtkdialog.h>
  35 #include <gtk/gtkenums.h>
  36
  37 G_BEGIN_DECLS
  38
  39
  40 #define GTK_TYPE_MESSAGE_DIALOG                  (gtk_message_dialog_get_type ())
  41 #define GTK_MESSAGE_DIALOG(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_MESSAGE_DIALOG, GtkMessageDialog))
  42 #define GTK_MESSAGE_DIALOG_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_MESSAGE_DIALOG, GtkMessageDialogClass))
  43 #define GTK_IS_MESSAGE_DIALOG(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_MESSAGE_DIALOG))
  44 #define GTK_IS_MESSAGE_DIALOG_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MESSAGE_DIALOG))
  45 #define GTK_MESSAGE_DIALOG_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_MESSAGE_DIALOG, GtkMessageDialogClass))
  46
  47 typedef struct _GtkMessageDialog              GtkMessageDialog;
  48 typedef struct _GtkMessageDialogPrivate       GtkMessageDialogPrivate;
  49 typedef struct _GtkMessageDialogClass         GtkMessageDialogClass;
  50
  51 struct _GtkMessageDialog
  52 {
  53   GtkDialog parent_instance;
  54
  55   /*< private >*/
  56   GtkMessageDialogPrivate *priv;
  57 };
  58
  59 struct _GtkMessageDialogClass
  60 {
  61   GtkDialogClass parent_class;
  62
  63   /* Padding for future expansion */
  64   void (*_gtk_reserved1) (void);
  65   void (*_gtk_reserved2) (void);
  66   void (*_gtk_reserved3) (void);
  67   void (*_gtk_reserved4) (void);
  68 };
  69
  70 /**
  71  * GtkButtonsType:
  72  * @GTK_BUTTONS_NONE: no buttons at all
  73  * @GTK_BUTTONS_OK: an OK button
  74  * @GTK_BUTTONS_CLOSE: a Close button
  75  * @GTK_BUTTONS_CANCEL: a Cancel button
  76  * @GTK_BUTTONS_YES_NO: Yes and No buttons
  77  * @GTK_BUTTONS_OK_CANCEL: OK and Cancel buttons
  78  *
  79  * Prebuilt sets of buttons for the dialog. If
  80  * none of these choices are appropriate, simply use %GTK_BUTTONS_NONE
  81  * then call gtk_dialog_add_buttons().
  82  * <note>
  83  *  Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO
  84  *  and %GTK_BUTTONS_OK_CANCEL are discouraged by the
  85  *  <ulink url="http://library.gnome.org/devel/hig-book/stable/">GNOME HIG</ulink>.
  86  * </note>
  87  */
  88 typedef enum
  89 {
  90   GTK_BUTTONS_NONE,
  91   GTK_BUTTONS_OK,
  92   GTK_BUTTONS_CLOSE,
  93   GTK_BUTTONS_CANCEL,
  94   GTK_BUTTONS_YES_NO,
  95   GTK_BUTTONS_OK_CANCEL
  96 } GtkButtonsType;
  97
  98 GType      gtk_message_dialog_get_type (void) G_GNUC_CONST;
  99
 100 GtkWidget* gtk_message_dialog_new      (GtkWindow      *parent,
 101                                         GtkDialogFlags  flags,
 102                                         GtkMessageType  type,
 103                                         GtkButtonsType  buttons,
 104                                         const gchar    *message_format,
 105                                         ...) G_GNUC_PRINTF (5, 6);
 106
 107 GtkWidget* gtk_message_dialog_new_with_markup   (GtkWindow      *parent,
 108                                                  GtkDialogFlags  flags,
 109                                                  GtkMessageType  type,
 110                                                  GtkButtonsType  buttons,
 111                                                  const gchar    *message_format,
 112                                                  ...) G_GNUC_PRINTF (5, 6);
 113
 114 void       gtk_message_dialog_set_image    (GtkMessageDialog *dialog,
 115                                             GtkWidget        *image);
 116
 117 GtkWidget * gtk_message_dialog_get_image   (GtkMessageDialog *dialog);
 118
 119 void       gtk_message_dialog_set_markup  (GtkMessageDialog *message_dialog,
 120                                            const gchar      *str);
 121
 122 void       gtk_message_dialog_format_secondary_text (GtkMessageDialog *message_dialog,
 123                                                      const gchar      *message_format,
 124                                                      ...) G_GNUC_PRINTF (2, 3);
 125
 126 void       gtk_message_dialog_format_secondary_markup (GtkMessageDialog *message_dialog,
 127                                                        const gchar      *message_format,
 128                                                        ...) G_GNUC_PRINTF (2, 3);
 129
 130 GtkWidget *gtk_message_dialog_get_message_area (GtkMessageDialog *message_dialog);
 131
 132 G_END_DECLS
 133
 134 #endif /* __GTK_MESSAGE_DIALOG_H__ */