2 * This file is a part of hildon
4 * Copyright (C) 2007 Nokia Corporation, all rights reserved.
6 * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
7 * Author: Xan Lopez <xan.lopez@nokia.com>
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.
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.
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
28 * SECTION:hildon-bread-crumb-trail
29 * @short_description: Widget used to represent a specific path in a hierarchical tree.
32 * HildonBreadCrumbTrail is a GTK widget used to represent the currently active path in
33 * some kind of hierarchical structure (file system, media library, structured document, etc).
35 * It has built-in support for text and icon bread crumbs, but the trail only requires a very
36 * simple interface to be implemented for its children and thus new types of items can be
37 * implemented if needed. See #HildonBreadCrumb for more details.
40 #include "hildon-marshalers.h"
41 #include "hildon-bread-crumb-trail.h"
42 #include "hildon-bread-crumb-widget.h"
44 #define HILDON_BREAD_CRUMB_TRAIL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrailPrivate))
46 struct _HildonBreadCrumbTrailPrivate
48 GtkWidget *back_button;
65 static void hildon_bread_crumb_trail_size_request (GtkWidget *widget,
66 GtkRequisition *requisition);
67 static void hildon_bread_crumb_trail_size_allocate (GtkWidget *widget,
68 GtkAllocation *allocation);
69 static void hildon_bread_crumb_trail_add (GtkContainer *container,
71 static void hildon_bread_crumb_trail_forall (GtkContainer *container,
72 gboolean include_internals,
74 gpointer callback_data);
75 static void hildon_bread_crumb_trail_remove (GtkContainer *container,
77 static void hildon_bread_crumb_trail_finalize (GObject *object);
78 static void hildon_bread_crumb_trail_scroll_back (GtkWidget *button,
79 HildonBreadCrumbTrail *bct);
80 static void hildon_bread_crumb_trail_update_back_button_sensitivity (HildonBreadCrumbTrail *bct);
82 static guint bread_crumb_trail_signals[LAST_SIGNAL] = { 0 };
86 G_DEFINE_TYPE (HildonBreadCrumbTrail, hildon_bread_crumb_trail, GTK_TYPE_CONTAINER)
89 hildon_bread_crumb_trail_class_init (HildonBreadCrumbTrailClass *klass)
91 GObjectClass *gobject_class = (GObjectClass*)klass;
92 GtkObjectClass *object_class = (GtkObjectClass*)klass;
93 GtkWidgetClass *widget_class = (GtkWidgetClass*)klass;
94 GtkContainerClass *container_class = (GtkContainerClass*)klass;
97 gobject_class->finalize = hildon_bread_crumb_trail_finalize;
99 /* GtkWidget signals */
100 widget_class->size_request = hildon_bread_crumb_trail_size_request;
101 widget_class->size_allocate = hildon_bread_crumb_trail_size_allocate;
103 /* GtkContainer signals */
104 container_class->add = hildon_bread_crumb_trail_add;
105 container_class->forall = hildon_bread_crumb_trail_forall;
106 container_class->remove = hildon_bread_crumb_trail_remove;
108 /* Style properties */
110 #define _BREAD_CRUMB_TRAIL_MINIMUM_WIDTH 10
112 /* FIXME: is this the best way to do it? */
113 gtk_widget_class_install_style_property (widget_class,
114 g_param_spec_int ("minimum-width",
116 "The minimum width in characters the children widgets will request",
119 _BREAD_CRUMB_TRAIL_MINIMUM_WIDTH,
122 #define _BREAD_CRUMB_TRAIL_ARROW_SIZE 34
124 gtk_widget_class_install_style_property (widget_class,
125 g_param_spec_int ("arrow-size",
127 "Size of the back button arrow",
130 _BREAD_CRUMB_TRAIL_ARROW_SIZE,
133 bread_crumb_trail_signals[CRUMB_CLICKED] =
134 g_signal_new ("crumb-clicked",
135 G_OBJECT_CLASS_TYPE (object_class),
137 G_STRUCT_OFFSET (HildonBreadCrumbTrailClass, crumb_clicked),
138 g_signal_accumulator_true_handled, NULL,
139 _hildon_marshal_BOOLEAN__POINTER,
144 g_type_class_add_private (gobject_class, sizeof (HildonBreadCrumbTrailPrivate));
148 hildon_bread_crumb_trail_finalize (GObject *object)
150 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (object)->priv;
152 g_list_free (priv->item_list);
154 G_OBJECT_CLASS (hildon_bread_crumb_trail_parent_class)->finalize (object);
158 hildon_bread_crumb_trail_size_request (GtkWidget *widget,
159 GtkRequisition *requisition)
162 GtkRequisition child_requisition;
163 HildonBreadCrumbTrail *bct;
164 HildonBreadCrumbTrailPrivate *priv;
165 gint minimum_width, width = 0;
169 bct= HILDON_BREAD_CRUMB_TRAIL (widget);
172 requisition->height = 0;
173 requisition->width = 0;
175 gtk_widget_size_request (priv->back_button, &child_requisition);
176 requisition->width = child_requisition.width;
177 requisition->height = child_requisition.height;
181 /* Add minimum width for one item */
182 /* TODO: this can be probably cached */
183 gtk_widget_style_get (widget,
184 "minimum-width", &minimum_width,
187 tmp = g_strnfill ((gsize)minimum_width, 'm');
188 layout = gtk_widget_create_pango_layout (widget, tmp);
190 pango_layout_get_size (layout, &width, NULL);
191 requisition->width += PANGO_PIXELS (width);
192 g_object_unref (layout);
195 /* Button requisitions */
196 for (p = priv->item_list; p; p = p->next)
198 GtkWidget *child = GTK_WIDGET (p->data);
200 if (GTK_WIDGET_VISIBLE (child))
201 gtk_widget_size_request (child, &child_requisition);
205 requisition->width += GTK_CONTAINER (widget)->border_width * 2;
206 requisition->height += GTK_CONTAINER (widget)->border_width * 2;
208 widget->requisition = *requisition;
211 /* Document me please */
214 hildon_bread_crumb_trail_size_allocate (GtkWidget *widget,
215 GtkAllocation *allocation)
218 gint natural_width, natural_height;
219 HildonBreadCrumb *item;
220 GtkAllocation child_allocation;
221 GtkRequisition child_requisition;
223 gint allocation_width;
224 gint border_width, width;
226 GList *p, *first_show, *first_hide;
227 gint back_button_size;
228 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (widget)->priv;
230 widget->allocation = *allocation;
232 border_width = (gint) GTK_CONTAINER (widget)->border_width;
233 allocation_width = allocation->width - 2 * border_width;
235 /* Allocate the back button */
236 child_allocation.x = allocation->x + border_width;
237 child_allocation.y = allocation->y + border_width;
238 gtk_widget_get_child_requisition (priv->back_button, &child_requisition);
239 /* We want the back button to be a square */
240 back_button_size = MAX (child_requisition.width, child_requisition.height);
241 child_allocation.width = child_allocation.height = back_button_size;
242 gtk_widget_size_allocate (priv->back_button, &child_allocation);
243 child_allocation.x += back_button_size;
245 /* If there are no buttons there's nothing else to do */
246 if (priv->item_list == NULL)
249 /* We find out how many buttons can we show, starting from the
250 the last one in the logical path (the first item in the list) */
252 width = back_button_size;
258 for (p = priv->item_list; p; p = p->next)
260 item = HILDON_BREAD_CRUMB (p->data);
261 child = GTK_WIDGET (item);
263 /* Does the widget fit with its natural size? */
264 hildon_bread_crumb_get_natural_size (item,
268 if (width + natural_width <= allocation_width)
272 first_hide = p->next;
273 width += natural_width;
277 /* No, it doesn't. Allocate as much as possible
279 child_allocation.width = allocation_width - width;
281 gtk_widget_size_request (child, &req);
283 if (child_allocation.width > req.width)
285 first_hide = p->next;
286 gtk_widget_size_allocate (child, &child_allocation);
287 gtk_widget_show (child);
288 gtk_widget_set_child_visible (child, TRUE);
289 child_allocation.x += child_allocation.width;
293 extra_space = child_allocation.width;
300 /* Not enough items to fill the breadcrumb? */
301 if (p == NULL && width < allocation_width)
303 extra_space = allocation_width - width;
306 /* Allocate the other buttons */
307 for (p = first_show; p; p = p->prev)
309 item = HILDON_BREAD_CRUMB (p->data);
310 child = GTK_WIDGET (item);
312 /* Does the widget fit with its natural size? */
313 hildon_bread_crumb_get_natural_size (item,
317 /* If I'm the last and there's extra space, use it */
318 if (p->prev == NULL && extra_space != 0)
320 natural_width += extra_space;
323 child_allocation.width = natural_width;
324 gtk_widget_size_allocate (child, &child_allocation);
325 gtk_widget_show (child);
326 gtk_widget_set_child_visible (child, TRUE);
327 child_allocation.x += child_allocation.width;
330 for (p = first_hide; p; p = p->next)
332 item = HILDON_BREAD_CRUMB (p->data);
333 child = GTK_WIDGET (item);
335 gtk_widget_hide (GTK_WIDGET (item));
336 gtk_widget_set_child_visible (GTK_WIDGET (item), FALSE);
341 get_bread_crumb_id (HildonBreadCrumb *item)
343 return g_object_get_data (G_OBJECT (item), "bread-crumb-id");
347 crumb_activated_cb (GtkWidget *button,
348 HildonBreadCrumbTrail *bct)
350 gboolean signal_handled = FALSE;
352 g_signal_emit (bct, bread_crumb_trail_signals[CRUMB_CLICKED], 0,
353 get_bread_crumb_id (HILDON_BREAD_CRUMB (button)),
356 if (signal_handled == FALSE)
359 HildonBreadCrumbTrailPrivate *priv;
363 child = GTK_WIDGET (priv->item_list->data);
365 /* We remove the tip of the list until we hit the clicked button */
366 while (child != button)
368 gtk_container_remove (GTK_CONTAINER (bct), child);
370 child = GTK_WIDGET (priv->item_list->data);
376 hildon_bread_crumb_trail_add (GtkContainer *container,
379 gtk_widget_set_parent (widget, GTK_WIDGET (container));
381 if (HILDON_IS_BREAD_CRUMB (widget))
383 HildonBreadCrumbTrail *bct = HILDON_BREAD_CRUMB_TRAIL (container);
385 g_signal_connect (G_OBJECT (widget), "crumb-activated",
386 G_CALLBACK (crumb_activated_cb), container);
388 bct->priv->item_list = g_list_prepend (bct->priv->item_list, widget);
390 hildon_bread_crumb_trail_update_back_button_sensitivity (bct);
395 hildon_bread_crumb_trail_forall (GtkContainer *container,
396 gboolean include_internals,
397 GtkCallback callback,
398 gpointer callback_data)
400 g_return_if_fail (callback != NULL);
401 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (container));
404 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (container)->priv;
406 children = priv->item_list;
411 child = GTK_WIDGET (children->data);
412 children = children->next;
414 (*callback) (child, callback_data);
417 if (include_internals && priv->back_button)
419 (*callback) (priv->back_button, callback_data);
424 hildon_bread_crumb_trail_remove (GtkContainer *container,
428 HildonBreadCrumbTrailPrivate *priv;
429 gboolean was_visible = GTK_WIDGET_VISIBLE (widget);
431 priv = HILDON_BREAD_CRUMB_TRAIL (container)->priv;
437 if (widget == GTK_WIDGET (p->data))
439 g_signal_handlers_disconnect_by_func (widget, G_CALLBACK (crumb_activated_cb),
440 HILDON_BREAD_CRUMB_TRAIL (container));
441 gtk_widget_unparent (widget);
443 priv->item_list = g_list_remove_link (priv->item_list, p);
446 hildon_bread_crumb_trail_update_back_button_sensitivity (HILDON_BREAD_CRUMB_TRAIL (container));
450 gtk_widget_queue_resize (GTK_WIDGET (container));
459 hildon_bread_crumb_trail_update_back_button_sensitivity (HildonBreadCrumbTrail *bct)
462 HildonBreadCrumbTrailPrivate *priv = bct->priv;
464 list_length = g_list_length (priv->item_list);
466 if (list_length == 0 || list_length == 1)
468 gtk_widget_set_sensitive (priv->back_button, FALSE);
472 gtk_widget_set_sensitive (priv->back_button, TRUE);
477 create_back_button (HildonBreadCrumbTrail *bct)
483 gtk_widget_push_composite_child ();
485 button = gtk_button_new ();
486 gtk_widget_set_name (button, "hildon-bread-crumb-back-button");
487 gtk_widget_set_sensitive (button, FALSE);
489 arrow = gtk_arrow_new (GTK_ARROW_LEFT, GTK_SHADOW_NONE);
490 gtk_widget_style_get (GTK_WIDGET (bct),
491 "arrow-size", &arrow_size,
493 gtk_widget_set_size_request (arrow, arrow_size, arrow_size);
495 gtk_container_add (GTK_CONTAINER (button), arrow);
496 gtk_container_add (GTK_CONTAINER (bct), button);
497 gtk_widget_show_all (button);
499 gtk_widget_pop_composite_child ();
505 hildon_bread_crumb_trail_init (HildonBreadCrumbTrail *bct)
507 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL_GET_PRIVATE (bct);
509 GTK_WIDGET_SET_FLAGS (bct, GTK_NO_WINDOW);
510 gtk_widget_set_redraw_on_allocate (GTK_WIDGET (bct), FALSE);
513 priv->item_list = NULL;
515 priv->back_button = create_back_button (bct);
516 g_signal_connect (priv->back_button, "clicked",
517 G_CALLBACK (hildon_bread_crumb_trail_scroll_back),
522 hildon_bread_crumb_trail_scroll_back (GtkWidget *button,
523 HildonBreadCrumbTrail *bct)
525 HildonBreadCrumb *item;
527 hildon_bread_crumb_trail_pop (bct);
529 item = HILDON_BREAD_CRUMB (bct->priv->item_list->data);
531 g_signal_emit (bct, bread_crumb_trail_signals[CRUMB_CLICKED], 0,
532 get_bread_crumb_id (item));
536 attach_bread_crumb (HildonBreadCrumbTrail *bct,
537 GtkWidget *bread_crumb,
539 GDestroyNotify destroy)
541 g_object_set_data_full (G_OBJECT (bread_crumb), "bread-crumb-id", id, destroy);
543 gtk_container_add (GTK_CONTAINER (bct), bread_crumb);
545 gtk_widget_show (bread_crumb);
551 * hildon_bread_crumb_trail_new:
553 * Creates a new #HildonBreadCrumbTrail widget.
555 * Returns: a #GtkWidget pointer of newly created bread crumb trail
558 * Stability: Unstable
562 hildon_bread_crumb_trail_new (void)
564 return GTK_WIDGET (g_object_new (HILDON_TYPE_BREAD_CRUMB_TRAIL, NULL));
568 * hildon_bread_crumb_trail_push:
569 * @bct: pointer to #HildonBreadCrumbTrail
570 * @item: the #HildonBreadCrumb to be added to the trail
571 * @id: optional id for the bread crumb
572 * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed
574 * Adds a new bread crumb to the end of the trail.
576 * Stability: Unstable
580 hildon_bread_crumb_trail_push (HildonBreadCrumbTrail *bct,
581 HildonBreadCrumb *item,
583 GDestroyNotify destroy)
587 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
588 g_return_if_fail (HILDON_IS_BREAD_CRUMB (item));
590 widget = GTK_WIDGET (item);
592 attach_bread_crumb (bct, widget, id, destroy);
596 * hildon_bread_crumb_trail_push_text:
597 * @bct: pointer to #HildonBreadCrumbTrail
598 * @text: content of the new bread crumb
599 * @id: optional id for the bread crumb
600 * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed
602 * Adds a new bread crumb to the end of the trail containing the specified text.
604 * Stability: Unstable
608 hildon_bread_crumb_trail_push_text (HildonBreadCrumbTrail *bct,
611 GDestroyNotify destroy)
615 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
616 g_return_if_fail (text != NULL);
618 widget = _hildon_bread_crumb_widget_new_with_text (text);
619 attach_bread_crumb (bct, widget, id, destroy);
623 * hildon_bread_crumb_trail_push_text:
624 * @bct: pointer to #HildonBreadCrumbTrail
625 * @text: content of the new bread crumb
626 * @icon: a widget to set as the icon in the bread crumb
627 * @id: optional id for the bread crumb
628 * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed
630 * Adds a new bread crumb to the end of the trail containing the specified text and
633 * Stability: Unstable
637 hildon_bread_crumb_trail_push_icon (HildonBreadCrumbTrail *bct,
641 GDestroyNotify destroy)
645 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
646 g_return_if_fail (text != NULL);
647 g_return_if_fail (GTK_IS_WIDGET (icon));
649 widget = _hildon_bread_crumb_widget_new_with_icon (icon, text);
650 attach_bread_crumb (bct, widget, id, destroy);
654 * hildon_bread_crumb_trail_pop:
655 * @bct: pointer to #HildonBreadCrumbTrail
657 * Removes the last bread crumb from the trail.
659 * Stability: Unstable
663 hildon_bread_crumb_trail_pop (HildonBreadCrumbTrail *bct)
666 HildonBreadCrumbTrailPrivate *priv;
668 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
672 if (priv->item_list == NULL)
677 child = GTK_WIDGET (priv->item_list->data);
678 gtk_container_remove (GTK_CONTAINER (bct), child);
681 hildon_bread_crumb_trail_update_back_button_sensitivity (bct);
685 * hildon_bread_crumb_trail_clear:
686 * @bct: pointer to #HildonBreadCrumbTrail
688 * Removes all the bread crumbs from the bread crumb trail.
690 * Stability: Unstable
694 hildon_bread_crumb_trail_clear (HildonBreadCrumbTrail *bct)
696 HildonBreadCrumbTrailPrivate *priv;
698 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
702 while (priv->item_list)
704 hildon_bread_crumb_trail_pop (bct);