Pileus Git - ~andy/gtk/blob - gtk/gtkmodelmenu.c

   1 /*
   2  * Copyright © 2011 Red Hat, Inc.
   3  * Copyright © 2011 Canonical Limited
   4  *
   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.
   9  *
  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.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Matthias Clasen <mclasen@redhat.com>
  19  *         Ryan Lortie <desrt@desrt.ca>
  20  */
  21
  22 #include "config.h"
  23
  24 #include "gtkmodelmenu.h"
  25
  26 #include "gtkmenu.h"
  27 #include "gtkmenubar.h"
  28 #include "gtkseparatormenuitem.h"
  29 #include "gtkmodelmenuitem.h"
  30 #include "gtkapplicationprivate.h"
  31
  32 typedef struct {
  33   GActionObservable *actions;
  34   GMenuModel        *model;
  35   GtkAccelGroup     *accels;
  36   GtkMenuShell      *shell;
  37   guint              update_idle;
  38   GSList            *connected;
  39   gboolean           with_separators;
  40   gint               n_items;
  41 } GtkModelMenuBinding;
  42
  43 static void
  44 gtk_model_menu_binding_items_changed (GMenuModel *model,
  45                                       gint        position,
  46                                       gint        removed,
  47                                       gint        added,
  48                                       gpointer    user_data);
  49 static void gtk_model_menu_binding_append_model (GtkModelMenuBinding *binding,
  50                                                  GMenuModel *model,
  51                                                  gboolean with_separators);
  52
  53 static void
  54 gtk_model_menu_binding_free (gpointer data)
  55 {
  56   GtkModelMenuBinding *binding = data;
  57
  58   /* disconnect all existing signal handlers */
  59   while (binding->connected)
  60     {
  61       g_signal_handlers_disconnect_by_func (binding->connected->data, gtk_model_menu_binding_items_changed, binding);
  62       g_object_unref (binding->connected->data);
  63
  64       binding->connected = g_slist_delete_link (binding->connected, binding->connected);
  65     }
  66
  67   if (binding->actions)
  68     g_object_unref (binding->actions);
  69   g_object_unref (binding->model);
  70
  71   g_slice_free (GtkModelMenuBinding, binding);
  72 }
  73
  74 static void
  75 gtk_model_menu_binding_append_item (GtkModelMenuBinding  *binding,
  76                                     GMenuModel           *model,
  77                                     gint                  item_index,
  78                                     gchar               **heading)
  79 {
  80   GMenuModel *section;
  81
  82   if ((section = g_menu_model_get_item_link (model, item_index, "section")))
  83     {
  84       g_menu_model_get_item_attribute (model, item_index, "label", "s", heading);
  85       gtk_model_menu_binding_append_model (binding, section, FALSE);
  86     }
  87   else
  88     {
  89       GtkMenuItem *item;
  90
  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));
  94       binding->n_items++;
  95     }
  96 }
  97
  98 static void
  99 gtk_model_menu_binding_append_model (GtkModelMenuBinding *binding,
 100                                      GMenuModel          *model,
 101                                      gboolean             with_separators)
 102 {
 103   gint n, i;
 104
 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));
 107
 108   /* Deciding if we should show a separator is a bit difficult.  There
 109    * are two types of separators:
 110    *
 111    *  - section headings (when sections have 'label' property)
 112    *
 113    *  - normal separators automatically put between sections
 114    *
 115    * The easiest way to think about it is that a section usually has a
 116    * separator (or heading) immediately before it.
 117    *
 118    * There are three exceptions to this general rule:
 119    *
 120    *  - empty sections don't get separators or headings
 121    *
 122    *  - sections only get separators and headings at the toplevel of a
 123    *    menu (ie: no separators on nested sections or in menubars)
 124    *
 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)
 127    *
 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.
 134    */
 135
 136   n = g_menu_model_get_n_items (model);
 137
 138   for (i = 0; i < n; i++)
 139     {
 140       gint our_position = binding->n_items;
 141       gchar *heading = NULL;
 142
 143       gtk_model_menu_binding_append_item (binding, model, i, &heading);
 144
 145       if (with_separators && our_position < binding->n_items)
 146         {
 147           GtkWidget *separator = NULL;
 148
 149           if (heading)
 150             {
 151               separator = gtk_menu_item_new_with_label (heading);
 152               gtk_widget_set_sensitive (separator, FALSE);
 153             }
 154           else if (our_position > 0)
 155             separator = gtk_separator_menu_item_new ();
 156
 157           if (separator)
 158             {
 159               gtk_menu_shell_insert (binding->shell, separator, our_position);
 160               gtk_widget_show (separator);
 161               binding->n_items++;
 162             }
 163         }
 164
 165       g_free (heading);
 166     }
 167 }
 168
 169 static void
 170 gtk_model_menu_binding_populate (GtkModelMenuBinding *binding)
 171 {
 172   GList *children;
 173
 174   /* remove current children */
 175   children = gtk_container_get_children (GTK_CONTAINER (binding->shell));
 176   while (children)
 177     {
 178       gtk_container_remove (GTK_CONTAINER (binding->shell), children->data);
 179       children = g_list_delete_link (children, children);
 180     }
 181
 182   binding->n_items = 0;
 183
 184   /* add new items from the model */
 185   gtk_model_menu_binding_append_model (binding, binding->model, binding->with_separators);
 186 }
 187
 188 static gboolean
 189 gtk_model_menu_binding_handle_changes (gpointer user_data)
 190 {
 191   GtkModelMenuBinding *binding = user_data;
 192
 193   /* disconnect all existing signal handlers */
 194   while (binding->connected)
 195     {
 196       g_signal_handlers_disconnect_by_func (binding->connected->data, gtk_model_menu_binding_items_changed, binding);
 197       g_object_unref (binding->connected->data);
 198
 199       binding->connected = g_slist_delete_link (binding->connected, binding->connected);
 200     }
 201
 202   gtk_model_menu_binding_populate (binding);
 203
 204   binding->update_idle = 0;
 205
 206   g_object_unref (binding->shell);
 207
 208   return G_SOURCE_REMOVE;
 209 }
 210
 211 static void
 212 gtk_model_menu_binding_items_changed (GMenuModel *model,
 213                                       gint        position,
 214                                       gint        removed,
 215                                       gint        added,
 216                                       gpointer    user_data)
 217 {
 218   GtkModelMenuBinding *binding = user_data;
 219
 220   if (binding->update_idle == 0)
 221     {
 222       binding->update_idle = gdk_threads_add_idle (gtk_model_menu_binding_handle_changes, user_data);
 223       g_object_ref (binding->shell);
 224     }
 225 }
 226
 227 static void
 228 gtk_model_menu_bind (GtkMenuShell      *shell,
 229                      GMenuModel        *model,
 230                      gboolean           with_separators)
 231 {
 232   GtkModelMenuBinding *binding;
 233
 234   binding = g_slice_new (GtkModelMenuBinding);
 235   binding->model = g_object_ref (model);
 236   binding->actions = NULL;
 237   binding->accels = NULL;
 238   binding->shell = shell;
 239   binding->update_idle = 0;
 240   binding->connected = NULL;
 241   binding->with_separators = with_separators;
 242
 243   g_object_set_data_full (G_OBJECT (shell), "gtk-model-menu-binding", binding, gtk_model_menu_binding_free);
 244 }
 245
 246
 247 static void
 248 gtk_model_menu_populate (GtkMenuShell      *shell,
 249                          GActionObservable *actions,
 250                          GtkAccelGroup     *accels)
 251 {
 252   GtkModelMenuBinding *binding;
 253
 254   binding = (GtkModelMenuBinding*) g_object_get_data (G_OBJECT (shell), "gtk-model-menu-binding");
 255
 256   binding->actions = g_object_ref (actions);
 257   binding->accels = accels;
 258
 259   gtk_model_menu_binding_populate (binding);
 260 }
 261
 262 GtkWidget *
 263 gtk_model_menu_create_menu (GMenuModel        *model,
 264                             GActionObservable *actions,
 265                             GtkAccelGroup     *accels)
 266 {
 267   GtkWidget *menu;
 268
 269   menu = gtk_menu_new ();
 270   gtk_menu_set_accel_group (GTK_MENU (menu), accels);
 271
 272   gtk_model_menu_bind (GTK_MENU_SHELL (menu), model, TRUE);
 273   gtk_model_menu_populate (GTK_MENU_SHELL (menu), actions, accels);
 274
 275   return menu;
 276 }
 277
 278 static void
 279 notify_attach (GtkMenu    *menu,
 280                GParamSpec *pspec,
 281                gpointer    data)
 282 {
 283   GtkWidget *widget;
 284   GtkWidget *toplevel;
 285   GActionObservable *actions;
 286   GtkAccelGroup *accels;
 287
 288   widget = gtk_menu_get_attach_widget (menu);
 289   toplevel = gtk_widget_get_toplevel (widget);
 290   if (GTK_IS_APPLICATION_WINDOW (toplevel))
 291     {
 292       actions = gtk_application_window_get_observable (GTK_APPLICATION_WINDOW (toplevel));
 293       accels = gtk_application_window_get_accel_group (GTK_APPLICATION_WINDOW (toplevel));
 294
 295       gtk_menu_set_accel_group (menu, accels);
 296       gtk_model_menu_populate (GTK_MENU_SHELL (menu), actions, accels);
 297     }
 298 }
 299
 300 /**
 301  * gtk_menu_new_from_model:
 302  * @model: a #GMenuModel
 303  *
 304  * Creates a #GtkMenu and populates it with menu items and
 305  * submenus according to @model.
 306  *
 307  * The created menu items are connected to actions found in the
 308  * #GtkApplicationWindow to which the menu belongs - typically
 309  * by means of being attached to a widget (see gtk_menu_attach_to_widget())
 310  * that is contained within the #GtkApplicationWindows widget hierarchy.
 311  *
 312  * Returns: a new #GtkMenu
 313  *
 314  * Since: 3.4
 315  */
 316 GtkWidget *
 317 gtk_menu_new_from_model (GMenuModel *model)
 318 {
 319   GtkWidget *menu;
 320
 321   menu = gtk_menu_new ();
 322   gtk_model_menu_bind (GTK_MENU_SHELL (menu), model, TRUE);
 323   g_signal_connect (menu, "notify::attach-widget",
 324                     G_CALLBACK (notify_attach), NULL);
 325
 326   return menu;
 327 }
 328
 329 GtkWidget *
 330 gtk_model_menu_create_menu_bar (GMenuModel        *model,
 331                                 GActionObservable *actions,
 332                                 GtkAccelGroup     *accels)
 333 {
 334   GtkWidget *menubar;
 335
 336   menubar = gtk_menu_bar_new ();
 337
 338   gtk_model_menu_bind (GTK_MENU_SHELL (menubar), model, FALSE);
 339   gtk_model_menu_populate (GTK_MENU_SHELL (menubar), actions, accels);
 340
 341   return menubar;
 342 }
 343
 344 static void
 345 hierarchy_changed (GtkMenuShell *shell,
 346                    GObject      *previous_toplevel,
 347                    gpointer      data)
 348 {
 349   GtkWidget *toplevel;
 350   GActionObservable *actions;
 351   GtkAccelGroup *accels;
 352
 353   toplevel = gtk_widget_get_toplevel (GTK_WIDGET (shell));
 354   if (GTK_IS_APPLICATION_WINDOW (toplevel))
 355     {
 356       actions = gtk_application_window_get_observable (GTK_APPLICATION_WINDOW (toplevel));
 357       accels = gtk_application_window_get_accel_group (GTK_APPLICATION_WINDOW (toplevel));
 358
 359       gtk_model_menu_populate (shell, actions, accels);
 360     }
 361 }
 362
 363 /**
 364  * gtk_menu_bar_new_from_model:
 365  * @model: a #GMenuModel
 366  *
 367  * Creates a new #GtkMenuBar and populates it with menu items
 368  * and submenus according to @model.
 369  *
 370  * The created menu items are connected to actions found in the
 371  * #GtkApplicationWindow to which the menu bar belongs - typically
 372  * by means of being contained within the #GtkApplicationWindows
 373  * widget hierarchy.
 374  *
 375  * Returns: a new #GtkMenuBar
 376  *
 377  * Since: 3.4
 378  */
 379 GtkWidget *
 380 gtk_menu_bar_new_from_model (GMenuModel *model)
 381 {
 382   GtkWidget *menubar;
 383
 384   menubar = gtk_menu_bar_new ();
 385
 386   gtk_model_menu_bind (GTK_MENU_SHELL (menubar), model, FALSE);
 387
 388   g_signal_connect (menubar, "hierarchy-changed",
 389                     G_CALLBACK (hierarchy_changed), NULL);
 390
 391   return menubar;
 392 }