]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkmenuitem.c
Deprecate widget flag: GTK_WIDGET_VISIBLE
[~andy/gtk] / gtk / gtkmenuitem.c
index 2ad13fc3a6f92b49337edf9e00a10c0e81788611..5e474a8d6922717b758c9392c969a3923ec9e10d 100644 (file)
 #include "gtkmenubar.h"
 #include "gtkseparatormenuitem.h"
 #include "gtkprivate.h"
+#include "gtkbuildable.h"
+#include "gtkactivatable.h"
 #include "gtkintl.h"
 #include "gtkalias.h"
 
+
+typedef struct {
+  GtkAction *action;
+  gboolean   use_action_appearance;
+} GtkMenuItemPrivate;
+
 enum {
   ACTIVATE,
   ACTIVATE_ITEM,
@@ -53,10 +61,15 @@ enum {
   PROP_SUBMENU,
   PROP_ACCEL_PATH,
   PROP_LABEL,
-  PROP_USE_UNDERLINE
+  PROP_USE_UNDERLINE,
+
+  /* activatable properties */
+  PROP_ACTIVATABLE_RELATED_ACTION,
+  PROP_ACTIVATABLE_USE_ACTION_APPEARANCE
 };
 
 
+static void gtk_menu_item_dispose        (GObject          *object);
 static void gtk_menu_item_set_property   (GObject          *object,
                                          guint             prop_id,
                                          const GValue     *value,
@@ -84,6 +97,7 @@ static void gtk_menu_item_parent_set     (GtkWidget        *widget,
 
 static void gtk_real_menu_item_select               (GtkItem     *item);
 static void gtk_real_menu_item_deselect             (GtkItem     *item);
+static void gtk_real_menu_item_activate             (GtkMenuItem *item);
 static void gtk_real_menu_item_activate_item        (GtkMenuItem *item);
 static void gtk_real_menu_item_toggle_size_request  (GtkMenuItem *menu_item,
                                                     gint        *requisition);
@@ -113,9 +127,41 @@ static void gtk_real_menu_item_set_label (GtkMenuItem     *menu_item,
 static G_CONST_RETURN gchar * gtk_real_menu_item_get_label (GtkMenuItem *menu_item);
 
 
+static void gtk_menu_item_buildable_interface_init (GtkBuildableIface   *iface);
+static void gtk_menu_item_buildable_add_child      (GtkBuildable        *buildable,
+                                                   GtkBuilder          *builder,
+                                                   GObject             *child,
+                                                   const gchar         *type);
+static void gtk_menu_item_buildable_custom_finished(GtkBuildable        *buildable,
+                                                   GtkBuilder          *builder,
+                                                   GObject             *child,
+                                                   const gchar         *tagname,
+                                                   gpointer             user_data);
+
+static void gtk_menu_item_activatable_interface_init (GtkActivatableIface  *iface);
+static void gtk_menu_item_update                     (GtkActivatable       *activatable,
+                                                     GtkAction            *action,
+                                                     const gchar          *property_name);
+static void gtk_menu_item_sync_action_properties     (GtkActivatable       *activatable,
+                                                     GtkAction            *action);
+static void gtk_menu_item_set_related_action         (GtkMenuItem          *menu_item, 
+                                                     GtkAction            *action);
+static void gtk_menu_item_set_use_action_appearance  (GtkMenuItem          *menu_item, 
+                                                     gboolean              use_appearance);
+
+
 static guint menu_item_signals[LAST_SIGNAL] = { 0 };
 
-G_DEFINE_TYPE (GtkMenuItem, gtk_menu_item, GTK_TYPE_ITEM)
+static GtkBuildableIface *parent_buildable_iface;
+
+G_DEFINE_TYPE_WITH_CODE (GtkMenuItem, gtk_menu_item, GTK_TYPE_ITEM,
+                        G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
+                                               gtk_menu_item_buildable_interface_init)
+                        G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIVATABLE,
+                                               gtk_menu_item_activatable_interface_init))
+
+#define GET_PRIVATE(object)  \
+  (G_TYPE_INSTANCE_GET_PRIVATE ((object), GTK_TYPE_MENU_ITEM, GtkMenuItemPrivate))
 
 static void
 gtk_menu_item_class_init (GtkMenuItemClass *klass)
@@ -126,6 +172,7 @@ gtk_menu_item_class_init (GtkMenuItemClass *klass)
   GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
   GtkItemClass *item_class = GTK_ITEM_CLASS (klass);
 
+  gobject_class->dispose      = gtk_menu_item_dispose;
   gobject_class->set_property = gtk_menu_item_set_property;
   gobject_class->get_property = gtk_menu_item_get_property;
 
@@ -146,15 +193,15 @@ gtk_menu_item_class_init (GtkMenuItemClass *klass)
   
   container_class->forall = gtk_menu_item_forall;
 
-  item_class->select = gtk_real_menu_item_select;
-  item_class->deselect = gtk_real_menu_item_deselect;
+  item_class->select      = gtk_real_menu_item_select;
+  item_class->deselect    = gtk_real_menu_item_deselect;
 
-  klass->activate = NULL;
-  klass->activate_item = gtk_real_menu_item_activate_item;
-  klass->toggle_size_request = gtk_real_menu_item_toggle_size_request;
+  klass->activate             = gtk_real_menu_item_activate;
+  klass->activate_item        = gtk_real_menu_item_activate_item;
+  klass->toggle_size_request  = gtk_real_menu_item_toggle_size_request;
   klass->toggle_size_allocate = gtk_real_menu_item_toggle_size_allocate;
-  klass->set_label = gtk_real_menu_item_set_label;
-  klass->get_label = gtk_real_menu_item_get_label;
+  klass->set_label            = gtk_real_menu_item_set_label;
+  klass->get_label            = gtk_real_menu_item_get_label;
 
   klass->hide_on_activate = TRUE;
 
@@ -257,7 +304,7 @@ gtk_menu_item_class_init (GtkMenuItemClass *klass)
                                    g_param_spec_string ("label",
                                                        P_("Label"),
                                                        P_("The text for the child label"),
-                                                       NULL,
+                                                       "",
                                                        GTK_PARAM_READWRITE));
 
   /**
@@ -277,6 +324,9 @@ gtk_menu_item_class_init (GtkMenuItemClass *klass)
                                                         FALSE,
                                                         GTK_PARAM_READWRITE));
 
+  g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_RELATED_ACTION, "related-action");
+  g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_USE_ACTION_APPEARANCE, "use-action-appearance");
+
   gtk_widget_class_install_style_property_parser (widget_class,
                                                  g_param_spec_enum ("selected-shadow-type",
                                                                     "Selected Shadow Type",
@@ -333,12 +383,19 @@ gtk_menu_item_class_init (GtkMenuItemClass *klass)
                                                              P_("The minimum desired width of the menu item in characters"),
                                                              0, G_MAXINT, 12,
                                                              GTK_PARAM_READABLE));
+
+  g_type_class_add_private (object_class, sizeof (GtkMenuItemPrivate));
 }
 
 static void
 gtk_menu_item_init (GtkMenuItem *menu_item)
 {
+  GtkMenuItemPrivate *priv = GET_PRIVATE (menu_item);
+
   GTK_WIDGET_SET_FLAGS (menu_item, GTK_NO_WINDOW);
+
+  priv->action = NULL;
+  priv->use_action_appearance = TRUE;
   
   menu_item->submenu = NULL;
   menu_item->toggle_size = 0;
@@ -388,6 +445,22 @@ gtk_menu_item_new_with_mnemonic (const gchar *label)
                       NULL);
 }
 
+static void
+gtk_menu_item_dispose (GObject *object)
+{
+  GtkMenuItem *menu_item = GTK_MENU_ITEM (object);
+  GtkMenuItemPrivate *priv = GET_PRIVATE (menu_item);
+
+  if (priv->action)
+    {
+      gtk_action_disconnect_accelerator (priv->action);
+      gtk_activatable_do_set_related_action (GTK_ACTIVATABLE (menu_item), NULL);
+      
+      priv->action = NULL;
+    }
+  G_OBJECT_CLASS (gtk_menu_item_parent_class)->dispose (object);
+}
+
 static void 
 gtk_menu_item_set_property (GObject      *object,
                            guint         prop_id,
@@ -413,7 +486,12 @@ gtk_menu_item_set_property (GObject      *object,
     case PROP_USE_UNDERLINE:
       gtk_menu_item_set_use_underline (menu_item, g_value_get_boolean (value));
       break;
-
+    case PROP_ACTIVATABLE_RELATED_ACTION:
+      gtk_menu_item_set_related_action (menu_item, g_value_get_object (value));
+      break;
+    case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
+      gtk_menu_item_set_use_action_appearance (menu_item, g_value_get_boolean (value));
+      break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -427,6 +505,7 @@ gtk_menu_item_get_property (GObject    *object,
                            GParamSpec *pspec)
 {
   GtkMenuItem *menu_item = GTK_MENU_ITEM (object);
+  GtkMenuItemPrivate *priv = GET_PRIVATE (menu_item);
   
   switch (prop_id)
     {
@@ -445,7 +524,12 @@ gtk_menu_item_get_property (GObject    *object,
     case PROP_USE_UNDERLINE:
       g_value_set_boolean (value, gtk_menu_item_get_use_underline (menu_item));
       break;
-
+    case PROP_ACTIVATABLE_RELATED_ACTION:
+      g_value_set_object (value, priv->action);
+      break;
+    case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
+      g_value_set_boolean (value, priv->use_action_appearance);
+      break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -474,10 +558,203 @@ gtk_menu_item_detacher (GtkWidget *widget,
   menu_item->submenu = NULL;
 }
 
+static void
+gtk_menu_item_buildable_interface_init (GtkBuildableIface *iface)
+{
+  parent_buildable_iface = g_type_interface_peek_parent (iface);
+  iface->add_child = gtk_menu_item_buildable_add_child;
+  iface->custom_finished = gtk_menu_item_buildable_custom_finished;
+}
+
+static void 
+gtk_menu_item_buildable_add_child (GtkBuildable *buildable,
+                                  GtkBuilder   *builder,
+                                  GObject      *child,
+                                  const gchar  *type)
+{
+  if (type && strcmp (type, "submenu") == 0)
+       gtk_menu_item_set_submenu (GTK_MENU_ITEM (buildable),
+                                  GTK_WIDGET (child));
+  else
+    parent_buildable_iface->add_child (buildable, builder, child, type);
+}
+
+
+static void 
+gtk_menu_item_buildable_custom_finished (GtkBuildable        *buildable,
+                                        GtkBuilder          *builder,
+                                        GObject             *child,
+                                        const gchar         *tagname,
+                                        gpointer             user_data)
+{
+  GtkWidget *toplevel;
+
+  if (strcmp (tagname, "accelerator") == 0)
+    {
+      GtkMenuShell *menu_shell = (GtkMenuShell *) GTK_WIDGET (buildable)->parent;
+      GtkWidget *attach;
+
+      if (menu_shell)
+       {
+         while (GTK_IS_MENU (menu_shell) &&
+                (attach = gtk_menu_get_attach_widget (GTK_MENU (menu_shell))) != NULL)
+           menu_shell = (GtkMenuShell *)attach->parent;
+         
+         toplevel = gtk_widget_get_toplevel (GTK_WIDGET (menu_shell));
+       }
+      else
+       {
+         /* Fall back to something ... */
+         toplevel = gtk_widget_get_toplevel (GTK_WIDGET (buildable));
+
+         g_warning ("found a GtkMenuItem '%s' without a parent GtkMenuShell, assigned accelerators wont work.",
+                    gtk_buildable_get_name (buildable));
+       }
+
+      /* Feed the correct toplevel to the GtkWidget accelerator parsing code */
+      _gtk_widget_buildable_finish_accelerator (GTK_WIDGET (buildable), toplevel, user_data);
+    }
+  else
+    parent_buildable_iface->custom_finished (buildable, builder, child, tagname, user_data);
+}
+
+
+static void
+gtk_menu_item_activatable_interface_init (GtkActivatableIface *iface)
+{
+  iface->update = gtk_menu_item_update;
+  iface->sync_action_properties = gtk_menu_item_sync_action_properties;
+}
+
+static void
+activatable_update_label (GtkMenuItem *menu_item, GtkAction *action)
+{
+  GtkWidget *child = GTK_BIN (menu_item)->child;
+
+  if (GTK_IS_LABEL (child))
+    {
+      const gchar *label;
+
+      label = gtk_action_get_label (action);
+      gtk_label_set_label (GTK_LABEL (child), label ? label : "");
+    }
+}
+
+gboolean _gtk_menu_is_empty (GtkWidget *menu);
+
+static void
+gtk_menu_item_update (GtkActivatable *activatable,
+                     GtkAction      *action,
+                     const gchar    *property_name)
+{
+  GtkMenuItem *menu_item = GTK_MENU_ITEM (activatable);
+  GtkMenuItemPrivate *priv = GET_PRIVATE (menu_item);
+
+  if (strcmp (property_name, "visible") == 0)
+    _gtk_action_sync_menu_visible (action, GTK_WIDGET (menu_item), 
+                                  _gtk_menu_is_empty (gtk_menu_item_get_submenu (menu_item)));
+  else if (strcmp (property_name, "sensitive") == 0)
+    gtk_widget_set_sensitive (GTK_WIDGET (menu_item), gtk_action_is_sensitive (action));
+  else if (priv->use_action_appearance)
+    {
+      if (strcmp (property_name, "label") == 0)
+       activatable_update_label (menu_item, action);
+    }
+}
+
+static void
+gtk_menu_item_sync_action_properties (GtkActivatable *activatable,
+                                     GtkAction      *action)
+{
+  GtkMenuItem *menu_item = GTK_MENU_ITEM (activatable);
+  GtkMenuItemPrivate *priv = GET_PRIVATE (menu_item);
+
+  if (!action)
+    return;
+
+  _gtk_action_sync_menu_visible (action, GTK_WIDGET (menu_item),
+                                _gtk_menu_is_empty (gtk_menu_item_get_submenu (menu_item)));
+
+  gtk_widget_set_sensitive (GTK_WIDGET (menu_item), gtk_action_is_sensitive (action));
+
+  if (priv->use_action_appearance)
+    {
+      GtkWidget *label = GTK_BIN (menu_item)->child;
+
+      /* make sure label is a label */
+      if (label && !GTK_IS_LABEL (label))
+       {
+         gtk_container_remove (GTK_CONTAINER (menu_item), label);
+         label = NULL;
+       }
+
+      if (!label)
+       label = g_object_new (GTK_TYPE_ACCEL_LABEL,
+                             "use-underline", TRUE,
+                             "xalign", 0.0,
+                             "visible", TRUE,
+                             "parent", menu_item,
+                             NULL);
+
+      if (GTK_IS_ACCEL_LABEL (label) && gtk_action_get_accel_path (action))
+       g_object_set (label,
+                     "accel-closure", gtk_action_get_accel_closure (action),
+                     NULL);
+
+      activatable_update_label (menu_item, action);
+    }
+}
+
+static void
+gtk_menu_item_set_related_action (GtkMenuItem *menu_item,
+                                 GtkAction   *action)
+{
+    GtkMenuItemPrivate *priv = GET_PRIVATE (menu_item);
+
+    if (priv->action == action)
+      return;
+
+    if (priv->action)
+      {
+       gtk_action_disconnect_accelerator (priv->action);
+      }
+
+    if (action)
+      {
+       const gchar *accel_path;
+       
+       accel_path = gtk_action_get_accel_path (action);
+       if (accel_path)
+         {
+           gtk_action_connect_accelerator (action);
+           gtk_menu_item_set_accel_path (menu_item, accel_path);
+         }
+      }
+
+    gtk_activatable_do_set_related_action (GTK_ACTIVATABLE (menu_item), action);
+
+    priv->action = action;
+}
+
+static void
+gtk_menu_item_set_use_action_appearance (GtkMenuItem *menu_item,
+                                        gboolean     use_appearance)
+{
+    GtkMenuItemPrivate *priv = GET_PRIVATE (menu_item);
+
+    if (priv->use_action_appearance != use_appearance)
+      {
+       priv->use_action_appearance = use_appearance;
+
+       gtk_activatable_sync_action_properties (GTK_ACTIVATABLE (menu_item), priv->action);
+      }
+}
+
+
 /**
  * gtk_menu_item_set_submenu:
  * @menu_item: a #GtkMenuItem
- * @submenu: the submenu, or %NULL
+ * @submenu: (allow-none): the submenu, or %NULL
  *
  * Sets or replaces the menu item's submenu, or removes it when a %NULL
  * submenu is passed.
@@ -598,7 +875,7 @@ void
 gtk_menu_item_activate (GtkMenuItem *menu_item)
 {
   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
-  
+
   g_signal_emit (menu_item, menu_item_signals[ACTIVATE], 0);
 }
 
@@ -705,7 +982,7 @@ gtk_menu_item_size_request (GtkWidget      *widget,
       (child_pack_dir == GTK_PACK_DIRECTION_TTB || child_pack_dir == GTK_PACK_DIRECTION_BTT))
     requisition->height += 2 * horizontal_padding;
 
-  if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
+  if (bin->child && gtk_widget_get_visible (bin->child))
     {
       GtkRequisition child_requisition;
       
@@ -920,7 +1197,7 @@ gtk_menu_item_paint (GtkWidget    *widget,
   gint x, y;
   gint border_width = GTK_CONTAINER (widget)->border_width;
 
-  if (GTK_WIDGET_DRAWABLE (widget))
+  if (gtk_widget_is_drawable (widget))
     {
       menu_item = GTK_MENU_ITEM (widget);
 
@@ -1041,7 +1318,7 @@ gtk_menu_item_expose (GtkWidget      *widget,
   g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
   g_return_val_if_fail (event != NULL, FALSE);
 
-  if (GTK_WIDGET_DRAWABLE (widget))
+  if (gtk_widget_is_drawable (widget))
     {
       gtk_menu_item_paint (widget, &event->area);
 
@@ -1097,6 +1374,9 @@ static gboolean
 gtk_menu_item_mnemonic_activate (GtkWidget *widget,
                                 gboolean   group_cycling)
 {
+  if (GTK_IS_MENU_SHELL (widget->parent))
+    _gtk_menu_shell_set_keyboard_mode (GTK_MENU_SHELL (widget->parent), TRUE);
+
   if (group_cycling &&
       widget->parent &&
       GTK_IS_MENU_SHELL (widget->parent) &&
@@ -1111,13 +1391,27 @@ gtk_menu_item_mnemonic_activate (GtkWidget *widget,
   return TRUE;
 }
 
+static void 
+gtk_real_menu_item_activate (GtkMenuItem *menu_item)
+{
+  GtkMenuItemPrivate *priv;
+
+  priv = GET_PRIVATE (menu_item);
+
+  if (priv->action)
+    gtk_action_activate (priv->action);
+}
+
+
 static void
 gtk_real_menu_item_activate_item (GtkMenuItem *menu_item)
 {
+  GtkMenuItemPrivate *priv;
   GtkWidget *widget;
 
   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
 
+  priv   = GET_PRIVATE (menu_item);
   widget = GTK_WIDGET (menu_item);
   
   if (widget->parent &&
@@ -1195,7 +1489,7 @@ gtk_menu_item_real_popup_submenu (GtkWidget *widget,
 {
   GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
 
-  if (GTK_WIDGET_IS_SENSITIVE (menu_item->submenu) && widget->parent)
+  if (gtk_widget_is_sensitive (menu_item->submenu) && widget->parent)
     {
       gboolean take_focus;
       GtkMenuPositionFunc menu_position_func;
@@ -1526,7 +1820,7 @@ gtk_menu_item_position_menu (GtkMenu  *menu,
 
   gtk_menu_set_monitor (menu, monitor_num);
 
-  if (!GTK_WIDGET_VISIBLE (menu->toplevel))
+  if (!gtk_widget_get_visible (menu->toplevel))
     {
       gtk_window_set_type_hint (GTK_WINDOW (menu->toplevel), menu_item->from_menubar?
                                GDK_WINDOW_TYPE_HINT_DROPDOWN_MENU : GDK_WINDOW_TYPE_HINT_POPUP_MENU);
@@ -1618,7 +1912,7 @@ gtk_menu_item_can_activate_accel (GtkWidget *widget,
                                  guint      signal_id)
 {
   /* Chain to the parent GtkMenu for further checks */
