vcs.maemo.org Git - hildon/blob - src/hildon-bread-crumb-widget.c

   1 /*
   2  * This file is a part of hildon
   3  *
   4  * Copyright (C) 2007 Nokia Corporation, all rights reserved.
   5  *
   6  * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
   7  * Author: Xan Lopez <xan.lopez@nokia.com>
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; version 2.1 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This library 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  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  22  * 02110-1301 USA
  23  *
  24  */
  25
  26 #include "hildon-bread-crumb-widget.h"
  27 #include "hildon-defines.h"
  28
  29 #define HILDON_BREAD_CRUMB_WIDGET_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), HILDON_TYPE_BREAD_CRUMB_WIDGET, HildonBreadCrumbWidgetPrivate))
  30
  31 struct _HildonBreadCrumbWidgetPrivate
  32 {
  33   GtkWidget *hbox;
  34   GtkWidget *label;
  35   GtkWidget *icon;
  36   GtkWidget *arrow;
  37   gchar *text;
  38
  39   GtkPositionType icon_position;
  40   gboolean constructed;
  41   gboolean show_separator;
  42 };
  43
  44 /* Signals */
  45
  46 enum {
  47   LAST_SIGNAL
  48 };
  49
  50 /* Properties */
  51
  52 enum {
  53   PROP_0,
  54   PROP_TEXT,
  55   PROP_ICON,
  56   PROP_ICON_POSITION,
  57   PROP_SHOW_SEPARATOR
  58 };
  59
  60 /*
  61 static guint bread_crumb_item_signals[LAST_SIGNAL] = { 0 };
  62 */
  63
  64 /* GType methods */
  65
  66 static void hildon_bread_crumb_widget_finalize (GObject *object);
  67 static void hildon_bread_crumb_widget_set_property (GObject *object, guint prop_id,
  68                                              const GValue *value, GParamSpec *pspec);
  69 static void hildon_bread_crumb_widget_get_property (GObject *object, guint prop_id,
  70                                              GValue *value, GParamSpec *pspec);
  71 static GObject* hildon_bread_crumb_widget_constructor (GType                  type,
  72                                                        guint                  n_construct_properties,
  73                                                        GObjectConstructParam *construct_params);
  74 static void hildon_bread_crumb_widget_set_contents (HildonBreadCrumbWidget *bread_crumb);
  75
  76 static void hildon_bread_crumb_widget_clicked (GtkButton *button);
  77
  78 static void hildon_bread_crumb_widget_bread_crumb_init (HildonBreadCrumbIface *iface);
  79
  80 static void hildon_bread_crumb_widget_get_natural_size (HildonBreadCrumb *bread_crumb,
  81                                                         gint *width,
  82                                                         gint *height);
  83
  84 G_DEFINE_TYPE_WITH_CODE (HildonBreadCrumbWidget, hildon_bread_crumb_widget, GTK_TYPE_BUTTON,
  85                          G_IMPLEMENT_INTERFACE (HILDON_TYPE_BREAD_CRUMB,
  86                                                 hildon_bread_crumb_widget_bread_crumb_init))
  87
  88 static void
  89 hildon_bread_crumb_widget_class_init (HildonBreadCrumbWidgetClass *klass)
  90 {
  91   GObjectClass *gobject_class = (GObjectClass*)klass;
  92   GtkButtonClass *button_class = (GtkButtonClass*)klass;
  93
  94     /* GObject signals */
  95   gobject_class->constructor = hildon_bread_crumb_widget_constructor;
  96   gobject_class->finalize = hildon_bread_crumb_widget_finalize;
  97   gobject_class->set_property = hildon_bread_crumb_widget_set_property;
  98   gobject_class->get_property = hildon_bread_crumb_widget_get_property;
  99
 100   /* GtkButton signals */
 101   button_class->clicked = hildon_bread_crumb_widget_clicked;
 102
 103   /* Properties */
 104   g_object_class_install_property (gobject_class,
 105                                    PROP_TEXT,
 106                                    g_param_spec_string ("text",
 107                                                         "Text",
 108                                                         "Text of the label widget inside the bread crumb",
 109                                                         NULL,
 110                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 111
 112   g_object_class_install_property (gobject_class,
 113                                    PROP_ICON,
 114                                    g_param_spec_object ("icon",
 115                                                         "Icon",
 116                                                         "Image that will appear next to the bread crumb text",
 117                                                         GTK_TYPE_WIDGET,
 118                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 119
 120   g_object_class_install_property (gobject_class,
 121                                    PROP_ICON_POSITION,
 122                                    g_param_spec_enum ("icon-position",
 123                                                       "Icon position",
 124                                                       "The position of the image relative to the text",
 125                                                       GTK_TYPE_POSITION_TYPE,
 126                                                       GTK_POS_LEFT,
 127                                                       G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 128
 129   g_object_class_install_property (gobject_class,
 130                                    PROP_SHOW_SEPARATOR,
 131                                    g_param_spec_boolean ("show-separator",
 132                                                          "Show separator",
 133                                                          "Show the separator attached to the item",
 134                                                          TRUE,
 135                                                          G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 136
 137   /* Private data */
 138   g_type_class_add_private (gobject_class, sizeof (HildonBreadCrumbWidgetPrivate));
 139 }
 140
 141 static void
 142 hildon_bread_crumb_widget_bread_crumb_init (HildonBreadCrumbIface *iface)
 143 {
 144   iface->get_natural_size = hildon_bread_crumb_widget_get_natural_size;
 145 }
 146
 147 static GObject*
 148 hildon_bread_crumb_widget_constructor (GType type,
 149                                        guint n_construct_properties,
 150                                        GObjectConstructParam *construct_params)
 151 {
 152   GObject *object;
 153   HildonBreadCrumbWidget *bread_crumb;
 154   HildonBreadCrumbWidgetPrivate *priv;
 155
 156   object = (* G_OBJECT_CLASS (hildon_bread_crumb_widget_parent_class)->constructor) (type,
 157                                                                               n_construct_properties,
 158                                                                               construct_params);
 159
 160   bread_crumb = HILDON_BREAD_CRUMB_WIDGET (object);
 161   priv = bread_crumb->priv;
 162   priv->constructed = TRUE;
 163
 164   priv->hbox = gtk_hbox_new (FALSE, 6);
 165   gtk_container_add (GTK_CONTAINER (bread_crumb), priv->hbox);
 166
 167   /* Separator */
 168   priv->arrow = gtk_arrow_new (GTK_ARROW_RIGHT, GTK_SHADOW_NONE);
 169   gtk_widget_set_name (priv->arrow, "hildon-bread-crumb-separator-arrow");
 170   gtk_box_pack_start (GTK_BOX (priv->hbox), priv->arrow, FALSE, FALSE, 0);
 171
 172   if (priv->show_separator)
 173     gtk_widget_show (priv->arrow);
 174
 175   /* Contents base container */
 176   bread_crumb->contents = gtk_hbox_new (FALSE, HILDON_MARGIN_DEFAULT);
 177   gtk_container_add (GTK_CONTAINER (priv->hbox), bread_crumb->contents);
 178   gtk_widget_show (bread_crumb->contents);
 179
 180   if (priv->text || priv->icon)
 181     hildon_bread_crumb_widget_set_contents (bread_crumb);
 182
 183   /* Show everything */
 184   gtk_widget_show (priv->hbox);
 185
 186   return object;
 187 }
 188
 189 static void
 190 hildon_bread_crumb_widget_init (HildonBreadCrumbWidget *item)
 191 {
 192   HildonBreadCrumbWidgetPrivate *priv = HILDON_BREAD_CRUMB_WIDGET_GET_PRIVATE (item);
 193
 194   item->priv = priv;
 195
 196   item->contents = NULL;
 197
 198   priv->constructed = FALSE;
 199   priv->text = NULL;
 200   priv->icon = NULL;
 201   priv->icon_position = GTK_POS_LEFT;
 202   priv->show_separator = TRUE;
 203 }
 204
 205 static void
 206 hildon_bread_crumb_widget_finalize (GObject *object)
 207 {
 208   HildonBreadCrumbWidgetPrivate *priv = HILDON_BREAD_CRUMB_WIDGET (object)->priv;
 209
 210   g_free (priv->text);
 211
 212   G_OBJECT_CLASS (hildon_bread_crumb_widget_parent_class)->finalize (object);
 213 }
 214
 215 static void
 216 hildon_bread_crumb_widget_clicked (GtkButton *button)
 217 {
 218   hildon_bread_crumb_activated (HILDON_BREAD_CRUMB (button));
 219 }
 220
 221 static void
 222 hildon_bread_crumb_widget_set_contents (HildonBreadCrumbWidget *bread_crumb)
 223 {
 224   GtkWidget *icon = NULL;
 225   HildonBreadCrumbWidgetPrivate *priv = bread_crumb->priv;
 226
 227   if (!priv->constructed)
 228     return;
 229
 230   if (!priv->text && !priv->icon)
 231     return;
 232
 233   /* If the icon exists, keep it */
 234   if (priv->icon)
 235     {
 236       icon = g_object_ref (priv->icon);
 237       if (icon->parent)
 238         gtk_container_remove (GTK_CONTAINER (icon->parent), icon);
 239       priv->icon = NULL;
 240     }
 241
 242   /* Reset contents */
 243   if (bread_crumb->contents)
 244     gtk_container_remove (GTK_CONTAINER (priv->hbox),
 245                           bread_crumb->contents);
 246
 247   if (icon)
 248     {
 249       priv->icon = icon;
 250       if (priv->icon_position == GTK_POS_LEFT ||
 251           priv->icon_position == GTK_POS_RIGHT)
 252           bread_crumb->contents = gtk_hbox_new (FALSE, HILDON_MARGIN_DEFAULT);
 253       else
 254           bread_crumb->contents = gtk_vbox_new (FALSE, HILDON_MARGIN_DEFAULT);
 255
 256       if (priv->icon_position == GTK_POS_LEFT ||
 257           priv->icon_position == GTK_POS_TOP)
 258         gtk_box_pack_start (GTK_BOX (bread_crumb->contents), priv->icon,
 259                             FALSE, FALSE, 0);
 260       else
 261         gtk_box_pack_end (GTK_BOX (bread_crumb->contents), priv->icon,
 262                           FALSE, FALSE, 0);
 263
 264       if (priv->text)
 265         {
 266           priv->label = gtk_label_new (priv->text);
 267           gtk_label_set_ellipsize (GTK_LABEL (priv->label),
 268                                    PANGO_ELLIPSIZE_END);
 269
 270           if (priv->icon_position == GTK_POS_RIGHT ||
 271               priv->icon_position == GTK_POS_BOTTOM)
 272             gtk_box_pack_start (GTK_BOX (bread_crumb->contents), priv->label,
 273                                 TRUE, TRUE, 0);
 274           else
 275             gtk_box_pack_end (GTK_BOX (bread_crumb->contents), priv->label,
 276                               TRUE, TRUE, 0);
 277
 278         }
 279
 280       gtk_box_pack_start (GTK_BOX (priv->hbox), bread_crumb->contents,
 281                           TRUE, TRUE, 0);
 282       gtk_widget_show_all (bread_crumb->contents);
 283
 284       g_object_unref (icon);
 285     }
 286   else
 287     {
 288       /* Only text */
 289       bread_crumb->contents = gtk_hbox_new (FALSE, 0);
 290       gtk_box_pack_start (GTK_BOX (priv->hbox), bread_crumb->contents,
 291                           TRUE, TRUE, 0);
 292
 293       priv->label = gtk_label_new (priv->text);
 294       gtk_label_set_ellipsize (GTK_LABEL (priv->label),
 295                                PANGO_ELLIPSIZE_END);
 296       gtk_box_pack_start (GTK_BOX (bread_crumb->contents), priv->label, TRUE, TRUE, 0);
 297
 298       gtk_widget_show_all (bread_crumb->contents);
 299     }
 300 }
 301
 302 static void
 303 hildon_bread_crumb_widget_set_property (GObject *object, guint prop_id,
 304                                         const GValue *value, GParamSpec *pspec)
 305 {
 306   HildonBreadCrumbWidget *item = HILDON_BREAD_CRUMB_WIDGET (object);
 307
 308   switch (prop_id)
 309     {
 310     case PROP_TEXT:
 311       _hildon_bread_crumb_widget_set_text (item, g_value_get_string (value));
 312       break;
 313     case PROP_ICON:
 314       _hildon_bread_crumb_widget_set_icon (item, (GtkWidget*)g_value_get_object (value));
 315       break;
 316     case PROP_ICON_POSITION:
 317       _hildon_bread_crumb_widget_set_icon_position (item, g_value_get_enum (value));
 318       break;
 319     case PROP_SHOW_SEPARATOR:
 320       _hildon_bread_crumb_widget_set_show_separator (item, g_value_get_boolean (value));
 321       break;
 322     default:
 323       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 324       break;
 325     }
 326 }
 327
 328 static void
 329 hildon_bread_crumb_widget_get_property (GObject *object, guint prop_id,
 330                                         GValue *value, GParamSpec *pspec)
 331 {
 332   HildonBreadCrumbWidget *item = HILDON_BREAD_CRUMB_WIDGET (object);
 333
 334   switch (prop_id)
 335     {
 336     case PROP_TEXT:
 337       g_value_set_string (value, item->priv->text);
 338       break;
 339     case PROP_ICON:
 340       g_value_set_object (value, (GObject *)item->priv->icon);
 341       break;
 342     case PROP_ICON_POSITION:
 343       g_value_set_enum (value, item->priv->icon_position);
 344       break;
 345     case PROP_SHOW_SEPARATOR:
 346       g_value_set_boolean (value, item->priv->show_separator);
 347       break;
 348     default:
 349       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 350       break;
 351     }
 352 }
 353
 354 void
 355 _hildon_bread_crumb_widget_set_text (HildonBreadCrumbWidget *item,
 356                                      const gchar *text)
 357 {
 358   HildonBreadCrumbWidgetPrivate *priv;
 359
 360   g_return_if_fail (HILDON_IS_BREAD_CRUMB_WIDGET (item));
 361
 362   priv = item->priv;
 363
 364   if (priv->text)
 365     g_free (priv->text);
 366
 367   priv->text = g_strdup (text);
 368
 369   hildon_bread_crumb_widget_set_contents (item);
 370
 371   g_object_notify (G_OBJECT (item), "text");
 372 }
 373
 374 const gchar*
 375 _hildon_bread_crumb_widget_get_text (HildonBreadCrumbWidget *item)
 376 {
 377   HildonBreadCrumbWidgetPrivate *priv;
 378
 379   g_return_val_if_fail (HILDON_IS_BREAD_CRUMB_WIDGET (item), NULL);
 380
 381   priv = item->priv;
 382
 383   return priv->text;
 384 }
 385
 386 void
 387 _hildon_bread_crumb_widget_set_show_separator (HildonBreadCrumbWidget *item,
 388                                                gboolean show_separator)
 389 {
 390   HildonBreadCrumbWidgetPrivate *priv;
 391
 392   g_return_if_fail (HILDON_IS_BREAD_CRUMB_WIDGET (item));
 393
 394   priv = item->priv;
 395
 396   if (priv->show_separator == show_separator)
 397     return;
 398
 399   priv->show_separator = show_separator;
 400
 401   if (!priv->constructed)
 402     return;
 403
 404   if (show_separator)
 405     gtk_widget_show (priv->arrow);
 406   else
 407     gtk_widget_hide (priv->arrow);
 408
 409   g_object_notify (G_OBJECT (item), "show-separator");
 410 }
 411
 412 static void
 413 hildon_bread_crumb_widget_get_natural_size (HildonBreadCrumb *bread_crumb,
 414                                             gint *natural_width,
 415                                             gint *natural_height)
 416 {
 417   GtkRequisition widget_req, label_req;
 418   gint width, height;
 419   PangoLayout *layout;
 420   HildonBreadCrumbWidget *item;
 421   HildonBreadCrumbWidgetPrivate *priv;
 422
 423   g_return_if_fail (HILDON_IS_BREAD_CRUMB_WIDGET (bread_crumb));
 424
 425   item = HILDON_BREAD_CRUMB_WIDGET (bread_crumb);
 426   priv = item->priv;
 427
 428   gtk_widget_size_request (GTK_WIDGET (item), &widget_req);
 429
 430   layout = gtk_widget_create_pango_layout (priv->label, priv->text);
 431   pango_layout_get_pixel_size (layout, &width, &height);
 432   g_object_unref (layout);
 433
 434   if (natural_width)
 435     {
 436       *natural_width = widget_req.width;
 437       /* Substract the size request of the label */
 438       gtk_widget_size_request (priv->label, &label_req);
 439       *natural_width -= label_req.width;
 440
 441       /* Add the "natural" width for the label */
 442       *natural_width += width;
 443       *natural_width += GTK_CONTAINER (item)->border_width * 2;
 444     }
 445
 446   if (natural_height)
 447     {
 448       *natural_height = widget_req.height;
 449       *natural_height += GTK_CONTAINER (item)->border_width * 2;
 450     }
 451 }
 452
 453 GtkWidget*
 454 _hildon_bread_crumb_widget_new ()
 455 {
 456   return GTK_WIDGET (g_object_new (HILDON_TYPE_BREAD_CRUMB_WIDGET, NULL));
 457 }
 458
 459 GtkWidget*
 460 _hildon_bread_crumb_widget_new_with_text (const gchar *text)
 461 {
 462   return GTK_WIDGET (g_object_new (HILDON_TYPE_BREAD_CRUMB_WIDGET,
 463                                    "text", text,
 464                                    NULL));
 465 }
 466
 467 GtkWidget*
 468 _hildon_bread_crumb_widget_new_with_icon (GtkWidget *icon, const gchar *text)
 469 {
 470   return GTK_WIDGET (g_object_new (HILDON_TYPE_BREAD_CRUMB_WIDGET,
 471                                    "icon", icon,
 472                                    "text", text,
 473                                    NULL));
 474 }
 475
 476 void
 477 _hildon_bread_crumb_widget_set_icon (HildonBreadCrumbWidget *bread_crumb,
 478                                      GtkWidget *icon)
 479 {
 480   HildonBreadCrumbWidgetPrivate *priv;
 481
 482   g_return_if_fail (HILDON_IS_BREAD_CRUMB_WIDGET (bread_crumb));
 483
 484   priv = bread_crumb->priv;
 485
 486   priv->icon = icon;
 487
 488   hildon_bread_crumb_widget_set_contents (bread_crumb);
 489
 490   g_object_notify (G_OBJECT (bread_crumb), "icon");
 491 }
 492
 493 void
 494 _hildon_bread_crumb_widget_set_icon_position (HildonBreadCrumbWidget *bread_crumb,
 495                                               GtkPositionType icon_position)
 496 {
 497   HildonBreadCrumbWidgetPrivate *priv;
 498
 499   g_return_if_fail (HILDON_IS_BREAD_CRUMB_WIDGET (bread_crumb));
 500
 501   priv = bread_crumb->priv;
 502
 503   if (priv->icon_position == icon_position)
 504     return;
 505
 506   priv->icon_position = icon_position;
 507
 508   hildon_bread_crumb_widget_set_contents (bread_crumb);
 509
 510   g_object_notify (G_OBJECT (bread_crumb), "icon-position");
 511 }