shell/ev-message-area.c

   1 /* ev-message-area.c
   2  *  this file is part of evince, a gnome document viewer
   3  *
   4  * Copyright (C) 2007 Carlos Garcia Campos
   5  *
   6  * Author:
   7  *   Carlos Garcia Campos <carlosgc@gnome.org>
   8  *
   9  * Evince is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * Evince is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  22  */
  23
  24 #include <gtk/gtkaccessible.h>
  25 #include <gtk/gtklabel.h>
  26 #include <gtk/gtkhbox.h>
  27 #include <gtk/gtkvbox.h>
  28 #include <gtk/gtkimage.h>
  29 #include <gtk/gtkstock.h>
  30
  31 #include "ev-message-area.h"
  32
  33 #define EV_MESSAGE_AREA_GET_PRIVATE(obj) \
  34         (G_TYPE_INSTANCE_GET_PRIVATE ((obj), EV_TYPE_MESSAGE_AREA, EvMessageAreaPrivate))
  35
  36 struct _EvMessageAreaPrivate {
  37         GtkWidget *image;
  38         GtkWidget *label;
  39         GtkWidget *secondary_label;
  40
  41         guint      message_type : 3;
  42 };
  43
  44 enum {
  45         PROP_0,
  46         PROP_MESSAGE_TYPE,
  47         PROP_TEXT,
  48         PROP_SECONDARY_TEXT,
  49         PROP_IMAGE
  50 };
  51
  52 static void ev_message_area_set_property (GObject      *object,
  53                                           guint         prop_id,
  54                                           const GValue *value,
  55                                           GParamSpec   *pspec);
  56 static void ev_message_area_get_property (GObject      *object,
  57                                           guint         prop_id,
  58                                           GValue       *value,
  59                                           GParamSpec   *pspec);
  60
  61 G_DEFINE_TYPE (EvMessageArea, ev_message_area, GEDIT_TYPE_MESSAGE_AREA)
  62
  63 static void
  64 ev_message_area_class_init (EvMessageAreaClass *class)
  65 {
  66         GObjectClass *gobject_class = G_OBJECT_CLASS (class);
  67
  68         gobject_class->set_property = ev_message_area_set_property;
  69         gobject_class->get_property = ev_message_area_get_property;
  70
  71         g_object_class_install_property (gobject_class,
  72                                          PROP_MESSAGE_TYPE,
  73                                          g_param_spec_enum ("message-type",
  74                                                             "Message Type",
  75                                                             "The type of message",
  76                                                             GTK_TYPE_MESSAGE_TYPE,
  77                                                             GTK_MESSAGE_INFO,
  78                                                             G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
  79         g_object_class_install_property (gobject_class,
  80                                          PROP_TEXT,
  81                                          g_param_spec_string ("text",
  82                                                               "Text",
  83                                                               "The primary text of the message dialog",
  84                                                               NULL,
  85                                                               G_PARAM_READWRITE));
  86         g_object_class_install_property (gobject_class,
  87                                          PROP_SECONDARY_TEXT,
  88                                          g_param_spec_string ("secondary-text",
  89                                                               "Secondary Text",
  90                                                               "The secondary text of the message dialog",
  91                                                               NULL,
  92                                                               G_PARAM_READWRITE));
  93         g_object_class_install_property (gobject_class,
  94                                          PROP_IMAGE,
  95                                          g_param_spec_object ("image",
  96                                                               "Image",
  97                                                               "The image",
  98                                                               GTK_TYPE_WIDGET,
  99                                                               G_PARAM_READWRITE));
 100
 101         g_type_class_add_private (gobject_class, sizeof (EvMessageAreaPrivate));
 102 }
 103
 104 static void
 105 ev_message_area_init (EvMessageArea *area)
 106 {
 107         GtkWidget *hbox, *vbox;
 108
 109         area->priv = EV_MESSAGE_AREA_GET_PRIVATE (area);
 110
 111         hbox = gtk_hbox_new (FALSE, 12);
 112         vbox = gtk_vbox_new (FALSE, 12);
 113
 114         area->priv->label = gtk_label_new (NULL);
 115         gtk_label_set_use_markup (GTK_LABEL (area->priv->label), TRUE);
 116         gtk_label_set_line_wrap (GTK_LABEL (area->priv->label), TRUE);
 117         gtk_label_set_selectable (GTK_LABEL (area->priv->label), TRUE);
 118         gtk_misc_set_alignment (GTK_MISC (area->priv->label), 0.0, 0.5);
 119         GTK_WIDGET_SET_FLAGS (area->priv->label, GTK_CAN_FOCUS);
 120         gtk_box_pack_start (GTK_BOX (vbox), area->priv->label, TRUE, TRUE, 0);
 121         gtk_widget_show (area->priv->label);
 122
 123         area->priv->secondary_label = gtk_label_new (NULL);
 124         gtk_label_set_use_markup (GTK_LABEL (area->priv->secondary_label), TRUE);
 125         gtk_label_set_line_wrap (GTK_LABEL (area->priv->secondary_label), TRUE);
 126         gtk_label_set_selectable (GTK_LABEL (area->priv->secondary_label), TRUE);
 127         gtk_misc_set_alignment (GTK_MISC (area->priv->secondary_label), 0.0, 0.5);
 128         GTK_WIDGET_SET_FLAGS (area->priv->secondary_label, GTK_CAN_FOCUS);
 129         gtk_box_pack_start (GTK_BOX (vbox), area->priv->secondary_label, TRUE, TRUE, 0);
 130
 131         area->priv->image = gtk_image_new_from_stock (NULL, GTK_ICON_SIZE_DIALOG);
 132         gtk_misc_set_alignment (GTK_MISC (area->priv->image), 0.5, 0.0);
 133         gtk_box_pack_start (GTK_BOX (hbox), area->priv->image, FALSE, FALSE, 0);
 134         gtk_widget_show (area->priv->image);
 135
 136         gtk_box_pack_start (GTK_BOX (hbox), vbox, TRUE, TRUE, 0);
 137         gtk_widget_show (vbox);
 138
 139         gedit_message_area_set_contents (GEDIT_MESSAGE_AREA (area), hbox);
 140         gtk_widget_show (hbox);
 141 }
 142
 143 static void
 144 ev_message_area_set_image_for_type (EvMessageArea *area,
 145                                     GtkMessageType type)
 146 {
 147         const gchar *stock_id = NULL;
 148         AtkObject   *atk_obj;
 149
 150         switch (type) {
 151         case GTK_MESSAGE_INFO:
 152                 stock_id = GTK_STOCK_DIALOG_INFO;
 153                 break;
 154         case GTK_MESSAGE_QUESTION:
 155                 stock_id = GTK_STOCK_DIALOG_QUESTION;
 156                 break;
 157         case GTK_MESSAGE_WARNING:
 158                 stock_id = GTK_STOCK_DIALOG_WARNING;
 159                 break;
 160         case GTK_MESSAGE_ERROR:
 161                 stock_id = GTK_STOCK_DIALOG_ERROR;
 162                 break;
 163         case GTK_MESSAGE_OTHER:
 164                 break;
 165         default:
 166                 g_warning ("Unknown GtkMessageType %u", type);
 167                 break;
 168         }
 169
 170         if (stock_id)
 171                 gtk_image_set_from_stock (GTK_IMAGE (area->priv->image), stock_id,
 172                                           GTK_ICON_SIZE_DIALOG);
 173
 174         atk_obj = gtk_widget_get_accessible (GTK_WIDGET (area));
 175         if (GTK_IS_ACCESSIBLE (atk_obj)) {
 176                 atk_object_set_role (atk_obj, ATK_ROLE_ALERT);
 177                 if (stock_id) {
 178                         GtkStockItem item;
 179
 180                         gtk_stock_lookup (stock_id, &item);
 181                         atk_object_set_name (atk_obj, item.label);
 182                 }
 183         }
 184 }
 185
 186 static void
 187 ev_message_area_set_property (GObject      *object,
 188                               guint         prop_id,
 189                               const GValue *value,
 190                               GParamSpec   *pspec)
 191 {
 192         EvMessageArea *area = EV_MESSAGE_AREA (object);
 193
 194         switch (prop_id) {
 195         case PROP_MESSAGE_TYPE:
 196                 area->priv->message_type = g_value_get_enum (value);
 197                 ev_message_area_set_image_for_type (area, area->priv->message_type);
 198                 break;
 199         case PROP_TEXT:
 200                 ev_message_area_set_text (area, g_value_get_string (value));
 201                 break;
 202         case PROP_SECONDARY_TEXT:
 203                 ev_message_area_set_secondary_text (area, g_value_get_string (value));
 204                 break;
 205         case PROP_IMAGE:
 206                 ev_message_area_set_image (area, (GtkWidget *)g_value_get_object (value));
 207                 break;
 208         default:
 209                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 210                 break;
 211         }
 212 }
 213
 214 static void
 215 ev_message_area_get_property (GObject     *object,
 216                               guint        prop_id,
 217                               GValue      *value,
 218                               GParamSpec  *pspec)
 219 {
 220         EvMessageArea *area = EV_MESSAGE_AREA (object);
 221
 222         switch (prop_id) {
 223         case PROP_MESSAGE_TYPE:
 224                 g_value_set_enum (value, (GtkMessageType) area->priv->message_type);
 225                 break;
 226         case PROP_TEXT:
 227                 g_value_set_string (value, gtk_label_get_label (GTK_LABEL (area->priv->label)));
 228                 break;
 229         case PROP_SECONDARY_TEXT:
 230                 g_value_set_string (value, gtk_label_get_label (GTK_LABEL (area->priv->secondary_label)));
 231                 break;
 232         case PROP_IMAGE:
 233                 g_value_set_object (value, area->priv->image);
 234                 break;
 235         default:
 236                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 237                 break;
 238         }
 239 }
 240
 241 GtkWidget *
 242 ev_message_area_new (GtkMessageType type,
 243                      const gchar   *text,
 244                      const gchar   *first_button_text,
 245                      ...)
 246 {
 247         GtkWidget *widget;
 248
 249         widget = g_object_new (EV_TYPE_MESSAGE_AREA,
 250                                "message-type", type,
 251                                "text", text,
 252                                NULL);
 253         if (first_button_text) {
 254                 va_list args;
 255
 256                 va_start (args, first_button_text);
 257                 gedit_message_area_add_buttons_valist (GEDIT_MESSAGE_AREA (widget),
 258                                                        first_button_text,
 259                                                        args);
 260                 va_end (args);
 261         }
 262
 263         return widget;
 264 }
 265
 266 void
 267 ev_message_area_set_image (EvMessageArea *area,
 268                            GtkWidget     *image)
 269 {
 270         GtkWidget *parent;
 271
 272         g_return_if_fail (EV_IS_MESSAGE_AREA (area));
 273
 274         area->priv->message_type = GTK_MESSAGE_OTHER;
 275
 276         parent = area->priv->image->parent;
 277         gtk_container_add (GTK_CONTAINER (parent), image);
 278         gtk_container_remove (GTK_CONTAINER (parent), area->priv->image);
 279         gtk_box_reorder_child (GTK_BOX (parent), image, 0);
 280
 281         area->priv->image = image;
 282
 283         g_object_notify (G_OBJECT (area), "image");
 284 }
 285
 286 void
 287 ev_message_area_set_text (EvMessageArea *area,
 288                           const gchar   *str)
 289 {
 290         g_return_if_fail (EV_IS_MESSAGE_AREA (area));
 291
 292         if (str) {
 293                 gchar *msg;
 294
 295                 msg = g_strdup_printf ("<b>%s</b>", str);
 296                 gtk_label_set_markup (GTK_LABEL (area->priv->label), msg);
 297                 g_free (msg);
 298         } else {
 299                 gtk_label_set_markup (GTK_LABEL (area->priv->label), NULL);
 300         }
 301
 302         g_object_notify (G_OBJECT (area), "text");
 303 }
 304
 305 void
 306 ev_message_area_set_secondary_text (EvMessageArea *area,
 307                                     const gchar   *str)
 308 {
 309         g_return_if_fail (EV_IS_MESSAGE_AREA (area));
 310
 311         if (str) {
 312                 gchar *msg;
 313
 314                 msg = g_strdup_printf ("<small>%s</small>", str);
 315                 gtk_label_set_markup (GTK_LABEL (area->priv->secondary_label), msg);
 316                 g_free (msg);
 317                 gtk_widget_show (area->priv->secondary_label);
 318         } else {
 319                 gtk_label_set_markup (GTK_LABEL (area->priv->secondary_label), NULL);
 320                 gtk_widget_hide (area->priv->secondary_label);
 321         }
 322
 323         g_object_notify (G_OBJECT (area), "secondary-text");
 324 }