-  return (GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_VISIBLE (widget) &&
+  return (gtk_widget_is_sensitive (widget) && gtk_widget_get_visible (widget) &&
           widget->parent && gtk_widget_can_activate_accel (widget->parent, signal_id));
 }
 
@@ -1710,7 +2004,7 @@ _gtk_menu_item_refresh_accel_path (GtkMenuItem   *menu_item,
 /**
  * gtk_menu_item_set_accel_path
  * @menu_item:  a valid #GtkMenuItem
- * @accel_path: accelerator path, corresponding to this menu item's
+ * @accel_path: (allow-none): accelerator path, corresponding to this menu item's
  *              functionality, or %NULL to unset the current path.
  *
  * Set the accelerator path on @menu_item, through which runtime changes of the
@@ -1807,8 +2101,8 @@ _gtk_menu_item_is_selectable (GtkWidget *menu_item)
   if ((!GTK_BIN (menu_item)->child &&
        G_OBJECT_TYPE (menu_item) == GTK_TYPE_MENU_ITEM) ||
       GTK_IS_SEPARATOR_MENU_ITEM (menu_item) ||
-      !GTK_WIDGET_IS_SENSITIVE (menu_item) ||
-      !GTK_WIDGET_VISIBLE (menu_item))
+      !gtk_widget_is_sensitive (menu_item) ||
+      !gtk_widget_get_visible (menu_item))
     return FALSE;
 
   return TRUE;