2 * Copyright © 2011 Red Hat, Inc.
3 * Copyright © 2011 Canonical Limited
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the licence, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Matthias Clasen <mclasen@redhat.com>
21 * Ryan Lortie <desrt@desrt.ca>
26 #include "gtkmodelmenu.h"
29 #include "gtkmenubar.h"
30 #include "gtkseparatormenuitem.h"
31 #include "gtkmodelmenuitem.h"
34 GActionObservable *actions;
36 GtkAccelGroup *accels;
40 gboolean with_separators;
42 } GtkModelMenuBinding;
45 gtk_model_menu_binding_items_changed (GMenuModel *model,
50 static void gtk_model_menu_binding_append_model (GtkModelMenuBinding *binding,
52 gboolean with_separators);
55 gtk_model_menu_binding_free (gpointer data)
57 GtkModelMenuBinding *binding = data;
59 /* disconnect all existing signal handlers */
60 while (binding->connected)
62 g_signal_handlers_disconnect_by_func (binding->connected->data, gtk_model_menu_binding_items_changed, binding);
63 g_object_unref (binding->connected->data);
65 binding->connected = g_slist_delete_link (binding->connected, binding->connected);
68 g_object_unref (binding->actions);
69 g_object_unref (binding->model);
71 g_slice_free (GtkModelMenuBinding, binding);
75 gtk_model_menu_binding_append_item (GtkModelMenuBinding *binding,
82 if ((section = g_menu_model_get_item_link (model, item_index, "section")))
84 g_menu_model_get_item_attribute (model, item_index, "label", "s", heading);
85 gtk_model_menu_binding_append_model (binding, section, FALSE);
91 item = gtk_model_menu_item_new (model, item_index, binding->actions, binding->accels);
92 gtk_menu_shell_append (binding->shell, GTK_WIDGET (item));
93 gtk_widget_show (GTK_WIDGET (item));
99 gtk_model_menu_binding_append_model (GtkModelMenuBinding *binding,
101 gboolean with_separators)
105 g_signal_connect (model, "items-changed", G_CALLBACK (gtk_model_menu_binding_items_changed), binding);
106 binding->connected = g_slist_prepend (binding->connected, g_object_ref (model));
108 /* Deciding if we should show a separator is a bit difficult. There
109 * are two types of separators:
111 * - section headings (when sections have 'label' property)
113 * - normal separators automatically put between sections
115 * The easiest way to think about it is that a section usually has a
116 * separator (or heading) immediately before it.
118 * There are three exceptions to this general rule:
120 * - empty sections don't get separators or headings
122 * - sections only get separators and headings at the toplevel of a
123 * menu (ie: no separators on nested sections or in menubars)
125 * - the first section in the menu doesn't get a normal separator,
126 * but it can get a header (if it's not empty)
128 * Unfortunately, we cannot simply check the size of the section in
129 * order to determine if we should place a header: the section may
130 * contain other sections that are themselves empty. Instead, we need
131 * to append the section, and check if we ended up with any actual
132 * content. If we did, then we need to insert before that content.
133 * We use 'our_position' to keep track of this.
136 n = g_menu_model_get_n_items (model);
138 for (i = 0; i < n; i++)
140 gint our_position = binding->n_items;
141 gchar *heading = NULL;
143 gtk_model_menu_binding_append_item (binding, model, i, &heading);
145 if (with_separators && our_position < binding->n_items)
147 GtkWidget *separator = NULL;
151 separator = gtk_menu_item_new_with_label (heading);
152 gtk_widget_set_sensitive (separator, FALSE);
154 else if (our_position > 0)
155 separator = gtk_separator_menu_item_new ();
159 gtk_menu_shell_insert (binding->shell, separator, our_position);
160 gtk_widget_show (separator);
170 gtk_model_menu_binding_populate (GtkModelMenuBinding *binding)
174 /* remove current children */
175 children = gtk_container_get_children (GTK_CONTAINER (binding->shell));
178 gtk_container_remove (GTK_CONTAINER (binding->shell), children->data);
179 children = g_list_delete_link (children, children);
182 binding->n_items = 0;
184 /* add new items from the model */
185 gtk_model_menu_binding_append_model (binding, binding->model, binding->with_separators);
189 gtk_model_menu_binding_handle_changes (gpointer user_data)
191 GtkModelMenuBinding *binding = user_data;
193 /* disconnect all existing signal handlers */
194 while (binding->connected)
196 g_signal_handlers_disconnect_by_func (binding->connected->data, gtk_model_menu_binding_items_changed, binding);
197 g_object_unref (binding->connected->data);
199 binding->connected = g_slist_delete_link (binding->connected, binding->connected);
202 gtk_model_menu_binding_populate (binding);
204 binding->update_idle = 0;
206 g_object_unref (binding->shell);
208 return G_SOURCE_REMOVE;
212 gtk_model_menu_binding_items_changed (GMenuModel *model,
218 GtkModelMenuBinding *binding = user_data;
220 if (binding->update_idle == 0)
222 binding->update_idle = gdk_threads_add_idle (gtk_model_menu_binding_handle_changes, user_data);
223 g_object_ref (binding->shell);
228 gtk_model_menu_bind (GtkMenuShell *shell,
230 GActionObservable *actions,
231 GtkAccelGroup *accels,
232 gboolean with_separators)
234 GtkModelMenuBinding *binding;
236 binding = g_slice_new (GtkModelMenuBinding);
237 binding->model = g_object_ref (model);
238 binding->actions = g_object_ref (actions);
239 binding->accels = accels;
240 binding->shell = shell;
241 binding->update_idle = 0;
242 binding->connected = NULL;
243 binding->with_separators = with_separators;
245 g_object_set_data_full (G_OBJECT (shell), "gtk-model-menu-binding", binding, gtk_model_menu_binding_free);
246 gtk_model_menu_binding_populate (binding);
250 gtk_model_menu_create_menu (GMenuModel *model,
251 GActionObservable *actions,
252 GtkAccelGroup *accels)
256 menu = gtk_menu_new ();
257 gtk_menu_set_accel_group (GTK_MENU (menu), accels);
258 gtk_model_menu_bind (GTK_MENU_SHELL (menu), model, actions, accels, TRUE);
264 gtk_model_menu_create_menu_bar (GMenuModel *model,
265 GActionObservable *actions,
266 GtkAccelGroup *accels)
270 menubar = gtk_menu_bar_new ();
271 gtk_model_menu_bind (GTK_MENU_SHELL (menubar), model, actions, accels, FALSE);