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
26 #include "hildon-bread-crumb-trail.h"
28 #define HILDON_BREAD_CRUMB_TRAIL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrailPrivate))
30 struct _HildonBreadCrumbTrailPrivate
32 GtkWidget *back_button;
34 gchar *path_separator;
50 static void hildon_bread_crumb_trail_size_request (GtkWidget *widget,
51 GtkRequisition *requisition);
52 static void hildon_bread_crumb_trail_size_allocate (GtkWidget *widget,
53 GtkAllocation *allocation);
54 static void hildon_bread_crumb_trail_add (GtkContainer *container,
56 static void hildon_bread_crumb_trail_forall (GtkContainer *container,
57 gboolean include_internals,
59 gpointer callback_data);
60 static void hildon_bread_crumb_trail_remove (GtkContainer *container,
62 static void hildon_bread_crumb_trail_finalize (GObject *object);
63 static void hildon_bread_crumb_trail_scroll_back (GtkWidget *button,
64 HildonBreadCrumbTrail *bct);
65 static void hildon_bread_crumb_trail_update_back_button_sensitivity (HildonBreadCrumbTrail *bct);
67 static guint bread_crumb_trail_signals[LAST_SIGNAL] = { 0 };
71 G_DEFINE_TYPE (HildonBreadCrumbTrail, hildon_bread_crumb_trail, GTK_TYPE_CONTAINER)
74 hildon_bread_crumb_trail_class_init (HildonBreadCrumbTrailClass *klass)
76 GObjectClass *gobject_class = (GObjectClass*)klass;
77 GtkObjectClass *object_class = (GtkObjectClass*)klass;
78 GtkWidgetClass *widget_class = (GtkWidgetClass*)klass;
79 GtkContainerClass *container_class = (GtkContainerClass*)klass;
82 gobject_class->finalize = hildon_bread_crumb_trail_finalize;
84 /* GtkWidget signals */
85 widget_class->size_request = hildon_bread_crumb_trail_size_request;
86 widget_class->size_allocate = hildon_bread_crumb_trail_size_allocate;
88 /* GtkContainer signals */
89 container_class->add = hildon_bread_crumb_trail_add;
90 container_class->forall = hildon_bread_crumb_trail_forall;
91 container_class->remove = hildon_bread_crumb_trail_remove;
93 /* Style properties */
95 #define _BREAD_CRUMB_TRAIL_MINIMUM_WIDTH 10
97 /* FIXME: is this the best way to do it? */
98 gtk_widget_class_install_style_property (widget_class,
99 g_param_spec_int ("minimum-width",
101 "The minimum width in characters the children widgets will request",
104 _BREAD_CRUMB_TRAIL_MINIMUM_WIDTH,
107 #define _BREAD_CRUMB_TRAIL_MAXIMUM_WIDTH 250
109 gtk_widget_class_install_style_property (widget_class,
110 g_param_spec_int ("maximum-width",
112 "The maximum width in characters the children widgets will be allocated",
115 _BREAD_CRUMB_TRAIL_MAXIMUM_WIDTH,
118 #define _BREAD_CRUMB_TRAIL_ARROW_SIZE 34
120 gtk_widget_class_install_style_property (widget_class,
121 g_param_spec_int ("arrow-size",
123 "Size of the back button arrow",
126 _BREAD_CRUMB_TRAIL_ARROW_SIZE,
129 bread_crumb_trail_signals[CRUMB_CLICKED] =
130 g_signal_new ("crumb-clicked",
131 G_OBJECT_CLASS_TYPE (object_class),
133 G_STRUCT_OFFSET (HildonBreadCrumbTrailClass, crumb_clicked),
135 g_cclosure_marshal_VOID__POINTER,
140 g_type_class_add_private (gobject_class, sizeof (HildonBreadCrumbTrailPrivate));
144 hildon_bread_crumb_trail_finalize (GObject *object)
146 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (object)->priv;
148 g_free (priv->path_separator);
149 g_list_free (priv->item_list);
151 G_OBJECT_CLASS (hildon_bread_crumb_trail_parent_class)->finalize (object);
155 hildon_bread_crumb_trail_size_request (GtkWidget *widget,
156 GtkRequisition *requisition)
159 GtkRequisition child_requisition;
160 HildonBreadCrumbTrail *bct;
161 HildonBreadCrumbTrailPrivate *priv;
162 gint minimum_width, width = 0;
166 bct= HILDON_BREAD_CRUMB_TRAIL (widget);
169 requisition->height = 0;
170 requisition->width = 0;
172 gtk_widget_size_request (priv->back_button, &child_requisition);
173 g_debug ("BACK BUTTON REQUEST %d %d", child_requisition.width, child_requisition.width);
174 requisition->width = child_requisition.width;
175 requisition->height = child_requisition.height;
179 /* Add minimum width for one item */
180 /* TODO: this can be probably cached */
181 gtk_widget_style_get (widget,
182 "minimum-width", &minimum_width,
185 tmp = g_strnfill ((gsize)minimum_width, 'm');
186 layout = gtk_widget_create_pango_layout (widget, tmp);
188 pango_layout_get_size (layout, &width, NULL);
189 requisition->width += PANGO_PIXELS (width);
190 g_object_unref (layout);
193 /* Button requisitions */
194 for (p = priv->item_list; p; p = p->next)
196 gtk_widget_size_request (GTK_WIDGET (p->data), &child_requisition);
200 requisition->width += GTK_CONTAINER (widget)->border_width * 2;
201 requisition->height += GTK_CONTAINER (widget)->border_width * 2;
203 widget->requisition = *requisition;
206 /* Document me please */
209 hildon_bread_crumb_trail_size_allocate (GtkWidget *widget,
210 GtkAllocation *allocation)
213 gint natural_width, natural_height;
214 HildonBreadCrumb *item;
215 GtkAllocation child_allocation;
216 GtkRequisition child_requisition;
218 gint allocation_width;
219 gint border_width, width;
223 GList *p, *first_show, *first_hide;
224 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (widget)->priv;
226 widget->allocation = *allocation;
228 border_width = (gint) GTK_CONTAINER (widget)->border_width;
229 allocation_width = allocation->width - 2 * border_width;
231 /* Allocate the back button */
232 child_allocation.x = allocation->x;
233 child_allocation.y = allocation->y;
234 gtk_widget_get_child_requisition (priv->back_button, &child_requisition);
235 child_allocation.width = child_requisition.width;
236 child_allocation.height = child_requisition.height;
237 gtk_widget_size_allocate (priv->back_button, &child_allocation);
238 child_allocation.x += child_allocation.width;
240 /* If there are no buttons there's nothing else to do */
241 if (priv->item_list == NULL)
244 /* We find out how many buttons can we show, starting from the
245 the last one in the logical path (the first item in the list) */
247 width = child_allocation.width;
253 for (p = priv->item_list; p; p = p->next)
255 item = HILDON_BREAD_CRUMB (p->data);
256 child = GTK_WIDGET (item);
258 /* Does the widget fit with its natural size? */
259 hildon_bread_crumb_get_natural_size (item,
263 gtk_widget_style_get (widget,
264 "maximum-width", &maximum_width,
267 desired_width = MIN (natural_width, maximum_width);
269 if (width + desired_width <= allocation_width)
273 first_hide = p->next;
274 width += desired_width;
275 g_debug ("It fits %s at x %d, width %d", hildon_bread_crumb_get_text (item),
276 child_allocation.x, desired_width);
280 /* No, it doesn't. Allocate as much as possible
282 child_allocation.width = allocation_width - width;
284 gtk_widget_size_request (child, &req);
286 if (child_allocation.width > req.width)
288 first_hide = p->next;
289 gtk_widget_size_allocate (child, &child_allocation);
290 gtk_widget_show (child);
291 gtk_widget_set_child_visible (child, TRUE);
292 g_debug ("It doesn't. Allocated %s at x: %d, width %d, size_req width is %d",
293 hildon_bread_crumb_get_text (item),
294 child_allocation.x, child_allocation.width,
296 child_allocation.x += child_allocation.width;
300 extra_space = child_allocation.width;
307 /* Not enough items to fill the breadcrumb? */
308 if (p == NULL && width < allocation_width)
310 extra_space = allocation_width - width;
313 /* Allocate the other buttons */
314 for (p = first_show; p; p = p->prev)
316 item = HILDON_BREAD_CRUMB (p->data);
317 child = GTK_WIDGET (item);
319 /* Does the widget fit with its natural size? */
320 hildon_bread_crumb_get_natural_size (item,
324 gtk_widget_style_get (widget,
325 "maximum-width", &maximum_width,
328 desired_width = MIN (natural_width, maximum_width);
330 /* If I'm the last and there's extra space, use it */
331 if (p->prev == NULL && extra_space != 0)
333 desired_width += extra_space;
336 child_allocation.width = desired_width;
337 gtk_widget_size_allocate (child, &child_allocation);
338 gtk_widget_show (child);
339 gtk_widget_set_child_visible (child, TRUE);
340 g_debug ("Natural Size. Allocated %s at x: %d, width %d",
341 hildon_bread_crumb_get_text (item),
342 child_allocation.x, child_allocation.width);
343 child_allocation.x += child_allocation.width;
346 for (p = first_hide; p; p = p->next)
348 item = HILDON_BREAD_CRUMB (p->data);
349 child = GTK_WIDGET (item);
351 g_debug ("Hiding %s", hildon_bread_crumb_get_text (item));
352 gtk_widget_hide (GTK_WIDGET (item));
353 gtk_widget_set_child_visible (GTK_WIDGET (item), FALSE);
358 get_bread_crumb_id (HildonBreadCrumb *item)
360 return g_object_get_data (G_OBJECT (item), "bread-crumb-id");
364 crumb_clicked_cb (GtkWidget *button,
365 HildonBreadCrumbTrail *bct)
368 HildonBreadCrumbTrailPrivate *priv;
372 child = GTK_WIDGET (priv->item_list->data);
374 /* We remove the tip of the list until we hit the clicked button */
375 while (child != button)
377 gtk_container_remove (GTK_CONTAINER (bct), child);
379 child = GTK_WIDGET (priv->item_list->data);
382 /* We need the item for the ID */
383 g_signal_emit (bct, bread_crumb_trail_signals[CRUMB_CLICKED], 0,
384 get_bread_crumb_id (HILDON_BREAD_CRUMB (child)));
388 hildon_bread_crumb_trail_add (GtkContainer *container,
391 gtk_widget_set_parent (widget, GTK_WIDGET (container));
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_clicked_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 create_crumb_button (HildonBreadCrumbTrail *bct,
539 GDestroyNotify destroy)
543 item = hildon_bread_crumb_new (text);
546 g_object_set_data_full (G_OBJECT (item), "bread-crumb-id", id, destroy);
548 g_signal_connect (G_OBJECT (item), "clicked",
549 G_CALLBACK (crumb_clicked_cb), bct);
558 * hildon_bread_crumb_trail_new:
560 * Creates a new #HildonBreadCrumbTrail widget.
562 * Returns: a #GtkWidget pointer of newly created bread crumb trail
567 hildon_bread_crumb_trail_new (void)
569 return GTK_WIDGET (g_object_new (HILDON_TYPE_BREAD_CRUMB_TRAIL, NULL));
572 /* This is stupidly duplicated from the simple API, consolidate */
575 * hildon_bread_crumb_trail_push:
576 * @bct: pointer to #HildonBreadCrumbTrail
577 * @item: the #HildonBreadCrumb to be added to the trail
578 * @id: optional id for the bread crumb
579 * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed
581 * Adds a new bread crumb to the end of the trail.
585 hildon_bread_crumb_trail_push (HildonBreadCrumbTrail *bct,
586 HildonBreadCrumb *item,
588 GDestroyNotify destroy)
591 HildonBreadCrumbTrailPrivate *priv;;
593 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
594 g_return_if_fail (HILDON_IS_BREAD_CRUMB (item));
598 widget = GTK_WIDGET (item);
600 gtk_container_add (GTK_CONTAINER (bct), widget);
601 gtk_widget_show (widget);
604 g_object_set_data_full (G_OBJECT (item), "bread-crumb-id", id, destroy);
606 g_signal_connect (G_OBJECT (item), "clicked",
607 G_CALLBACK (crumb_clicked_cb), bct);
609 priv->item_list = g_list_prepend (priv->item_list, widget);
611 hildon_bread_crumb_trail_update_back_button_sensitivity (bct);
615 * hildon_bread_crumb_trail_push_text:
616 * @bct: pointer to #HildonBreadCrumbTrail
617 * @text: content of the new bread crumb
618 * @id: optional id for the bread crumb
619 * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed
621 * Adds a new bread crumb to the end of the trail containing the specified text.
625 hildon_bread_crumb_trail_push_text (HildonBreadCrumbTrail *bct,
628 GDestroyNotify destroy)
631 HildonBreadCrumbTrailPrivate *priv;
633 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
634 g_return_if_fail (text != NULL);
638 widget = create_crumb_button (bct, text, id, destroy);
639 gtk_container_add (GTK_CONTAINER (bct), widget);
640 gtk_widget_show (widget);
642 priv->item_list = g_list_prepend (priv->item_list, widget);
644 hildon_bread_crumb_trail_update_back_button_sensitivity (bct);
648 * hildon_bread_crumb_trail_pop:
649 * @bct: pointer to #HildonBreadCrumbTrail
651 * Removes the last bread crumb from the trail.
655 hildon_bread_crumb_trail_pop (HildonBreadCrumbTrail *bct)
658 HildonBreadCrumbTrailPrivate *priv;
660 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
664 if (priv->item_list == NULL)
669 child = GTK_WIDGET (priv->item_list->data);
670 gtk_container_remove (GTK_CONTAINER (bct), child);
673 hildon_bread_crumb_trail_update_back_button_sensitivity (bct);
677 * hildon_bread_crumb_trail_clear:
678 * @bct: pointer to #HildonBreadCrumbTrail
680 * Removes all the bread crumbs from the bread crumb trail.
684 hildon_bread_crumb_trail_clear (HildonBreadCrumbTrail *bct)
686 HildonBreadCrumbTrailPrivate *priv;
688 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
692 while (priv->item_list)
694 hildon_bread_crumb_trail_pop (bct);