diff options
Diffstat (limited to 'hildon/hildon-bread-crumb-trail.c')
| -rw-r--r-- | hildon/hildon-bread-crumb-trail.c | 795 |
1 files changed, 0 insertions, 795 deletions
diff --git a/hildon/hildon-bread-crumb-trail.c b/hildon/hildon-bread-crumb-trail.c deleted file mode 100644 index 6639136..0000000 --- a/hildon/hildon-bread-crumb-trail.c +++ /dev/null @@ -1,795 +0,0 @@ -/* - * This file is a part of hildon - * - * Copyright (C) 2007 Nokia Corporation, all rights reserved. - * - * Contact: Rodrigo Novo <rodrigo.novo@nokia.com> - * Author: Xan Lopez <xan.lopez@nokia.com> - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License - * as published by the Free Software Foundation; version 2.1 of - * the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA - * - */ - - -/** - * SECTION:hildon-bread-crumb-trail - * @short_description: Widget used to represent a specific path in a hierarchical tree. - * Stability: Unstable - * - * HildonBreadCrumbTrail is a GTK widget used to represent the currently active path in - * some kind of hierarchical structure (file system, media library, structured document, etc). - * - * It has built-in support for text and icon bread crumbs, but the trail only requires a very - * simple interface to be implemented for its children and thus new types of items can be - * implemented if needed. See #HildonBreadCrumb for more details. - * - * #HildonBreadCrumbTrail is deprecated since hildon 2.2. You should instead use - * #HildonStackableWindow to represent hierarchical structure in - * applications. - */ - -#undef HILDON_DISABLE_DEPRECATED - -#include <gdk/gdkkeysyms.h> - -#include "hildon-marshalers.h" -#include "hildon-bread-crumb-trail.h" -#include "hildon-bread-crumb-widget.h" - -#define HILDON_BREAD_CRUMB_TRAIL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), HILDON_TYPE_BREAD_CRUMB_TRAIL, HildonBreadCrumbTrailPrivate)) - -struct _HildonBreadCrumbTrailPrivate -{ - GtkWidget *back_button; - GList *item_list; - GtkWidget *arrow; -}; - -/* Signals */ - -enum { - CRUMB_CLICKED, - MOVE_PARENT, - LAST_SIGNAL -}; - -/* Properties */ - -enum { - PROP_0 -}; - -static void hildon_bread_crumb_trail_size_request (GtkWidget *widget, - GtkRequisition *requisition); -static void hildon_bread_crumb_trail_size_allocate (GtkWidget *widget, - GtkAllocation *allocation); -static void hildon_bread_crumb_trail_add (GtkContainer *container, - GtkWidget *widget); -static void hildon_bread_crumb_trail_forall (GtkContainer *container, - gboolean include_internals, - GtkCallback callback, - gpointer callback_data); -static void hildon_bread_crumb_trail_remove (GtkContainer *container, - GtkWidget *widget); -static void hildon_bread_crumb_trail_finalize (GObject *object); -static void hildon_bread_crumb_trail_scroll_back (GtkWidget *button, - HildonBreadCrumbTrail *bct); -static void hildon_bread_crumb_trail_update_back_button_sensitivity (HildonBreadCrumbTrail *bct); -static void hildon_bread_crumb_trail_move_parent (HildonBreadCrumbTrail *bct); - -static gpointer get_bread_crumb_id (HildonBreadCrumb *item); - -static guint bread_crumb_trail_signals[LAST_SIGNAL] = { 0 }; - -/* GType methods */ - -G_DEFINE_TYPE (HildonBreadCrumbTrail, hildon_bread_crumb_trail, GTK_TYPE_CONTAINER) - -static void -hildon_bread_crumb_trail_class_init (HildonBreadCrumbTrailClass *klass) -{ - GObjectClass *gobject_class = (GObjectClass*)klass; - GtkObjectClass *object_class = (GtkObjectClass*)klass; - GtkWidgetClass *widget_class = (GtkWidgetClass*)klass; - GtkContainerClass *container_class = (GtkContainerClass*)klass; - GtkBindingSet *binding_set; - - /* GObject signals */ - gobject_class->finalize = hildon_bread_crumb_trail_finalize; - - /* GtkWidget signals */ - widget_class->size_request = hildon_bread_crumb_trail_size_request; - widget_class->size_allocate = hildon_bread_crumb_trail_size_allocate; - - /* GtkContainer signals */ - container_class->add = hildon_bread_crumb_trail_add; - container_class->forall = hildon_bread_crumb_trail_forall; - container_class->remove = hildon_bread_crumb_trail_remove; - - /* HildonBreadCrumbTrail signals */ - klass->move_parent = hildon_bread_crumb_trail_move_parent; - - /* Style properties */ - -#define _BREAD_CRUMB_TRAIL_MINIMUM_WIDTH 10 - - /* FIXME: is this the best way to do it? */ - gtk_widget_class_install_style_property (widget_class, - g_param_spec_int ("minimum-width", - "Minimum width", - "The minimum width in characters the children widgets will request", - 0, - G_MAXINT, - _BREAD_CRUMB_TRAIL_MINIMUM_WIDTH, - G_PARAM_READABLE)); - -#define _BREAD_CRUMB_TRAIL_ARROW_SIZE 34 - - gtk_widget_class_install_style_property (widget_class, - g_param_spec_int ("arrow-size", - "Arrow size", - "Size of the back button arrow", - 0, - G_MAXINT, - _BREAD_CRUMB_TRAIL_ARROW_SIZE, - G_PARAM_READABLE)); - /* Signals */ - bread_crumb_trail_signals[CRUMB_CLICKED] = - g_signal_new ("crumb-clicked", - G_OBJECT_CLASS_TYPE (object_class), - G_SIGNAL_RUN_LAST, - G_STRUCT_OFFSET (HildonBreadCrumbTrailClass, crumb_clicked), - g_signal_accumulator_true_handled, NULL, - _hildon_marshal_BOOLEAN__POINTER, - G_TYPE_BOOLEAN, 1, - G_TYPE_POINTER); - - bread_crumb_trail_signals[MOVE_PARENT] = - g_signal_new ("move-parent", - G_OBJECT_CLASS_TYPE (object_class), - G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION, - G_STRUCT_OFFSET (HildonBreadCrumbTrailClass, move_parent), - NULL, NULL, - g_cclosure_marshal_VOID__VOID, - G_TYPE_NONE, - 0); - - - /* Binding set */ - binding_set = gtk_binding_set_by_class (widget_class); - - gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0, - "move-parent", 0); - gtk_binding_entry_add_signal (binding_set, GDK_BackSpace, 0, - "move-parent", 0); - - /* Private data */ - g_type_class_add_private (gobject_class, sizeof (HildonBreadCrumbTrailPrivate)); -} - -static void -hildon_bread_crumb_trail_finalize (GObject *object) -{ - HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (object)->priv; - - g_list_free (priv->item_list); - - G_OBJECT_CLASS (hildon_bread_crumb_trail_parent_class)->finalize (object); -} - -static void -hildon_bread_crumb_trail_move_parent (HildonBreadCrumbTrail *bct) -{ - if (g_list_length (bct->priv->item_list) > 1) - { - g_signal_emit_by_name (HILDON_BREAD_CRUMB (bct->priv->item_list->next->data), - "crumb-activated"); - } -} - -static void -hildon_bread_crumb_trail_size_request (GtkWidget *widget, - GtkRequisition *requisition) -{ - GList *p; - GtkRequisition child_requisition; - HildonBreadCrumbTrail *bct; - HildonBreadCrumbTrailPrivate *priv; - gint minimum_width, width = 0; - PangoLayout *layout; - gchar *tmp = NULL; - - bct= HILDON_BREAD_CRUMB_TRAIL (widget); - priv = bct->priv; - - requisition->height = 0; - requisition->width = 0; - - gtk_widget_size_request (priv->back_button, &child_requisition); - requisition->width = child_requisition.width; - requisition->height = child_requisition.height; - - if (priv->item_list) - { - /* Add minimum width for one item */ - /* TODO: this can be probably cached */ - gtk_widget_style_get (widget, - "minimum-width", &minimum_width, - NULL); - - tmp = g_strnfill ((gsize)minimum_width, 'm'); - layout = gtk_widget_create_pango_layout (widget, tmp); - g_free (tmp); - pango_layout_get_size (layout, &width, NULL); - requisition->width += PANGO_PIXELS (width); - g_object_unref (layout); - } - - /* Button requisitions */ - for (p = priv->item_list; p; p = p->next) - { - GtkWidget *child = GTK_WIDGET (p->data); - - if (GTK_WIDGET_VISIBLE (child)) - gtk_widget_size_request (child, &child_requisition); - } - - /* Border width */ - requisition->width += GTK_CONTAINER (widget)->border_width * 2; - requisition->height += GTK_CONTAINER (widget)->border_width * 2; - - widget->requisition = *requisition; -} - -/* Document me please */ - -static void -hildon_bread_crumb_trail_size_allocate (GtkWidget *widget, - GtkAllocation *allocation) -{ - GtkRequisition req; - gint natural_width, natural_height; - HildonBreadCrumb *item; - GtkAllocation child_allocation; - GtkRequisition child_requisition; - GtkWidget *child; - gint allocation_width; - gint border_width, width; - gint extra_space; - GList *p, *first_show, *first_hide; - gint back_button_size; - HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (widget)->priv; - gboolean rtl; - - /* Get the rtl status */ - rtl = (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL); - - widget->allocation = *allocation; - - border_width = (gint) GTK_CONTAINER (widget)->border_width; - allocation_width = allocation->width - 2 * border_width; - - /* Allocate the back button */ - if (rtl) - child_allocation.x = allocation->width - border_width; - else - child_allocation.x = allocation->x + border_width; - - child_allocation.y = allocation->y + border_width; - gtk_widget_get_child_requisition (priv->back_button, &child_requisition); - /* We want the back button to be a square */ - back_button_size = MAX (child_requisition.width, child_requisition.height); - child_allocation.width = child_allocation.height = back_button_size; - - if (rtl) - child_allocation.x -= back_button_size; - - gtk_widget_size_allocate (priv->back_button, &child_allocation); - - if (!rtl) - child_allocation.x += back_button_size; - - /* If there are no buttons there's nothing else to do */ - if (priv->item_list == NULL) - return; - - /* We find out how many buttons can we show, starting from the - the last one in the logical path (the first item in the list) */ - - width = back_button_size; - p = priv->item_list; - first_show = NULL; - first_hide = NULL; - extra_space = 0; - - for (p = priv->item_list; p; p = p->next) - { - item = HILDON_BREAD_CRUMB (p->data); - child = GTK_WIDGET (item); - - /* Does the widget fit with its natural size? */ - hildon_bread_crumb_get_natural_size (item, - &natural_width, - &natural_height); - - if (width + natural_width <= allocation_width) - { - /* Yes, it does */ - first_show = p; - first_hide = p->next; - width += natural_width; - } - else - { - /* No, it doesn't. Allocate as much as possible - and stop */ - child_allocation.width = allocation_width - width; - - gtk_widget_size_request (child, &req); - - if (child_allocation.width > req.width) - { - first_hide = p->next; - gtk_widget_set_child_visible (child, TRUE); - - if (rtl) - child_allocation.x -= child_allocation.width; - - gtk_widget_size_allocate (child, &child_allocation); - - if (!rtl) - child_allocation.x += child_allocation.width; - } - else - { - extra_space = child_allocation.width; - } - - break; - } - } - - /* Not enough items to fill the breadcrumb? */ - if (p == NULL && width < allocation_width) - { - extra_space = allocation_width - width; - } - - /* Allocate the other buttons */ - for (p = first_show; p; p = p->prev) - { - item = HILDON_BREAD_CRUMB (p->data); - child = GTK_WIDGET (item); - - /* Does the widget fit with its natural size? */ - hildon_bread_crumb_get_natural_size (item, - &natural_width, - &natural_height); - - /* If I'm the last and there's extra space, use it */ - if (p->prev == NULL && extra_space != 0) - { - natural_width += extra_space; - } - - child_allocation.width = natural_width; - gtk_widget_set_child_visible (child, TRUE); - - if (rtl) - child_allocation.x -= child_allocation.width; - - gtk_widget_size_allocate (child, &child_allocation); - - if (!rtl) - child_allocation.x += child_allocation.width; - } - - for (p = first_hide; p; p = p->next) - { - item = HILDON_BREAD_CRUMB (p->data); - gtk_widget_set_child_visible (GTK_WIDGET (item), FALSE); - } -} - -static gpointer -get_bread_crumb_id (HildonBreadCrumb *item) -{ - return g_object_get_data (G_OBJECT (item), "bread-crumb-id"); -} - -static void -crumb_activated_cb (GtkWidget *button, - HildonBreadCrumbTrail *bct) -{ - gboolean signal_handled = FALSE; - - g_signal_emit (bct, bread_crumb_trail_signals[CRUMB_CLICKED], 0, - get_bread_crumb_id (HILDON_BREAD_CRUMB (button)), - &signal_handled); - - if (signal_handled == FALSE) - { - GtkWidget *child; - gboolean focus_last_item = FALSE; - HildonBreadCrumbTrailPrivate *priv; - - priv = bct->priv; - - child = GTK_WIDGET (priv->item_list->data); - - /* We remove the tip of the list until we hit the clicked button */ - while (child && child != button) - { - if (GTK_WIDGET_HAS_FOCUS (child)) - focus_last_item = TRUE; - - gtk_container_remove (GTK_CONTAINER (bct), child); - - if (priv->item_list == NULL) - return; - - child = GTK_WIDGET (priv->item_list->data); - } - - if (focus_last_item) - gtk_widget_grab_focus (GTK_WIDGET (bct->priv->item_list->data)); - } -} - -static void -hildon_bread_crumb_trail_add (GtkContainer *container, - GtkWidget *widget) -{ - gtk_widget_set_parent (widget, GTK_WIDGET (container)); - - if (HILDON_IS_BREAD_CRUMB (widget)) - { - HildonBreadCrumbTrail *bct = HILDON_BREAD_CRUMB_TRAIL (container); - - g_signal_connect (G_OBJECT (widget), "crumb-activated", - G_CALLBACK (crumb_activated_cb), container); - - bct->priv->item_list = g_list_prepend (bct->priv->item_list, widget); - - hildon_bread_crumb_trail_update_back_button_sensitivity (bct); - } -} - -static void -hildon_bread_crumb_trail_forall (GtkContainer *container, - gboolean include_internals, - GtkCallback callback, - gpointer callback_data) -{ - g_return_if_fail (callback != NULL); - g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (container)); - - GList *children; - HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL (container)->priv; - - children = priv->item_list; - - while (children) - { - GtkWidget *child; - child = GTK_WIDGET (children->data); - children = children->next; - - (*callback) (child, callback_data); - } - - if (include_internals && priv->back_button) - { - (*callback) (priv->back_button, callback_data); - } -} - -static void -hildon_bread_crumb_trail_remove (GtkContainer *container, - GtkWidget *widget) -{ - GList *p, *next; - HildonBreadCrumbTrailPrivate *priv; - gboolean was_visible = GTK_WIDGET_VISIBLE (widget); - - priv = HILDON_BREAD_CRUMB_TRAIL (container)->priv; - - p = priv->item_list; - - while (p) - { - next = p->next; - - if (widget == GTK_WIDGET (p->data)) - { - g_signal_handlers_disconnect_by_func (widget, G_CALLBACK (crumb_activated_cb), - HILDON_BREAD_CRUMB_TRAIL (container)); - gtk_widget_unparent (widget); - - priv->item_list = g_list_delete_link (priv->item_list, p); - - hildon_bread_crumb_trail_update_back_button_sensitivity (HILDON_BREAD_CRUMB_TRAIL (container)); - - if (was_visible) - { - gtk_widget_queue_resize (GTK_WIDGET (container)); - } - } - - p = next; - } -} - -static void -hildon_bread_crumb_trail_update_back_button_sensitivity (HildonBreadCrumbTrail *bct) -{ - guint list_length; - HildonBreadCrumbTrailPrivate *priv = bct->priv; - - list_length = g_list_length (priv->item_list); - - if (list_length <= 1) - { - gtk_widget_set_sensitive (priv->back_button, FALSE); - } - else - { - gtk_widget_set_sensitive (priv->back_button, TRUE); - } -} - -static GtkWidget* -create_back_button (HildonBreadCrumbTrail *bct) -{ - GtkWidget *button; - GtkWidget *arrow; - gint arrow_size; - - gtk_widget_push_composite_child (); - - button = gtk_button_new (); - gtk_widget_set_name (button, "hildon-bread-crumb-back-button"); - gtk_widget_set_sensitive (button, FALSE); - - arrow = gtk_arrow_new (GTK_ARROW_LEFT, GTK_SHADOW_NONE); - bct->priv->arrow = arrow; - gtk_widget_style_get (GTK_WIDGET (bct), - "arrow-size", &arrow_size, - NULL); - gtk_widget_set_size_request (arrow, arrow_size, arrow_size); - - gtk_container_add (GTK_CONTAINER (button), arrow); - gtk_container_add (GTK_CONTAINER (bct), button); - gtk_widget_show_all (button); - - gtk_widget_pop_composite_child (); - - return button; -} - -static void -hildon_bread_crumb_trail_init (HildonBreadCrumbTrail *bct) -{ - HildonBreadCrumbTrailPrivate *priv = HILDON_BREAD_CRUMB_TRAIL_GET_PRIVATE (bct); - - GTK_WIDGET_SET_FLAGS (bct, GTK_NO_WINDOW); - gtk_widget_set_redraw_on_allocate (GTK_WIDGET (bct), FALSE); - - bct->priv = priv; - priv->item_list = NULL; - - priv->back_button = create_back_button (bct); - g_signal_connect (priv->back_button, "clicked", - G_CALLBACK (hildon_bread_crumb_trail_scroll_back), - bct); -} - -static void -hildon_bread_crumb_trail_scroll_back (GtkWidget *button, - HildonBreadCrumbTrail *bct) -{ - hildon_bread_crumb_trail_move_parent (bct); -} - -static void -attach_bread_crumb (HildonBreadCrumbTrail *bct, - GtkWidget *bread_crumb, - gpointer id, - GDestroyNotify destroy) -{ - g_object_set_data_full (G_OBJECT (bread_crumb), "bread-crumb-id", id, destroy); - - gtk_container_add (GTK_CONTAINER (bct), bread_crumb); - - gtk_widget_show (bread_crumb); -} - -/* PUBLIC API */ - -/** - * hildon_bread_crumb_trail_new: - * - * Creates a new #HildonBreadCrumbTrail widget. - * - * Returns: a #GtkWidget pointer of newly created bread crumb trail - * widget - * - * Stability: Unstable - */ - -GtkWidget* -hildon_bread_crumb_trail_new (void) -{ - return GTK_WIDGET (g_object_new (HILDON_TYPE_BREAD_CRUMB_TRAIL, NULL)); -} - -/** - * hildon_bread_crumb_trail_push: - * @bct: pointer to #HildonBreadCrumbTrail - * @item: the #HildonBreadCrumb to be added to the trail - * @id: optional id for the bread crumb - * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed - * - * Adds a new bread crumb to the end of the trail. - * - * Stability: Unstable - */ - -void -hildon_bread_crumb_trail_push (HildonBreadCrumbTrail *bct, - HildonBreadCrumb *item, - gpointer id, - GDestroyNotify destroy) -{ - GtkWidget *widget; - - g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct)); - g_return_if_fail (HILDON_IS_BREAD_CRUMB (item)); - - widget = GTK_WIDGET (item); - - attach_bread_crumb (bct, widget, id, destroy); -} - -/** - * hildon_bread_crumb_trail_push_text: - * @bct: pointer to #HildonBreadCrumbTrail - * @text: content of the new bread crumb - * @id: optional id for the bread crumb - * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed - * - * Adds a new bread crumb to the end of the trail containing the specified text. - * - * Stability: Unstable - */ - -void -hildon_bread_crumb_trail_push_text (HildonBreadCrumbTrail *bct, - const gchar *text, - gpointer id, - GDestroyNotify destroy) -{ - GtkWidget *widget; - - g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct)); - g_return_if_fail (text != NULL); - - widget = _hildon_bread_crumb_widget_new_with_text (text); - if (bct->priv->item_list == NULL) - { - g_object_set (G_OBJECT (widget), "show-separator", FALSE, NULL); - } - attach_bread_crumb (bct, widget, id, destroy); -} - -/** - * hildon_bread_crumb_trail_push_icon: - * @bct: pointer to #HildonBreadCrumbTrail - * @text: content of the new bread crumb - * @icon: a widget to set as the icon in the bread crumb - * @id: optional id for the bread crumb - * @destroy: GDestroyNotify callback to be called when the bread crumb is destroyed - * - * Adds a new bread crumb to the end of the trail containing the specified text and - * icon. - * - * Stability: Unstable - */ - -void -hildon_bread_crumb_trail_push_icon (HildonBreadCrumbTrail *bct, - const gchar *text, - GtkWidget *icon, - gpointer id, - GDestroyNotify destroy) -{ - GtkWidget *widget; - - g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct)); - g_return_if_fail (text != NULL); - g_return_if_fail (GTK_IS_WIDGET (icon)); - - widget = _hildon_bread_crumb_widget_new_with_icon (icon, text); - if (bct->priv->item_list == NULL) - { - g_object_set (G_OBJECT (widget), "show-separator", FALSE, NULL); - } - attach_bread_crumb (bct, widget, id, destroy); -} - -/** - * hildon_bread_crumb_trail_pop: - * @bct: pointer to #HildonBreadCrumbTrail - * - * Removes the last bread crumb from the trail. - * - * Stability: Unstable - */ - -void -hildon_bread_crumb_trail_pop (HildonBreadCrumbTrail *bct) -{ - GtkWidget *child; - HildonBreadCrumbTrailPrivate *priv; - - g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct)); - - priv = bct->priv; - - if (priv->item_list == NULL) - return; - - if (priv->item_list) - { - child = GTK_WIDGET (priv->item_list->data); - gtk_container_remove (GTK_CONTAINER (bct), child); - } - - hildon_bread_crumb_trail_update_back_button_sensitivity (bct); -} - -/** - * hildon_bread_crumb_trail_clear: - * @bct: pointer to #HildonBreadCrumbTrail - * - * Removes all the bread crumbs from the bread crumb trail. - * - * Stability: Unstable - */ - -void -hildon_bread_crumb_trail_clear (HildonBreadCrumbTrail *bct) -{ - HildonBreadCrumbTrailPrivate *priv; - - g_return_if_fail (HILDON_IS_BREAD_CRUMB_TRAIL (bct)); - - priv = bct->priv; - - while (priv->item_list) - { - hildon_bread_crumb_trail_pop (bct); - } - - /* - Sensitivity hack from hell. We need to do this while - http://bugzilla.gnome.org/show_bug.cgi?id=56070 is not - fixed to allow repeated clicking on the back button if - someone clears and rebuilds the trail when it's clicked - */ - gtk_widget_hide (priv->back_button); - gtk_widget_show (priv->back_button); -} |