1 /* GAIL - The GNOME Accessibility Implementation Library
2 * Copyright 2001, 2002, 2003 Sun Microsystems Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
20 #include "gtkmenuitemaccessible.h"
21 #include "gtk/gtkmenuitemprivate.h"
23 struct _GtkMenuItemAccessiblePrivate
29 #define KEYBINDING_SEPARATOR ";"
31 static void menu_item_select (GtkMenuItem *item);
32 static void menu_item_deselect (GtkMenuItem *item);
34 static GtkWidget *get_label_from_container (GtkWidget *container);
35 static gchar *get_text_from_label_widget (GtkWidget *widget);
37 static gint menu_item_add_gtk (GtkContainer *container,
39 static gint menu_item_remove_gtk (GtkContainer *container,
42 static void atk_action_interface_init (AtkActionIface *iface);
43 static void atk_selection_interface_init (AtkSelectionIface *iface);
45 G_DEFINE_TYPE_WITH_CODE (GtkMenuItemAccessible, _gtk_menu_item_accessible, GTK_TYPE_CONTAINER_ACCESSIBLE,
46 G_IMPLEMENT_INTERFACE (ATK_TYPE_ACTION, atk_action_interface_init);
47 G_IMPLEMENT_INTERFACE (ATK_TYPE_SELECTION, atk_selection_interface_init))
50 gtk_menu_item_accessible_initialize (AtkObject *obj,
57 ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->initialize (obj, data);
59 g_signal_connect (data, "select", G_CALLBACK (menu_item_select), NULL);
60 g_signal_connect (data, "deselect", G_CALLBACK (menu_item_deselect), NULL);
62 widget = GTK_WIDGET (data);
63 parent = gtk_widget_get_parent (widget);
64 if (GTK_IS_MENU (parent))
66 GtkWidget *parent_widget;
68 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (parent));
70 if (!GTK_IS_MENU_ITEM (parent_widget))
71 parent_widget = gtk_widget_get_parent (widget);
73 atk_object_set_parent (obj, gtk_widget_get_accessible (parent_widget));
76 _gtk_widget_accessible_set_layer (GTK_WIDGET_ACCESSIBLE (obj), ATK_LAYER_POPUP);
78 obj->role = ATK_ROLE_MENU_ITEM;
80 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (data));
83 g_signal_connect (menu, "add", G_CALLBACK (menu_item_add_gtk), NULL);
84 g_signal_connect (menu, "remove", G_CALLBACK (menu_item_remove_gtk), NULL);
89 gtk_menu_item_accessible_get_n_children (AtkObject *obj)
95 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
99 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
104 children = gtk_container_get_children (GTK_CONTAINER (submenu));
105 count = g_list_length (children);
106 g_list_free (children);
112 gtk_menu_item_accessible_ref_child (AtkObject *obj,
115 AtkObject *accessible;
119 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
124 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
130 children = gtk_container_get_children (GTK_CONTAINER (submenu));
131 tmp_list = g_list_nth (children, i);
134 accessible = gtk_widget_get_accessible (GTK_WIDGET (tmp_list->data));
135 g_object_ref (accessible);
137 g_list_free (children);
144 gtk_menu_item_accessible_ref_state_set (AtkObject *obj)
146 AtkObject *menu_item;
147 AtkStateSet *state_set, *parent_state_set;
149 state_set = ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->ref_state_set (obj);
151 atk_state_set_add_state (state_set, ATK_STATE_SELECTABLE);
152 if (GTK_MENU_ITEM_ACCESSIBLE (obj)->priv->selected)
153 atk_state_set_add_state (state_set, ATK_STATE_SELECTED);
155 menu_item = atk_object_get_parent (obj);
159 if (!GTK_IS_MENU_ITEM (gtk_accessible_get_widget (GTK_ACCESSIBLE (menu_item))))
162 parent_state_set = atk_object_ref_state_set (menu_item);
163 if (!atk_state_set_contains_state (parent_state_set, ATK_STATE_SELECTED))
165 atk_state_set_remove_state (state_set, ATK_STATE_FOCUSED);
166 atk_state_set_remove_state (state_set, ATK_STATE_SHOWING);
168 g_object_unref (parent_state_set);
175 gtk_menu_item_accessible_get_role (AtkObject *obj)
179 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
180 if (widget != NULL &&
181 gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget)))
182 return ATK_ROLE_MENU;
184 return ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->get_role (obj);
188 gtk_menu_item_accessible_get_name (AtkObject *obj)
193 GtkMenuItemAccessible *accessible;
195 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
199 name = ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->get_name (obj);
203 accessible = GTK_MENU_ITEM_ACCESSIBLE (obj);
204 label = get_label_from_container (widget);
206 g_free (accessible->priv->text);
207 accessible->priv->text = get_text_from_label_widget (label);
209 return accessible->priv->text;
213 gtk_menu_item_accessible_finalize (GObject *object)
215 GtkMenuItemAccessible *accessible = GTK_MENU_ITEM_ACCESSIBLE (object);
217 g_free (accessible->priv->text);
219 G_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->finalize (object);
223 gtk_menu_item_accessible_notify_gtk (GObject *obj,
228 atk_obj = gtk_widget_get_accessible (GTK_WIDGET (obj));
230 if (strcmp (pspec->name, "label") == 0)
232 if (atk_obj->name == NULL)
233 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
234 g_signal_emit_by_name (atk_obj, "visible-data-changed");
237 GTK_WIDGET_ACCESSIBLE_CLASS (_gtk_menu_item_accessible_parent_class)->notify_gtk (obj, pspec);
241 _gtk_menu_item_accessible_class_init (GtkMenuItemAccessibleClass *klass)
243 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
244 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
245 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
247 widget_class->notify_gtk = gtk_menu_item_accessible_notify_gtk;
249 gobject_class->finalize = gtk_menu_item_accessible_finalize;
251 class->get_n_children = gtk_menu_item_accessible_get_n_children;
252 class->ref_child = gtk_menu_item_accessible_ref_child;
253 class->ref_state_set = gtk_menu_item_accessible_ref_state_set;
254 class->initialize = gtk_menu_item_accessible_initialize;
255 class->get_name = gtk_menu_item_accessible_get_name;
256 class->get_role = gtk_menu_item_accessible_get_role;
258 g_type_class_add_private (klass, sizeof (GtkMenuItemAccessiblePrivate));
262 _gtk_menu_item_accessible_init (GtkMenuItemAccessible *menu_item)
264 menu_item->priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_item,
265 GTK_TYPE_MENU_ITEM_ACCESSIBLE,
266 GtkMenuItemAccessiblePrivate);
270 get_label_from_container (GtkWidget *container)
273 GList *children, *tmp_list;
275 if (!GTK_IS_CONTAINER (container))
278 children = gtk_container_get_children (GTK_CONTAINER (container));
281 for (tmp_list = children; tmp_list != NULL; tmp_list = tmp_list->next)
283 if (GTK_IS_LABEL (tmp_list->data))
285 label = tmp_list->data;
288 else if (GTK_IS_CELL_VIEW (tmp_list->data))
290 label = tmp_list->data;
293 else if (GTK_IS_BOX (tmp_list->data))
295 label = get_label_from_container (GTK_WIDGET (tmp_list->data));
300 g_list_free (children);
306 get_text_from_label_widget (GtkWidget *label)
308 if (GTK_IS_LABEL (label))
309 return g_strdup (gtk_label_get_text (GTK_LABEL (label)));
310 else if (GTK_IS_CELL_VIEW (label))
319 model = gtk_cell_view_get_model (GTK_CELL_VIEW (label));
320 path = gtk_cell_view_get_displayed_row (GTK_CELL_VIEW (label));
321 gtk_tree_model_get_iter (model, &iter, path);
322 gtk_tree_path_free (path);
324 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (label));
325 gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
326 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (label));
329 for (l = cells; l; l = l->next)
331 GtkCellRenderer *cell = l->data;
333 if (GTK_IS_CELL_RENDERER_TEXT (cell))
335 g_object_get (cell, "text", &text, NULL);
349 ensure_menus_unposted (GtkMenuItemAccessible *menu_item)
354 parent = atk_object_get_parent (ATK_OBJECT (menu_item));
357 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (parent));
358 if (GTK_IS_MENU (widget))
360 if (gtk_widget_get_mapped (widget))
361 gtk_menu_shell_cancel (GTK_MENU_SHELL (widget));
365 parent = atk_object_get_parent (parent);
370 gtk_menu_item_accessible_do_action (AtkAction *action,
373 GtkWidget *item, *item_parent;
374 gboolean item_mapped;
376 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
383 if (!gtk_widget_get_sensitive (item) || !gtk_widget_get_visible (item))
386 item_parent = gtk_widget_get_parent (item);
387 if (!GTK_IS_MENU_SHELL (item_parent))
390 gtk_menu_shell_select_item (GTK_MENU_SHELL (item_parent), item);
391 item_mapped = gtk_widget_get_mapped (item);
393 /* This is what is called when <Return> is pressed for a menu item.
394 * The last argument means 'force hide'.
396 g_signal_emit_by_name (item_parent, "activate-current", 1);
398 ensure_menus_unposted (GTK_MENU_ITEM_ACCESSIBLE (action));
404 gtk_menu_item_accessible_get_n_actions (AtkAction *action)
408 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
412 if (!_gtk_menu_item_is_selectable (item))
419 gtk_menu_item_accessible_action_get_name (AtkAction *action,
422 if (i != 0 || gtk_menu_item_accessible_get_n_actions (action) == 0)
429 find_accel_by_widget (GtkAccelKey *key,
433 /* We assume that closure->data points to the widget
434 * pending gtk_widget_get_accel_closures being made public
436 return data == (gpointer) closure->data;
440 find_accel_by_closure (GtkAccelKey *key,
444 return data == (gpointer) closure;
447 /* This function returns a string of the form A;B;C where A is
448 * the keybinding for the widget; B is the keybinding to traverse
449 * from the menubar and C is the accelerator. The items in the
450 * keybinding to traverse from the menubar are separated by ":".
453 gtk_menu_item_accessible_get_keybinding (AtkAction *action,
456 gchar *keybinding = NULL;
457 gchar *item_keybinding = NULL;
458 gchar *full_keybinding = NULL;
459 gchar *accelerator = NULL;
461 GtkWidget *temp_item;
465 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
475 GdkModifierType mnemonic_modifier = 0;
477 gchar *key, *temp_keybinding;
479 child = gtk_bin_get_child (GTK_BIN (temp_item));
483 parent = gtk_widget_get_parent (temp_item);
485 /* parent can be NULL when activating a window from the panel */
488 if (GTK_IS_MENU_BAR (parent))
492 toplevel = gtk_widget_get_toplevel (parent);
493 if (toplevel && GTK_IS_WINDOW (toplevel))
495 gtk_window_get_mnemonic_modifier (GTK_WINDOW (toplevel));
498 if (GTK_IS_LABEL (child))
500 key_val = gtk_label_get_mnemonic_keyval (GTK_LABEL (child));
501 if (key_val != GDK_KEY_VoidSymbol)
503 key = gtk_accelerator_name (key_val, mnemonic_modifier);
505 temp_keybinding = g_strconcat (key, ":", full_keybinding, NULL);
507 temp_keybinding = g_strdup (key);
509 if (temp_item == item)
510 item_keybinding = g_strdup (key);
513 g_free (full_keybinding);
514 full_keybinding = temp_keybinding;
519 g_free (full_keybinding);
520 full_keybinding = NULL;
525 /* We have reached the menu bar so we are finished */
526 if (GTK_IS_MENU_BAR (parent))
529 g_return_val_if_fail (GTK_IS_MENU (parent), NULL);
530 temp_item = gtk_menu_get_attach_widget (GTK_MENU (parent));
531 if (!GTK_IS_MENU_ITEM (temp_item))
533 /* Menu is attached to something other than a menu item;
534 * probably an option menu
536 g_free (full_keybinding);
537 full_keybinding = NULL;
542 parent = gtk_widget_get_parent (item);
543 if (GTK_IS_MENU (parent))
545 GtkAccelGroup *group;
548 group = gtk_menu_get_accel_group (GTK_MENU (parent));
550 key = gtk_accel_group_find (group, find_accel_by_widget, item);
554 child = gtk_bin_get_child (GTK_BIN (item));
555 if (GTK_IS_ACCEL_LABEL (child))
557 GtkAccelLabel *accel_label;
558 GClosure *accel_closure;
560 accel_label = GTK_ACCEL_LABEL (child);
561 g_object_get (accel_label, "accel-closure", &accel_closure, NULL);
564 key = gtk_accel_group_find (gtk_accel_group_from_accel_closure (accel_closure),
565 find_accel_by_closure,
567 g_closure_unref (accel_closure);
573 accelerator = gtk_accelerator_name (key->accel_key, key->accel_mods);
576 /* Concatenate the bindings */
577 if (item_keybinding || full_keybinding || accelerator)
582 keybinding = g_strconcat (item_keybinding, KEYBINDING_SEPARATOR, NULL);
583 g_free (item_keybinding);
586 keybinding = g_strdup (KEYBINDING_SEPARATOR);
590 temp = g_strconcat (keybinding, full_keybinding,
591 KEYBINDING_SEPARATOR, NULL);
592 g_free (full_keybinding);
595 temp = g_strconcat (keybinding, KEYBINDING_SEPARATOR, NULL);
601 temp = g_strconcat (keybinding, accelerator, NULL);
602 g_free (accelerator);
612 atk_action_interface_init (AtkActionIface *iface)
614 iface->do_action = gtk_menu_item_accessible_do_action;
615 iface->get_n_actions = gtk_menu_item_accessible_get_n_actions;
616 iface->get_name = gtk_menu_item_accessible_action_get_name;
617 iface->get_keybinding = gtk_menu_item_accessible_get_keybinding;
621 menu_item_selection (GtkMenuItem *item,
624 AtkObject *obj, *parent;
627 obj = gtk_widget_get_accessible (GTK_WIDGET (item));
628 GTK_MENU_ITEM_ACCESSIBLE (obj)->priv->selected = selected;
629 atk_object_notify_state_change (obj, ATK_STATE_SELECTED, selected);
631 for (i = 0; i < atk_object_get_n_accessible_children (obj); i++)
634 child = atk_object_ref_accessible_child (obj, i);
635 atk_object_notify_state_change (child, ATK_STATE_SHOWING, selected);
636 g_object_unref (child);
638 parent = atk_object_get_parent (obj);
639 g_signal_emit_by_name (parent, "selection-changed");
643 gtk_menu_item_accessible_add_selection (AtkSelection *selection,
653 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
657 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
661 shell = GTK_MENU_SHELL (menu);
662 kids = gtk_container_get_children (GTK_CONTAINER (shell));
663 length = g_list_length (kids);
664 if (i < 0 || i > length)
670 child = g_list_nth_data (kids, i);
672 g_return_val_if_fail (GTK_IS_MENU_ITEM (child), FALSE);
673 gtk_menu_shell_select_item (shell, GTK_WIDGET (child));
678 gtk_menu_item_accessible_clear_selection (AtkSelection *selection)
683 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
687 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
691 gtk_menu_shell_deselect (GTK_MENU_SHELL (menu));
697 gtk_menu_item_accessible_ref_selection (AtkSelection *selection,
709 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
713 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
717 shell = GTK_MENU_SHELL (menu);
719 item = gtk_menu_shell_get_selected_item (shell);
722 obj = gtk_widget_get_accessible (item);
731 gtk_menu_item_accessible_get_selection_count (AtkSelection *selection)
737 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
741 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
745 shell = GTK_MENU_SHELL (menu);
747 if (gtk_menu_shell_get_selected_item (shell) != NULL)
754 gtk_menu_item_accessible_is_child_selected (AtkSelection *selection,
764 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
768 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
772 shell = GTK_MENU_SHELL (menu);
774 item = gtk_menu_shell_get_selected_item (shell);
778 kids = gtk_container_get_children (GTK_CONTAINER (shell));
779 j = g_list_index (kids, item);
786 gtk_menu_item_accessible_remove_selection (AtkSelection *selection,
797 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
801 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
805 shell = GTK_MENU_SHELL (menu);
807 item = gtk_menu_shell_get_selected_item (shell);
808 if (item && gtk_menu_item_get_submenu (GTK_MENU_ITEM (item)))
809 gtk_menu_shell_deselect (shell);
815 atk_selection_interface_init (AtkSelectionIface *iface)
817 iface->add_selection = gtk_menu_item_accessible_add_selection;
818 iface->clear_selection = gtk_menu_item_accessible_clear_selection;
819 iface->ref_selection = gtk_menu_item_accessible_ref_selection;
820 iface->get_selection_count = gtk_menu_item_accessible_get_selection_count;
821 iface->is_child_selected = gtk_menu_item_accessible_is_child_selected;
822 iface->remove_selection = gtk_menu_item_accessible_remove_selection;
826 menu_item_add_gtk (GtkContainer *container,
829 GtkWidget *parent_widget;
831 g_return_val_if_fail (GTK_IS_MENU (container), 1);
833 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (container));
834 if (GTK_IS_MENU_ITEM (parent_widget))
836 GTK_CONTAINER_ACCESSIBLE_CLASS (_gtk_menu_item_accessible_parent_class)->add_gtk (container, widget, gtk_widget_get_accessible (parent_widget));
843 menu_item_remove_gtk (GtkContainer *container,
846 GtkWidget *parent_widget;
848 g_return_val_if_fail (GTK_IS_MENU (container), 1);
850 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (container));
851 if (GTK_IS_MENU_ITEM (parent_widget))
853 GTK_CONTAINER_ACCESSIBLE_CLASS (_gtk_menu_item_accessible_parent_class)->remove_gtk (container, widget, gtk_widget_get_accessible (parent_widget));
858 menu_item_select (GtkMenuItem *item)
860 menu_item_selection (item, TRUE);
864 menu_item_deselect (GtkMenuItem *item)
866 menu_item_selection (item, FALSE);