3 * Copyright (C) 2010 Openismus GmbH
6 * Tristan Van Berkom <tristanvb@openismus.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
26 #include "gtktreemenu.h"
27 #include "gtkmarshalers.h"
28 #include "gtkmenuitem.h"
29 #include "gtktearoffmenuitem.h"
30 #include "gtkseparatormenuitem.h"
31 #include "gtkcellareabox.h"
32 #include "gtkcellareacontext.h"
33 #include "gtkcelllayout.h"
34 #include "gtkcellview.h"
35 #include "gtkprivate.h"
39 static GObject *gtk_tree_menu_constructor (GType type,
40 guint n_construct_properties,
41 GObjectConstructParam *construct_properties);
42 static void gtk_tree_menu_dispose (GObject *object);
43 static void gtk_tree_menu_finalize (GObject *object);
44 static void gtk_tree_menu_set_property (GObject *object,
48 static void gtk_tree_menu_get_property (GObject *object,
54 static void gtk_tree_menu_get_preferred_width (GtkWidget *widget,
57 static void gtk_tree_menu_get_preferred_height (GtkWidget *widget,
61 /* GtkCellLayoutIface */
62 static void gtk_tree_menu_cell_layout_init (GtkCellLayoutIface *iface);
63 static GtkCellArea *gtk_tree_menu_cell_layout_get_area (GtkCellLayout *layout);
66 /* TreeModel/DrawingArea callbacks and building menus/submenus */
67 static inline void rebuild_menu (GtkTreeMenu *menu);
68 static gboolean menu_occupied (GtkTreeMenu *menu,
73 static void relayout_item (GtkTreeMenu *menu,
77 static void gtk_tree_menu_populate (GtkTreeMenu *menu);
78 static GtkWidget *gtk_tree_menu_create_item (GtkTreeMenu *menu,
80 gboolean header_item);
81 static void gtk_tree_menu_create_submenu (GtkTreeMenu *menu,
84 static void gtk_tree_menu_set_area (GtkTreeMenu *menu,
86 static GtkWidget *gtk_tree_menu_get_path_item (GtkTreeMenu *menu,
88 static gboolean gtk_tree_menu_path_in_menu (GtkTreeMenu *menu,
90 gboolean *header_item);
91 static void row_inserted_cb (GtkTreeModel *model,
95 static void row_deleted_cb (GtkTreeModel *model,
98 static void row_reordered_cb (GtkTreeModel *model,
103 static void row_changed_cb (GtkTreeModel *model,
107 static void context_size_changed_cb (GtkCellAreaContext *context,
110 static void area_apply_attributes_cb (GtkCellArea *area,
111 GtkTreeModel *tree_model,
113 gboolean is_expander,
114 gboolean is_expanded,
116 static void item_activated_cb (GtkMenuItem *item,
118 static void submenu_activated_cb (GtkTreeMenu *submenu,
121 static void gtk_tree_menu_set_model_internal (GtkTreeMenu *menu,
122 GtkTreeModel *model);
126 struct _GtkTreeMenuPrivate
128 /* TreeModel and parent for this menu */
130 GtkTreeRowReference *root;
132 /* CellArea and context for this menu */
134 GtkCellAreaContext *context;
137 gulong size_changed_id;
138 gulong apply_attributes_id;
139 gulong row_inserted_id;
140 gulong row_deleted_id;
141 gulong row_reordered_id;
142 gulong row_changed_id;
150 guint32 menu_with_header : 1;
154 GtkTreeViewRowSeparatorFunc row_separator_func;
155 gpointer row_separator_data;
156 GDestroyNotify row_separator_destroy;
158 /* Submenu headers */
159 GtkTreeMenuHeaderFunc header_func;
160 gpointer header_data;
161 GDestroyNotify header_destroy;
176 SIGNAL_MENU_ACTIVATE,
180 static guint tree_menu_signals[N_SIGNALS] = { 0 };
181 static GQuark tree_menu_path_quark = 0;
183 G_DEFINE_TYPE_WITH_CODE (GtkTreeMenu, gtk_tree_menu, GTK_TYPE_MENU,
184 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
185 gtk_tree_menu_cell_layout_init));
188 gtk_tree_menu_init (GtkTreeMenu *menu)
190 GtkTreeMenuPrivate *priv;
192 menu->priv = G_TYPE_INSTANCE_GET_PRIVATE (menu,
200 priv->context = NULL;
202 priv->size_changed_id = 0;
203 priv->row_inserted_id = 0;
204 priv->row_deleted_id = 0;
205 priv->row_reordered_id = 0;
206 priv->row_changed_id = 0;
208 priv->wrap_width = 0;
209 priv->row_span_col = -1;
210 priv->col_span_col = -1;
212 priv->menu_with_header = FALSE;
213 priv->tearoff = FALSE;
215 priv->row_separator_func = NULL;
216 priv->row_separator_data = NULL;
217 priv->row_separator_destroy = NULL;
219 priv->header_func = NULL;
220 priv->header_data = NULL;
221 priv->header_destroy = NULL;
223 gtk_menu_set_reserve_toggle_size (GTK_MENU (menu), FALSE);
227 gtk_tree_menu_class_init (GtkTreeMenuClass *class)
229 GObjectClass *object_class = G_OBJECT_CLASS (class);
230 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
232 tree_menu_path_quark = g_quark_from_static_string ("gtk-tree-menu-path");
234 object_class->constructor = gtk_tree_menu_constructor;
235 object_class->dispose = gtk_tree_menu_dispose;
236 object_class->finalize = gtk_tree_menu_finalize;
237 object_class->set_property = gtk_tree_menu_set_property;
238 object_class->get_property = gtk_tree_menu_get_property;
240 widget_class->get_preferred_width = gtk_tree_menu_get_preferred_width;
241 widget_class->get_preferred_height = gtk_tree_menu_get_preferred_height;
243 tree_menu_signals[SIGNAL_MENU_ACTIVATE] =
244 g_signal_new (I_("menu-activate"),
245 G_OBJECT_CLASS_TYPE (object_class),
247 0, /* No class closure here */
249 _gtk_marshal_VOID__STRING,
250 G_TYPE_NONE, 1, G_TYPE_STRING);
252 g_object_class_install_property (object_class,
254 g_param_spec_object ("model",
255 P_("TreeMenu model"),
256 P_("The model for the tree menu"),
258 GTK_PARAM_READWRITE));
260 g_object_class_install_property (object_class,
262 g_param_spec_boxed ("root",
263 P_("TreeMenu root row"),
264 P_("The TreeMenu will display children of the "
267 GTK_PARAM_READWRITE));
269 g_object_class_install_property (object_class,
271 g_param_spec_object ("cell-area",
273 P_("The GtkCellArea used to layout cells"),
275 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
277 g_object_class_install_property (object_class,
279 g_param_spec_boolean ("tearoff",
281 P_("Whether the menu has a tearoff item"),
283 GTK_PARAM_READWRITE));
286 * GtkTreeMenu:wrap-width:
288 * If wrap-width is set to a positive value, the list will be
289 * displayed in multiple columns, the number of columns is
290 * determined by wrap-width.
294 g_object_class_install_property (object_class,
296 g_param_spec_int ("wrap-width",
298 P_("Wrap width for laying out items in a grid"),
302 GTK_PARAM_READWRITE));
305 * GtkTreeMenu:row-span-column:
307 * If this is set to a non-negative value, it must be the index of a column
308 * of type %G_TYPE_INT in the model.
310 * The values of that column are used to determine how many rows a value in
311 * the list will span. Therefore, the values in the model column pointed to
312 * by this property must be greater than zero and not larger than wrap-width.
316 g_object_class_install_property (object_class,
318 g_param_spec_int ("row-span-column",
319 P_("Row span column"),
320 P_("TreeModel column containing the row span values"),
324 GTK_PARAM_READWRITE));
327 * GtkTreeMenu:column-span-column:
329 * If this is set to a non-negative value, it must be the index of a column
330 * of type %G_TYPE_INT in the model.
332 * The values of that column are used to determine how many columns a value
333 * in the list will span.
337 g_object_class_install_property (object_class,
339 g_param_spec_int ("column-span-column",
340 P_("Column span column"),
341 P_("TreeModel column containing the column span values"),
345 GTK_PARAM_READWRITE));
347 g_type_class_add_private (object_class, sizeof (GtkTreeMenuPrivate));
350 /****************************************************************
352 ****************************************************************/
354 gtk_tree_menu_constructor (GType type,
355 guint n_construct_properties,
356 GObjectConstructParam *construct_properties)
360 GtkTreeMenuPrivate *priv;
362 object = G_OBJECT_CLASS (gtk_tree_menu_parent_class)->constructor
363 (type, n_construct_properties, construct_properties);
365 menu = GTK_TREE_MENU (object);
370 GtkCellArea *area = gtk_cell_area_box_new ();
372 gtk_tree_menu_set_area (menu, area);
375 priv->context = gtk_cell_area_create_context (priv->area);
377 priv->size_changed_id =
378 g_signal_connect (priv->context, "notify",
379 G_CALLBACK (context_size_changed_cb), menu);
385 gtk_tree_menu_dispose (GObject *object)
388 GtkTreeMenuPrivate *priv;
390 menu = GTK_TREE_MENU (object);
393 gtk_tree_menu_set_model (menu, NULL);
394 gtk_tree_menu_set_area (menu, NULL);
398 /* Disconnect signals */
399 g_signal_handler_disconnect (priv->context, priv->size_changed_id);
401 g_object_unref (priv->context);
402 priv->context = NULL;
403 priv->size_changed_id = 0;
406 G_OBJECT_CLASS (gtk_tree_menu_parent_class)->dispose (object);
410 gtk_tree_menu_finalize (GObject *object)
413 GtkTreeMenuPrivate *priv;
415 menu = GTK_TREE_MENU (object);
418 gtk_tree_menu_set_row_separator_func (menu, NULL, NULL, NULL);
419 gtk_tree_menu_set_header_func (menu, NULL, NULL, NULL);
422 gtk_tree_row_reference_free (priv->root);
424 G_OBJECT_CLASS (gtk_tree_menu_parent_class)->finalize (object);
428 gtk_tree_menu_set_property (GObject *object,
433 GtkTreeMenu *menu = GTK_TREE_MENU (object);
438 gtk_tree_menu_set_model (menu, g_value_get_object (value));
442 gtk_tree_menu_set_root (menu, g_value_get_boxed (value));
446 /* Construct-only, can only be assigned once */
447 gtk_tree_menu_set_area (menu, (GtkCellArea *)g_value_get_object (value));
451 gtk_tree_menu_set_tearoff (menu, g_value_get_boolean (value));
454 case PROP_WRAP_WIDTH:
455 gtk_tree_menu_set_wrap_width (menu, g_value_get_int (value));
458 case PROP_ROW_SPAN_COL:
459 gtk_tree_menu_set_row_span_column (menu, g_value_get_int (value));
462 case PROP_COL_SPAN_COL:
463 gtk_tree_menu_set_column_span_column (menu, g_value_get_int (value));
467 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
473 gtk_tree_menu_get_property (GObject *object,
478 GtkTreeMenu *menu = GTK_TREE_MENU (object);
479 GtkTreeMenuPrivate *priv = menu->priv;
484 g_value_set_object (value, priv->model);
488 g_value_set_boxed (value, priv->root);
492 g_value_set_object (value, priv->area);
496 g_value_set_boolean (value, priv->tearoff);
500 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
505 /****************************************************************
507 ****************************************************************/
509 /* We tell all the menu items to reserve space for the submenu
510 * indicator if there is at least one submenu, this way we ensure
511 * that every internal cell area gets allocated the
512 * same width (and requested height for the same appropriate width).
515 sync_reserve_submenu_size (GtkTreeMenu *menu)
518 gboolean has_submenu = FALSE;
520 children = gtk_container_get_children (GTK_CONTAINER (menu));
521 for (l = children; l; l = l->next)
523 GtkMenuItem *item = l->data;
525 if (gtk_menu_item_get_submenu (item) != NULL)
532 for (l = children; l; l = l->next)
534 GtkMenuItem *item = l->data;
536 gtk_menu_item_set_reserve_indicator (item, has_submenu);
539 g_list_free (children);
543 gtk_tree_menu_get_preferred_width (GtkWidget *widget,
547 GtkTreeMenu *menu = GTK_TREE_MENU (widget);
548 GtkTreeMenuPrivate *priv = menu->priv;
550 /* We leave the requesting work up to the cellviews which operate in the same
551 * context, reserving space for the submenu indicator if any of the items have
552 * submenus ensures that every cellview will receive the same allocated width.
554 * Since GtkMenu does hieght-for-width correctly, we know that the width of
555 * every cell will be requested before the height-for-widths are requested.
557 g_signal_handler_block (priv->context, priv->size_changed_id);
559 sync_reserve_submenu_size (menu);
561 GTK_WIDGET_CLASS (gtk_tree_menu_parent_class)->get_preferred_width (widget, minimum_size, natural_size);
563 g_signal_handler_unblock (priv->context, priv->size_changed_id);
567 gtk_tree_menu_get_preferred_height (GtkWidget *widget,
571 GtkTreeMenu *menu = GTK_TREE_MENU (widget);
572 GtkTreeMenuPrivate *priv = menu->priv;
574 g_signal_handler_block (priv->context, priv->size_changed_id);
576 sync_reserve_submenu_size (menu);
578 GTK_WIDGET_CLASS (gtk_tree_menu_parent_class)->get_preferred_height (widget, minimum_size, natural_size);
580 g_signal_handler_unblock (priv->context, priv->size_changed_id);
583 /****************************************************************
584 * GtkCellLayoutIface *
585 ****************************************************************/
587 gtk_tree_menu_cell_layout_init (GtkCellLayoutIface *iface)
589 iface->get_area = gtk_tree_menu_cell_layout_get_area;
593 gtk_tree_menu_cell_layout_get_area (GtkCellLayout *layout)
595 GtkTreeMenu *menu = GTK_TREE_MENU (layout);
596 GtkTreeMenuPrivate *priv = menu->priv;
602 /****************************************************************
603 * TreeModel callbacks/populating menus *
604 ****************************************************************/
606 gtk_tree_menu_get_path_item (GtkTreeMenu *menu,
609 GtkWidget *item = NULL;
612 children = gtk_container_get_children (GTK_CONTAINER (menu));
614 for (l = children; item == NULL && l != NULL; l = l->next)
616 GtkWidget *child = l->data;
617 GtkTreePath *path = NULL;
619 if (GTK_IS_SEPARATOR_MENU_ITEM (child))
621 GtkTreeRowReference *row =
622 g_object_get_qdata (G_OBJECT (child), tree_menu_path_quark);
626 path = gtk_tree_row_reference_get_path (row);
629 /* Return any first child where it's row-reference became invalid,
630 * this is because row-references get null paths before we recieve
631 * the "row-deleted" signal.
636 else if (!GTK_IS_TEAROFF_MENU_ITEM (child))
638 GtkWidget *view = gtk_bin_get_child (GTK_BIN (child));
640 /* It's always a cellview */
641 if (GTK_IS_CELL_VIEW (view))
642 path = gtk_cell_view_get_displayed_row (GTK_CELL_VIEW (view));
645 /* Return any first child where it's row-reference became invalid,
646 * this is because row-references get null paths before we recieve
647 * the "row-deleted" signal.
654 if (gtk_tree_path_compare (search, path) == 0)
657 gtk_tree_path_free (path);
661 g_list_free (children);
667 gtk_tree_menu_path_in_menu (GtkTreeMenu *menu,
669 gboolean *header_item)
671 GtkTreeMenuPrivate *priv = menu->priv;
672 gboolean in_menu = FALSE;
673 gboolean is_header = FALSE;
675 /* Check if the is in root of the model */
676 if (gtk_tree_path_get_depth (path) == 1)
681 /* If we are a submenu, compare the parent path */
682 else if (priv->root && gtk_tree_path_get_depth (path) > 1)
684 GtkTreePath *root_path = gtk_tree_row_reference_get_path (priv->root);
685 GtkTreePath *parent_path = gtk_tree_path_copy (path);
687 gtk_tree_path_up (parent_path);
691 if (gtk_tree_path_compare (root_path, parent_path) == 0)
694 if (!in_menu && priv->menu_with_header &&
695 gtk_tree_path_compare (root_path, path) == 0)
701 gtk_tree_path_free (root_path);
702 gtk_tree_path_free (parent_path);
706 *header_item = is_header;
712 gtk_tree_menu_path_needs_submenu (GtkTreeMenu *menu,
715 GtkWidget *item = NULL;
717 GtkTreePath *parent_path;
719 if (gtk_tree_path_get_depth (search) <= 1)
722 parent_path = gtk_tree_path_copy (search);
723 gtk_tree_path_up (parent_path);
725 children = gtk_container_get_children (GTK_CONTAINER (menu));
727 for (l = children; item == NULL && l != NULL; l = l->next)
729 GtkWidget *child = l->data;
730 GtkTreePath *path = NULL;
732 /* Separators dont get submenus, if it already has a submenu then let
733 * the submenu handle inserted rows */
734 if (!GTK_IS_SEPARATOR_MENU_ITEM (child) &&
735 !gtk_menu_item_get_submenu (GTK_MENU_ITEM (child)))
737 GtkWidget *view = gtk_bin_get_child (GTK_BIN (child));
739 /* It's always a cellview */
740 if (GTK_IS_CELL_VIEW (view))
741 path = gtk_cell_view_get_displayed_row (GTK_CELL_VIEW (view));
746 if (gtk_tree_path_compare (parent_path, path) == 0)
749 gtk_tree_path_free (path);
753 g_list_free (children);
754 gtk_tree_path_free (parent_path);
760 find_empty_submenu (GtkTreeMenu *menu)
762 GtkTreeMenuPrivate *priv = menu->priv;
764 GtkWidget *submenu = NULL;
766 children = gtk_container_get_children (GTK_CONTAINER (menu));
768 for (l = children; submenu == NULL && l != NULL; l = l->next)
770 GtkWidget *child = l->data;
771 GtkTreePath *path = NULL;
774 /* Separators dont get submenus, if it already has a submenu then let
775 * the submenu handle inserted rows */
776 if (!GTK_IS_SEPARATOR_MENU_ITEM (child) && !GTK_IS_TEAROFF_MENU_ITEM (child))
778 GtkWidget *view = gtk_bin_get_child (GTK_BIN (child));
780 /* It's always a cellview */
781 if (GTK_IS_CELL_VIEW (view))
782 path = gtk_cell_view_get_displayed_row (GTK_CELL_VIEW (view));
787 if (gtk_tree_model_get_iter (priv->model, &iter, path) &&
788 !gtk_tree_model_iter_has_child (priv->model, &iter))
789 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (child));
791 gtk_tree_path_free (path);
795 g_list_free (children);
801 row_inserted_cb (GtkTreeModel *model,
806 GtkTreeMenuPrivate *priv = menu->priv;
807 gint *indices, index, depth;
810 /* If the iter should be in this menu then go ahead and insert it */
811 if (gtk_tree_menu_path_in_menu (menu, path, NULL))
813 if (priv->wrap_width > 0)
817 /* Get the index of the path for this depth */
818 indices = gtk_tree_path_get_indices (path);
819 depth = gtk_tree_path_get_depth (path);
820 index = indices[depth -1];
822 /* Menus with a header include a menuitem for it's root node
823 * and a separator menu item */
824 if (priv->menu_with_header)
827 /* Index after the tearoff item for the root menu if
828 * there is a tearoff item
830 if (priv->root == NULL && priv->tearoff)
833 item = gtk_tree_menu_create_item (menu, iter, FALSE);
834 gtk_menu_shell_insert (GTK_MENU_SHELL (menu), item, index);
836 /* Resize everything */
837 gtk_cell_area_context_flush (menu->priv->context);
842 /* Create submenus for iters if we need to */
843 item = gtk_tree_menu_path_needs_submenu (menu, path);
846 GtkTreePath *item_path = gtk_tree_path_copy (path);
848 gtk_tree_path_up (item_path);
849 gtk_tree_menu_create_submenu (menu, item, item_path);
850 gtk_tree_path_free (item_path);
856 row_deleted_cb (GtkTreeModel *model,
860 GtkTreeMenuPrivate *priv = menu->priv;
863 /* If it's the header item we leave it to the parent menu
864 * to remove us from its menu
866 item = gtk_tree_menu_get_path_item (menu, path);
870 if (priv->wrap_width > 0)
874 /* Get rid of the deleted item */
875 gtk_widget_destroy (item);
877 /* Resize everything */
878 gtk_cell_area_context_flush (menu->priv->context);
883 /* It's up to the parent menu to destroy a child menu that becomes empty
884 * since the topmost menu belongs to the user and is allowed to have no contents */
885 GtkWidget *submenu = find_empty_submenu (menu);
887 gtk_widget_destroy (submenu);
892 row_reordered_cb (GtkTreeModel *model,
898 GtkTreeMenuPrivate *priv = menu->priv;
899 gboolean this_menu = FALSE;
901 if (path == NULL && priv->root == NULL)
905 GtkTreePath *root_path =
906 gtk_tree_row_reference_get_path (priv->root);
908 if (gtk_tree_path_compare (root_path, path) == 0)
911 gtk_tree_path_free (root_path);
919 menu_item_position (GtkTreeMenu *menu,
925 children = gtk_container_get_children (GTK_CONTAINER (menu));
926 for (position = 0, l = children; l; position++, l = l->next)
928 GtkWidget *iitem = l->data;
934 g_list_free (children);
940 row_changed_cb (GtkTreeModel *model,
945 GtkTreeMenuPrivate *priv = menu->priv;
946 gboolean is_separator = FALSE;
947 gboolean has_header = FALSE;
950 item = gtk_tree_menu_get_path_item (menu, path);
954 GtkTreePath *root_path =
955 gtk_tree_row_reference_get_path (priv->root);
957 if (root_path && gtk_tree_path_compare (root_path, path) == 0)
959 if (priv->header_func)
961 priv->header_func (priv->model, iter, priv->header_data);
963 if (has_header && !item)
965 item = gtk_separator_menu_item_new ();
966 gtk_widget_show (item);
967 gtk_menu_shell_prepend (GTK_MENU_SHELL (menu), item);
969 item = gtk_tree_menu_create_item (menu, iter, TRUE);
970 gtk_menu_shell_prepend (GTK_MENU_SHELL (menu), item);
972 priv->menu_with_header = TRUE;
974 else if (!has_header && item)
976 /* Destroy the header item and then the following separator */
977 gtk_widget_destroy (item);
978 gtk_widget_destroy (GTK_MENU_SHELL (menu)->children->data);
980 priv->menu_with_header = FALSE;
983 gtk_tree_path_free (root_path);
989 if (priv->wrap_width > 0)
990 /* Ugly, we need to rebuild the menu here if
991 * the row-span/row-column values change
996 if (priv->row_separator_func)
998 priv->row_separator_func (model, iter,
999 priv->row_separator_data);
1002 if (is_separator != GTK_IS_SEPARATOR_MENU_ITEM (item))
1004 gint position = menu_item_position (menu, item);
1006 gtk_widget_destroy (item);
1007 item = gtk_tree_menu_create_item (menu, iter, FALSE);
1008 gtk_menu_shell_insert (GTK_MENU_SHELL (menu), item, position);
1015 context_size_changed_cb (GtkCellAreaContext *context,
1019 if (!strcmp (pspec->name, "minimum-width") ||
1020 !strcmp (pspec->name, "natural-width") ||
1021 !strcmp (pspec->name, "minimum-height") ||
1022 !strcmp (pspec->name, "natural-height"))
1023 gtk_widget_queue_resize (menu);
1027 area_is_sensitive (GtkCellArea *area)
1029 GList *cells, *list;
1030 gboolean sensitive = FALSE;
1032 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
1034 for (list = cells; list; list = list->next)
1036 g_object_get (list->data, "sensitive", &sensitive, NULL);
1041 g_list_free (cells);
1047 area_apply_attributes_cb (GtkCellArea *area,
1048 GtkTreeModel *tree_model,
1050 gboolean is_expander,
1051 gboolean is_expanded,
1054 /* If the menu for this iter has a submenu */
1055 GtkTreeMenuPrivate *priv = menu->priv;
1061 path = gtk_tree_model_get_path (tree_model, iter);
1063 if (gtk_tree_menu_path_in_menu (menu, path, &is_header))
1065 item = gtk_tree_menu_get_path_item (menu, path);
1067 /* If there is no submenu, go ahead and update item sensitivity,
1068 * items with submenus are always sensitive */
1069 if (item && !gtk_menu_item_get_submenu (GTK_MENU_ITEM (item)))
1071 sensitive = area_is_sensitive (priv->area);
1073 gtk_widget_set_sensitive (item, sensitive);
1077 /* For header items we need to set the sensitivity
1078 * of the following separator item
1080 if (GTK_MENU_SHELL (menu)->children &&
1081 GTK_MENU_SHELL (menu)->children->next)
1083 GtkWidget *separator =
1084 GTK_MENU_SHELL (menu)->children->next->data;
1086 gtk_widget_set_sensitive (separator, sensitive);
1092 gtk_tree_path_free (path);
1096 gtk_tree_menu_set_area (GtkTreeMenu *menu,
1099 GtkTreeMenuPrivate *priv = menu->priv;
1103 g_signal_handler_disconnect (priv->area,
1104 priv->apply_attributes_id);
1105 priv->apply_attributes_id = 0;
1107 g_object_unref (priv->area);
1114 g_object_ref_sink (priv->area);
1116 priv->apply_attributes_id =
1117 g_signal_connect (priv->area, "apply-attributes",
1118 G_CALLBACK (area_apply_attributes_cb), menu);
1123 menu_occupied (GtkTreeMenu *menu,
1127 guint bottom_attach)
1131 for (i = GTK_MENU_SHELL (menu)->children; i; i = i->next)
1135 gtk_container_child_get (GTK_CONTAINER (menu),
1139 "bottom-attach", &b,
1143 /* look if this item intersects with the given coordinates */
1144 if (right_attach > l && left_attach < r && bottom_attach > t && top_attach < b)
1152 relayout_item (GtkTreeMenu *menu,
1157 GtkTreeMenuPrivate *priv = menu->priv;
1158 gint current_col = 0, current_row = 0;
1159 gint rows = 1, cols = 1;
1161 if (priv->col_span_col == -1 &&
1162 priv->row_span_col == -1 &&
1165 gtk_container_child_get (GTK_CONTAINER (menu), prev,
1166 "right-attach", ¤t_col,
1167 "top-attach", ¤t_row,
1169 if (current_col + cols > priv->wrap_width)
1177 if (priv->col_span_col != -1)
1178 gtk_tree_model_get (priv->model, iter,
1179 priv->col_span_col, &cols,
1181 if (priv->row_span_col != -1)
1182 gtk_tree_model_get (priv->model, iter,
1183 priv->row_span_col, &rows,
1188 if (current_col + cols > priv->wrap_width)
1194 if (!menu_occupied (menu,
1195 current_col, current_col + cols,
1196 current_row, current_row + rows))
1203 /* set attach props */
1204 gtk_menu_attach (GTK_MENU (menu), item,
1205 current_col, current_col + cols,
1206 current_row, current_row + rows);
1210 gtk_tree_menu_create_submenu (GtkTreeMenu *menu,
1214 GtkTreeMenuPrivate *priv = menu->priv;
1218 view = gtk_bin_get_child (GTK_BIN (item));
1219 gtk_cell_view_set_draw_sensitive (GTK_CELL_VIEW (view), TRUE);
1221 submenu = gtk_tree_menu_new_with_area (priv->area);
1223 gtk_tree_menu_set_row_separator_func (GTK_TREE_MENU (submenu),
1224 priv->row_separator_func,
1225 priv->row_separator_data,
1226 priv->row_separator_destroy);
1227 gtk_tree_menu_set_header_func (GTK_TREE_MENU (submenu),
1230 priv->header_destroy);
1232 gtk_tree_menu_set_wrap_width (GTK_TREE_MENU (submenu), priv->wrap_width);
1233 gtk_tree_menu_set_row_span_column (GTK_TREE_MENU (submenu), priv->row_span_col);
1234 gtk_tree_menu_set_column_span_column (GTK_TREE_MENU (submenu), priv->col_span_col);
1236 gtk_tree_menu_set_model_internal (GTK_TREE_MENU (submenu), priv->model);
1237 gtk_tree_menu_set_root (GTK_TREE_MENU (submenu), path);
1238 gtk_menu_item_set_submenu (GTK_MENU_ITEM (item), submenu);
1240 g_signal_connect (submenu, "menu-activate",
1241 G_CALLBACK (submenu_activated_cb), menu);
1245 gtk_tree_menu_create_item (GtkTreeMenu *menu,
1247 gboolean header_item)
1249 GtkTreeMenuPrivate *priv = menu->priv;
1250 GtkWidget *item, *view;
1252 gboolean is_separator = FALSE;
1254 path = gtk_tree_model_get_path (priv->model, iter);
1256 if (priv->row_separator_func)
1258 priv->row_separator_func (priv->model, iter,
1259 priv->row_separator_data);
1263 item = gtk_separator_menu_item_new ();
1264 gtk_widget_show (item);
1266 g_object_set_qdata_full (G_OBJECT (item),
1267 tree_menu_path_quark,
1268 gtk_tree_row_reference_new (priv->model, path),
1269 (GDestroyNotify)gtk_tree_row_reference_free);
1273 view = gtk_cell_view_new_with_context (priv->area, priv->context);
1274 item = gtk_menu_item_new ();
1275 gtk_widget_show (view);
1276 gtk_widget_show (item);
1278 gtk_cell_view_set_model (GTK_CELL_VIEW (view), priv->model);
1279 gtk_cell_view_set_displayed_row (GTK_CELL_VIEW (view), path);
1281 gtk_widget_show (view);
1282 gtk_container_add (GTK_CONTAINER (item), view);
1284 g_signal_connect (item, "activate", G_CALLBACK (item_activated_cb), menu);
1286 /* Add a GtkTreeMenu submenu to render the children of this row */
1287 if (header_item == FALSE &&
1288 gtk_tree_model_iter_has_child (priv->model, iter))
1289 gtk_tree_menu_create_submenu (menu, item, path);
1292 gtk_tree_path_free (path);
1298 rebuild_menu (GtkTreeMenu *menu)
1300 GtkTreeMenuPrivate *priv = menu->priv;
1302 /* Destroy all the menu items */
1303 gtk_container_foreach (GTK_CONTAINER (menu),
1304 (GtkCallback) gtk_widget_destroy, NULL);
1308 gtk_tree_menu_populate (menu);
1313 gtk_tree_menu_populate (GtkTreeMenu *menu)
1315 GtkTreeMenuPrivate *priv = menu->priv;
1316 GtkTreePath *path = NULL;
1319 gboolean valid = FALSE;
1320 GtkWidget *menu_item, *prev = NULL;
1326 path = gtk_tree_row_reference_get_path (priv->root);
1330 if (gtk_tree_model_get_iter (priv->model, &parent, path))
1332 valid = gtk_tree_model_iter_children (priv->model, &iter, &parent);
1334 if (priv->header_func &&
1335 priv->header_func (priv->model, &parent, priv->header_data))
1337 /* Add a submenu header for rows which desire one, used for
1338 * combo boxes to allow all rows to be activatable/selectable
1340 menu_item = gtk_tree_menu_create_item (menu, &parent, TRUE);
1341 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menu_item);
1343 menu_item = gtk_separator_menu_item_new ();
1344 gtk_widget_show (menu_item);
1345 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menu_item);
1348 priv->menu_with_header = TRUE;
1351 gtk_tree_path_free (path);
1355 /* Tearoff menu items only go in the root menu */
1358 menu_item = gtk_tearoff_menu_item_new ();
1359 gtk_widget_show (menu_item);
1361 if (priv->wrap_width > 0)
1362 gtk_menu_attach (GTK_MENU (menu), menu_item, 0, priv->wrap_width, 0, 1);
1364 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menu_item);
1369 valid = gtk_tree_model_iter_children (priv->model, &iter, NULL);
1372 /* Create a menu item for every row at the current depth, add a GtkTreeMenu
1373 * submenu for iters/items that have children */
1376 menu_item = gtk_tree_menu_create_item (menu, &iter, FALSE);
1378 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menu_item);
1380 if (priv->wrap_width > 0)
1381 relayout_item (menu, menu_item, &iter, prev);
1384 valid = gtk_tree_model_iter_next (priv->model, &iter);
1389 item_activated_cb (GtkMenuItem *item,
1396 /* Only activate leafs, not parents */
1397 if (!gtk_menu_item_get_submenu (item))
1399 view = GTK_CELL_VIEW (gtk_bin_get_child (GTK_BIN (item)));
1400 path = gtk_cell_view_get_displayed_row (view);
1401 path_str = gtk_tree_path_to_string (path);
1403 g_signal_emit (menu, tree_menu_signals[SIGNAL_MENU_ACTIVATE], 0, path_str);
1406 gtk_tree_path_free (path);
1411 submenu_activated_cb (GtkTreeMenu *submenu,
1415 g_signal_emit (menu, tree_menu_signals[SIGNAL_MENU_ACTIVATE], 0, path);
1418 /* Sets the model without rebuilding the menu, prevents
1419 * infinite recursion while building submenus (we wait
1420 * until the root is set and then build the menu) */
1422 gtk_tree_menu_set_model_internal (GtkTreeMenu *menu,
1423 GtkTreeModel *model)
1425 GtkTreeMenuPrivate *priv;
1429 if (priv->model != model)
1433 /* Disconnect signals */
1434 g_signal_handler_disconnect (priv->model,
1435 priv->row_inserted_id);
1436 g_signal_handler_disconnect (priv->model,
1437 priv->row_deleted_id);
1438 g_signal_handler_disconnect (priv->model,
1439 priv->row_reordered_id);
1440 g_signal_handler_disconnect (priv->model,
1441 priv->row_changed_id);
1442 priv->row_inserted_id = 0;
1443 priv->row_deleted_id = 0;
1444 priv->row_reordered_id = 0;
1445 priv->row_changed_id = 0;
1447 g_object_unref (priv->model);
1450 priv->model = model;
1454 g_object_ref (priv->model);
1456 /* Connect signals */
1457 priv->row_inserted_id = g_signal_connect (priv->model, "row-inserted",
1458 G_CALLBACK (row_inserted_cb), menu);
1459 priv->row_deleted_id = g_signal_connect (priv->model, "row-deleted",
1460 G_CALLBACK (row_deleted_cb), menu);
1461 priv->row_reordered_id = g_signal_connect (priv->model, "rows-reordered",
1462 G_CALLBACK (row_reordered_cb), menu);
1463 priv->row_changed_id = g_signal_connect (priv->model, "row-changed",
1464 G_CALLBACK (row_changed_cb), menu);
1469 /****************************************************************
1471 ****************************************************************/
1473 gtk_tree_menu_new (void)
1475 return (GtkWidget *)g_object_new (GTK_TYPE_TREE_MENU, NULL);
1479 gtk_tree_menu_new_with_area (GtkCellArea *area)
1481 return (GtkWidget *)g_object_new (GTK_TYPE_TREE_MENU,
1487 gtk_tree_menu_new_full (GtkCellArea *area,
1488 GtkTreeModel *model,
1491 return (GtkWidget *)g_object_new (GTK_TYPE_TREE_MENU,
1499 gtk_tree_menu_get_area (GtkTreeMenu *menu)
1501 g_return_val_if_fail (GTK_IS_TREE_MENU (menu), NULL);
1503 return menu->priv->area;
1507 gtk_tree_menu_set_model (GtkTreeMenu *menu,
1508 GtkTreeModel *model)
1510 g_return_if_fail (GTK_IS_TREE_MENU (menu));
1511 g_return_if_fail (model == NULL || GTK_IS_TREE_MODEL (model));
1513 gtk_tree_menu_set_model_internal (menu, model);
1515 rebuild_menu (menu);
1519 gtk_tree_menu_get_model (GtkTreeMenu *menu)
1521 GtkTreeMenuPrivate *priv;
1523 g_return_val_if_fail (GTK_IS_TREE_MENU (menu), NULL);
1531 gtk_tree_menu_set_root (GtkTreeMenu *menu,
1534 GtkTreeMenuPrivate *priv;
1536 g_return_if_fail (GTK_IS_TREE_MENU (menu));
1537 g_return_if_fail (menu->priv->model != NULL || path == NULL);
1542 gtk_tree_row_reference_free (priv->root);
1545 priv->root = gtk_tree_row_reference_new (priv->model, path);
1549 rebuild_menu (menu);
1553 gtk_tree_menu_get_root (GtkTreeMenu *menu)
1555 GtkTreeMenuPrivate *priv;
1557 g_return_val_if_fail (GTK_IS_TREE_MENU (menu), NULL);
1562 return gtk_tree_row_reference_get_path (priv->root);
1568 gtk_tree_menu_get_tearoff (GtkTreeMenu *menu)
1570 GtkTreeMenuPrivate *priv;
1572 g_return_val_if_fail (GTK_IS_TREE_MENU (menu), FALSE);
1576 return priv->tearoff;
1580 gtk_tree_menu_set_tearoff (GtkTreeMenu *menu,
1583 GtkTreeMenuPrivate *priv;
1585 g_return_if_fail (GTK_IS_TREE_MENU (menu));
1589 if (priv->tearoff != tearoff)
1591 priv->tearoff = tearoff;
1593 rebuild_menu (menu);
1595 g_object_notify (G_OBJECT (menu), "tearoff");
1600 gtk_tree_menu_get_wrap_width (GtkTreeMenu *menu)
1602 GtkTreeMenuPrivate *priv;
1604 g_return_val_if_fail (GTK_IS_TREE_MENU (menu), FALSE);
1608 return priv->wrap_width;
1612 gtk_tree_menu_set_wrap_width (GtkTreeMenu *menu,
1615 GtkTreeMenuPrivate *priv;
1617 g_return_if_fail (GTK_IS_TREE_MENU (menu));
1618 g_return_if_fail (width >= 0);
1622 if (priv->wrap_width != width)
1624 priv->wrap_width = width;
1626 rebuild_menu (menu);
1628 g_object_notify (G_OBJECT (menu), "wrap-width");
1633 gtk_tree_menu_get_row_span_column (GtkTreeMenu *menu)
1635 GtkTreeMenuPrivate *priv;
1637 g_return_val_if_fail (GTK_IS_TREE_MENU (menu), FALSE);
1641 return priv->row_span_col;
1645 gtk_tree_menu_set_row_span_column (GtkTreeMenu *menu,
1648 GtkTreeMenuPrivate *priv;
1650 g_return_if_fail (GTK_IS_TREE_MENU (menu));
1654 if (priv->row_span_col != row_span)
1656 priv->row_span_col = row_span;
1658 if (priv->wrap_width > 0)
1659 rebuild_menu (menu);
1661 g_object_notify (G_OBJECT (menu), "row-span-column");
1666 gtk_tree_menu_get_column_span_column (GtkTreeMenu *menu)
1668 GtkTreeMenuPrivate *priv;
1670 g_return_val_if_fail (GTK_IS_TREE_MENU (menu), FALSE);
1674 return priv->col_span_col;
1678 gtk_tree_menu_set_column_span_column (GtkTreeMenu *menu,
1681 GtkTreeMenuPrivate *priv;
1683 g_return_if_fail (GTK_IS_TREE_MENU (menu));
1687 if (priv->col_span_col != column_span)
1689 priv->col_span_col = column_span;
1691 if (priv->wrap_width > 0)
1692 rebuild_menu (menu);
1694 g_object_notify (G_OBJECT (menu), "column-span-column");
1698 GtkTreeViewRowSeparatorFunc
1699 gtk_tree_menu_get_row_separator_func (GtkTreeMenu *menu)
1701 GtkTreeMenuPrivate *priv;
1703 g_return_val_if_fail (GTK_IS_TREE_MENU (menu), NULL);
1707 return priv->row_separator_func;
1711 gtk_tree_menu_set_row_separator_func (GtkTreeMenu *menu,
1712 GtkTreeViewRowSeparatorFunc func,
1714 GDestroyNotify destroy)
1716 GtkTreeMenuPrivate *priv;
1718 g_return_if_fail (GTK_IS_TREE_MENU (menu));
1722 if (priv->row_separator_destroy)
1723 priv->row_separator_destroy (priv->row_separator_data);
1725 priv->row_separator_func = func;
1726 priv->row_separator_data = data;
1727 priv->row_separator_destroy = destroy;
1729 rebuild_menu (menu);
1732 GtkTreeMenuHeaderFunc
1733 gtk_tree_menu_get_header_func (GtkTreeMenu *menu)
1735 GtkTreeMenuPrivate *priv;
1737 g_return_val_if_fail (GTK_IS_TREE_MENU (menu), NULL);
1741 return priv->header_func;
1745 gtk_tree_menu_set_header_func (GtkTreeMenu *menu,
1746 GtkTreeMenuHeaderFunc func,
1748 GDestroyNotify destroy)
1750 GtkTreeMenuPrivate *priv;
1752 g_return_if_fail (GTK_IS_TREE_MENU (menu));
1756 if (priv->header_destroy)
1757 priv->header_destroy (priv->header_data);
1759 priv->header_func = func;
1760 priv->header_data = data;
1761 priv->header_destroy = destroy;
1763 rebuild_menu (menu);