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"
43 #define HILDON_BREAD_CRUMB_TRAIL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrailPrivate))
45 struct _HildonBreadCrumbTrailPrivate
47 GtkWidget *back_button;
64 static void hildon_bread_crumb_trail_size_request (GtkWidget *widget,
65 GtkRequisition *requisition);
66 static void hildon_bread_crumb_trail_size_allocate (GtkWidget *widget,
67 GtkAllocation *allocation);
68 static void hildon_bread_crumb_trail_add (GtkContainer *container,
70 static void hildon_bread_crumb_trail_forall (GtkContainer *container,
71 gboolean include_internals,
73 gpointer callback_data);
74 static void hildon_bread_crumb_trail_remove (GtkContainer *container,
76 static void hildon_bread_crumb_trail_finalize (GObject *object);
77 static void hildon_bread_crumb_trail_scroll_back (GtkWidget *button,
78 HildonBreadCrumbTrail *bct);
79 static void hildon_bread_crumb_trail_update_back_button_sensitivity (HildonBreadCrumbTrail *bct);
81 static guint bread_crumb_trail_signals[LAST_SIGNAL] = { 0 };
85 G_DEFINE_TYPE (HildonBreadCrumbTrail, hildon_bread_crumb_trail, GTK_TYPE_CONTAINER)
88 hildon_bread_crumb_trail_class_init (HildonBreadCrumbTrailClass *klass)
90 GObjectClass *gobject_class = (GObjectClass*)klass;
91 GtkObjectClass *object_class = (GtkObjectClass*)klass;
92 GtkWidgetClass *widget_class = (GtkWidgetClass*)klass;
93 GtkContainerClass *container_class = (GtkContainerClass*)klass;
96 gobject_class->finalize = hildon_bread_crumb_trail_finalize;
98 /* GtkWidget signals */
99 widget_class->size_request = hildon_bread_crumb_trail_size_request;
100 widget_class->size_allocate = hildon_bread_crumb_trail_size_allocate;
102 /* GtkContainer signals */
103 container_class->add = hildon_bread_crumb_trail_add;
104 container_class->forall = hildon_bread_crumb_trail_forall;
105 container_class->remove = hildon_bread_crumb_trail_remove;
107 /* Style properties */
109 #define _BREAD_CRUMB_TRAIL_MINIMUM_WIDTH 10
111 /* FIXME: is this the best way to do it? */
112 gtk_widget_class_install_style_property (widget_class,
113 g_param_spec_int ("minimum-width",
115 "The minimum width in characters the children widgets will request",
118 _BREAD_CRUMB_TRAIL_MINIMUM_WIDTH,
121 #define _BREAD_CRUMB_TRAIL_ARROW_SIZE 34
123 gtk_widget_class_install_style_property (widget_class,
124 g_param_spec_int ("arrow-size",
126 "Size of the back button arrow",
129 _BREAD_CRUMB_TRAIL_ARROW_SIZE,
132 bread_crumb_trail_signals[CRUMB_CLICKED] =
133 g_signal_new ("crumb-clicked",
134 G_OBJECT_CLASS_TYPE (object_class),
136 G_STRUCT_OFFSET (HildonBreadCrumbTrailClass, crumb_clicked),
137 g_signal_accumulator_true_handled, NULL,
138 _hildon_marshal_BOOLEAN__POINTER,
143 g_type_class_add_private (gobject_class, sizeof (HildonBreadCrumbTrailPrivate));
147 hildon_bread_crumb_trail_finalize (GObject *object)
149 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (object)->priv;
151 g_list_free (priv->item_list);
153 G_OBJECT_CLASS (hildon_bread_crumb_trail_parent_class)->finalize (object);
157 hildon_bread_crumb_trail_size_request (GtkWidget *widget,
158 GtkRequisition *requisition)
161 GtkRequisition child_requisition;
162 HildonBreadCrumbTrail *bct;
163 HildonBreadCrumbTrailPrivate *priv;
164 gint minimum_width, width = 0;
168 bct= HILDON_BREAD_CRUMB_TRAIL (widget);
171 requisition->height = 0;
172 requisition->width = 0;
174 gtk_widget_size_request (priv->back_button, &child_requisition);
175 requisition->width = child_requisition.width;
176 requisition->height = child_requisition.height;
180 /* Add minimum width for one item */
181 /* TODO: this can be probably cached */
182 gtk_widget_style_get (widget,
183 "minimum-width", &minimum_width,
186 tmp = g_strnfill ((gsize)minimum_width, 'm');
187 layout = gtk_widget_create_pango_layout (widget, tmp);
189 pango_layout_get_size (layout, &width, NULL);
190 requisition->width += PANGO_PIXELS (width);
191 g_object_unref (layout);
194 /* Button requisitions */
195 for (p = priv->item_list; p; p = p->next)
197 GtkWidget *child = GTK_WIDGET (p->data);
199 if (GTK_WIDGET_VISIBLE (child))
200 gtk_widget_size_request (child, &child_requisition);
204 requisition->width += GTK_CONTAINER (widget)->border_width * 2;
205 requisition->height += GTK_CONTAINER (widget)->border_width * 2;
207 widget->requisition = *requisition;
210 /* Document me please */
213 hildon_bread_crumb_trail_size_allocate (GtkWidget *widget,
214 GtkAllocation *allocation)
217 gint natural_width, natural_height;
218 HildonBreadCrumb *item;
219 GtkAllocation child_allocation;
220 GtkRequisition child_requisition;
222 gint allocation_width;
223 gint border_width, width;
225 GList *p, *first_show, *first_hide;
226 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (widget)->priv;
228 widget->allocation = *allocation;
230 border_width = (gint) GTK_CONTAINER (widget)->border_width;
231 allocation_width = allocation->width - 2 * border_width;
233 /* Allocate the back button */
234 child_allocation.x = allocation->x + border_width;
235 child_allocation.y = allocation->y + border_width;
236 gtk_widget_get_child_requisition (priv->back_button, &child_requisition);
237 child_allocation.width = child_requisition.width;
238 child_allocation.height = child_requisition.height;
239 gtk_widget_size_allocate (priv->back_button, &child_allocation);
240 child_allocation.x += child_allocation.width;
242 /* If there are no buttons there's nothing else to do */
243 if (priv->item_list == NULL)
246 /* We find out how many buttons can we show, starting from the
247 the last one in the logical path (the first item in the list) */
249 width = child_allocation.width;
255 for (p = priv->item_list; p; p = p->next)
257 item = HILDON_BREAD_CRUMB (p->data);
258 child = GTK_WIDGET (item);
260 /* Does the widget fit with its natural size? */
261 hildon_bread_crumb_get_natural_size (item,
265 if (width + natural_width <= allocation_width)
269 first_hide = p->next;
270 width += natural_width;
274 /* No, it doesn't. Allocate as much as possible
276 child_allocation.width = allocation_width - width;
278 gtk_widget_size_request (child, &req);
280 if (child_allocation.width > req.width)
282 first_hide = p->next;
283 gtk_widget_size_allocate (child, &child_allocation);
284 gtk_widget_show (child);
285 gtk_widget_set_child_visible (child, TRUE);
286 child_allocation.x += child_allocation.width;
290 extra_space = child_allocation.width;
297 /* Not enough items to fill the breadcrumb? */
298 if (p == NULL && width < allocation_width)
300 extra_space = allocation_width - width;
303 /* Allocate the other buttons */
304 for (p = first_show; p; p = p->prev)
306 item = HILDON_BREAD_CRUMB (p->data);
307 child = GTK_WIDGET (item);
309 /* Does the widget fit with its natural size? */
310 hildon_bread_crumb_get_natural_size (item,
314 /* If I'm the last and there's extra space, use it */
315 if (p->prev == NULL && extra_space != 0)
317 natural_width += extra_space;
320 child_allocation.width = natural_width;
321 gtk_widget_size_allocate (child, &child_allocation);
322 gtk_widget_show (child);
323 gtk_widget_set_child_visible (child, TRUE);
324 child_allocation.x += child_allocation.width;
327 for (p = first_hide; p; p = p->next)
329 item = HILDON_BREAD_CRUMB (p->data);
330 child = GTK_WIDGET (item);
332 gtk_widget_hide (GTK_WIDGET (item));
333 gtk_widget_set_child_visible (GTK_WIDGET (item), FALSE);
338 get_bread_crumb_id (HildonBreadCrumb *item)
340 return g_object_get_data (G_OBJECT (item), "bread-crumb-id");
344 crumb_activated_cb (GtkWidget *button,
345 HildonBreadCrumbTrail *bct)
347 gboolean signal_handled = FALSE;
349 g_signal_emit (bct, bread_crumb_trail_signals[CRUMB_CLICKED], 0,
350 get_bread_crumb_id (HILDON_BREAD_CRUMB (button)),
353 if (signal_handled == FALSE)
356 HildonBreadCrumbTrailPrivate *priv;
360 child = GTK_WIDGET (priv->item_list->data);
362 /* We remove the tip of the list until we hit the clicked button */
363 while (child != button)
365 gtk_container_remove (GTK_CONTAINER (bct), child);
367 child = GTK_WIDGET (priv->item_list->data);
373 hildon_bread_crumb_trail_add (GtkContainer *container,
376 gtk_widget_set_parent (widget, GTK_WIDGET (container));
380 hildon_bread_crumb_trail_forall (GtkContainer *container,
381 gboolean include_internals,
382 GtkCallback callback,
383 gpointer callback_data)
385 g_return_if_fail (callback != NULL);
386 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (container));
389 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (container)->priv;
391 children = priv->item_list;
396 child = GTK_WIDGET (children->data);
397 children = children->next;
399 (*callback) (child, callback_data);
402 if (include_internals && priv->back_button)
404 (*callback) (priv->back_button, callback_data);
409 hildon_bread_crumb_trail_remove (GtkContainer *container,
413 HildonBreadCrumbTrailPrivate *priv;
414 gboolean was_visible = GTK_WIDGET_VISIBLE (widget);
416 priv = HILDON_BREAD_CRUMB_TRAIL (container)->priv;
422 if (widget == GTK_WIDGET (p->data))
424 g_signal_handlers_disconnect_by_func (widget, G_CALLBACK (crumb_activated_cb),
425 HILDON_BREAD_CRUMB_TRAIL (container));
426 gtk_widget_unparent (widget);
428 priv->item_list = g_list_remove_link (priv->item_list, p);
431 hildon_bread_crumb_trail_update_back_button_sensitivity (HILDON_BREAD_CRUMB_TRAIL (container));
435 gtk_widget_queue_resize (GTK_WIDGET (container));
444 hildon_bread_crumb_trail_update_back_button_sensitivity (HildonBreadCrumbTrail *bct)
447 HildonBreadCrumbTrailPrivate *priv = bct->priv;
449 list_length = g_list_length (priv->item_list);
451 if (list_length == 0 || list_length == 1)
453 gtk_widget_set_sensitive (priv->back_button, FALSE);
457 gtk_widget_set_sensitive (priv->back_button, TRUE);
462 create_back_button (HildonBreadCrumbTrail *bct)
468 gtk_widget_push_composite_child ();
470 button = gtk_button_new ();
471 gtk_widget_set_name (button, "hildon-bread-crumb-back-button");
472 gtk_widget_set_sensitive (button, FALSE);
474 arrow = gtk_arrow_new (GTK_ARROW_LEFT, GTK_SHADOW_NONE);
475 gtk_widget_style_get (GTK_WIDGET (bct),
476 "arrow-size", &arrow_size,
478 gtk_widget_set_size_request (arrow, arrow_size, arrow_size);
480 gtk_container_add (GTK_CONTAINER (button), arrow);
481 gtk_container_add (GTK_CONTAINER (bct), button);
482 gtk_widget_show_all (button);
484 gtk_widget_pop_composite_child ();
490 hildon_bread_crumb_trail_init (HildonBreadCrumbTrail *bct)
492 HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL_GET_PRIVATE (bct);
494 GTK_WIDGET_SET_FLAGS (bct, GTK_NO_WINDOW);
495 gtk_widget_set_redraw_on_allocate (GTK_WIDGET (bct), FALSE);
498 priv->item_list = NULL;
500 priv->back_button = create_back_button (bct);
501 g_signal_connect (priv->back_button, "clicked",
502 G_CALLBACK (hildon_bread_crumb_trail_scroll_back),
507 hildon_bread_crumb_trail_scroll_back (GtkWidget *button,
508 HildonBreadCrumbTrail *bct)
510 HildonBreadCrumb *item;
512 hildon_bread_crumb_trail_pop (bct);
514 item = HILDON_BREAD_CRUMB (bct->priv->item_list->data);
516 g_signal_emit (bct, bread_crumb_trail_signals[CRUMB_CLICKED], 0,
517 get_bread_crumb_id (item));
521 * Helper function to add a bread crumb to the trail. This should go in the
522 * container add method, but there's no way to plug there the id/destroy
523 * information (FIXME)
527 attach_bread_crumb (HildonBreadCrumbTrail *bct,
528 GtkWidget *bread_crumb,
530 GDestroyNotify destroy)
532 g_object_set_data_full (G_OBJECT (bread_crumb), "bread-crumb-id", id, destroy);
534 g_signal_connect (G_OBJECT (bread_crumb), "crumb-activated",
535 G_CALLBACK (crumb_activated_cb), bct);
537 bct->priv->item_list = g_list_prepend (bct->priv->item_list, bread_crumb);
539 gtk_container_add (GTK_CONTAINER (bct), bread_crumb);
540 gtk_widget_show (bread_crumb);
542 hildon_bread_crumb_trail_update_back_button_sensitivity (bct);
548 * hildon_bread_crumb_trail_new:
550 * Creates a new #HildonBreadCrumbTrail widget.
552 * Returns: a #GtkWidget pointer of newly created bread crumb trail
555 * Stability: Unstable
559 hildon_bread_crumb_trail_new (void)
561 return GTK_WIDGET (g_object_new (HILDON_TYPE_BREAD_CRUMB_TRAIL, NULL));
565 * hildon_bread_crumb_trail_push:
566 * @bct: pointer to #HildonBreadCrumbTrail
567 * @item: the #HildonBreadCrumb to be added to the trail
568 * @id: optional id for the bread crumb
569 * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed
571 * Adds a new bread crumb to the end of the trail.
573 * Stability: Unstable
577 hildon_bread_crumb_trail_push (HildonBreadCrumbTrail *bct,
578 HildonBreadCrumb *item,
580 GDestroyNotify destroy)
584 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
585 g_return_if_fail (HILDON_IS_BREAD_CRUMB (item));
587 widget = GTK_WIDGET (item);
589 attach_bread_crumb (bct, widget, id, destroy);
593 * hildon_bread_crumb_trail_push_text:
594 * @bct: pointer to #HildonBreadCrumbTrail
595 * @text: content of the new bread crumb
596 * @id: optional id for the bread crumb
597 * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed
599 * Adds a new bread crumb to the end of the trail containing the specified text.
601 * Stability: Unstable
605 hildon_bread_crumb_trail_push_text (HildonBreadCrumbTrail *bct,
608 GDestroyNotify destroy)
612 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
613 g_return_if_fail (text != NULL);
615 widget = _hildon_bread_crumb_widget_new_with_text (text);
616 attach_bread_crumb (bct, widget, id, destroy);
620 * hildon_bread_crumb_trail_push_text:
621 * @bct: pointer to #HildonBreadCrumbTrail
622 * @text: content of the new bread crumb
623 * @icon: a widget to set as the icon in the bread crumb
624 * @id: optional id for the bread crumb
625 * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed
627 * Adds a new bread crumb to the end of the trail containing the specified text and
630 * Stability: Unstable
634 hildon_bread_crumb_trail_push_icon (HildonBreadCrumbTrail *bct,
638 GDestroyNotify destroy)
642 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
643 g_return_if_fail (text != NULL);
644 g_return_if_fail (GTK_IS_WIDGET (icon));
646 widget = _hildon_bread_crumb_widget_new_with_icon (icon, text);
647 attach_bread_crumb (bct, widget, id, destroy);
651 * hildon_bread_crumb_trail_pop:
652 * @bct: pointer to #HildonBreadCrumbTrail
654 * Removes the last bread crumb from the trail.
656 * Stability: Unstable
660 hildon_bread_crumb_trail_pop (HildonBreadCrumbTrail *bct)
663 HildonBreadCrumbTrailPrivate *priv;
665 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
669 if (priv->item_list == NULL)
674 child = GTK_WIDGET (priv->item_list->data);
675 gtk_container_remove (GTK_CONTAINER (bct), child);
678 hildon_bread_crumb_trail_update_back_button_sensitivity (bct);
682 * hildon_bread_crumb_trail_clear:
683 * @bct: pointer to #HildonBreadCrumbTrail
685 * Removes all the bread crumbs from the bread crumb trail.
687 * Stability: Unstable
691 hildon_bread_crumb_trail_clear (HildonBreadCrumbTrail *bct)
693 HildonBreadCrumbTrailPrivate *priv;
695 g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct));
699 while (priv->item_list)
701 hildon_bread_crumb_trail_pop (bct);