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 #define KEYBINDING_SEPARATOR ";"
25 static void menu_item_select (GtkMenuItem *item);
26 static void menu_item_deselect (GtkMenuItem *item);
28 static GtkWidget *get_label_from_container (GtkWidget *container);
29 static gchar *get_text_from_label_widget (GtkWidget *widget);
31 static gint menu_item_add_gtk (GtkContainer *container,
33 static gint menu_item_remove_gtk (GtkContainer *container,
36 static void atk_action_interface_init (AtkActionIface *iface);
37 static void atk_selection_interface_init (AtkSelectionIface *iface);
39 G_DEFINE_TYPE_WITH_CODE (GtkMenuItemAccessible, _gtk_menu_item_accessible, GTK_TYPE_CONTAINER_ACCESSIBLE,
40 G_IMPLEMENT_INTERFACE (ATK_TYPE_ACTION, atk_action_interface_init);
41 G_IMPLEMENT_INTERFACE (ATK_TYPE_SELECTION, atk_selection_interface_init))
44 gtk_menu_item_accessible_initialize (AtkObject *obj,
51 ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->initialize (obj, data);
53 g_signal_connect (data, "select", G_CALLBACK (menu_item_select), NULL);
54 g_signal_connect (data, "deselect", G_CALLBACK (menu_item_deselect), NULL);
56 widget = GTK_WIDGET (data);
57 parent = gtk_widget_get_parent (widget);
58 if (GTK_IS_MENU (parent))
60 GtkWidget *parent_widget;
62 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (parent));
64 if (!GTK_IS_MENU_ITEM (parent_widget))
65 parent_widget = gtk_widget_get_parent (widget);
67 atk_object_set_parent (obj, gtk_widget_get_accessible (parent_widget));
70 GTK_WIDGET_ACCESSIBLE (obj)->layer = ATK_LAYER_POPUP;
72 obj->role = ATK_ROLE_MENU_ITEM;
74 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (data));
77 g_signal_connect (menu, "add", G_CALLBACK (menu_item_add_gtk), NULL);
78 g_signal_connect (menu, "remove", G_CALLBACK (menu_item_remove_gtk), NULL);
83 gtk_menu_item_accessible_get_n_children (AtkObject *obj)
89 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
93 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
98 children = gtk_container_get_children (GTK_CONTAINER (submenu));
99 count = g_list_length (children);
100 g_list_free (children);
106 gtk_menu_item_accessible_ref_child (AtkObject *obj,
109 AtkObject *accessible;
113 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
118 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
124 children = gtk_container_get_children (GTK_CONTAINER (submenu));
125 tmp_list = g_list_nth (children, i);
128 accessible = gtk_widget_get_accessible (GTK_WIDGET (tmp_list->data));
129 g_object_ref (accessible);
131 g_list_free (children);
138 gtk_menu_item_accessible_ref_state_set (AtkObject *obj)
140 AtkObject *menu_item;
141 AtkStateSet *state_set, *parent_state_set;
143 state_set = ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->ref_state_set (obj);
145 menu_item = atk_object_get_parent (obj);
149 if (!GTK_IS_MENU_ITEM (gtk_accessible_get_widget (GTK_ACCESSIBLE (menu_item))))
152 parent_state_set = atk_object_ref_state_set (menu_item);
153 if (!atk_state_set_contains_state (parent_state_set, ATK_STATE_SELECTED))
155 atk_state_set_remove_state (state_set, ATK_STATE_FOCUSED);
156 atk_state_set_remove_state (state_set, ATK_STATE_SHOWING);
158 g_object_unref (parent_state_set);
165 gtk_menu_item_accessible_get_role (AtkObject *obj)
169 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
170 if (widget != NULL &&
171 gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget)))
172 return ATK_ROLE_MENU;
174 return ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->get_role (obj);
178 gtk_menu_item_accessible_get_name (AtkObject *obj)
183 GtkMenuItemAccessible *accessible;
185 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
189 name = ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->get_name (obj);
193 accessible = GTK_MENU_ITEM_ACCESSIBLE (obj);
194 label = get_label_from_container (widget);
196 g_free (accessible->text);
197 accessible->text = get_text_from_label_widget (label);
199 return accessible->text;
203 gtk_menu_item_accessible_finalize (GObject *object)
205 GtkMenuItemAccessible *accessible = GTK_MENU_ITEM_ACCESSIBLE (object);
207 g_free (accessible->text);
209 G_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->finalize (object);
213 gtk_menu_item_accessible_notify_gtk (GObject *obj,
218 atk_obj = gtk_widget_get_accessible (GTK_WIDGET (obj));
220 if (strcmp (pspec->name, "label") == 0)
222 if (atk_obj->name == NULL)
223 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
224 g_signal_emit_by_name (atk_obj, "visible-data-changed");
227 GTK_WIDGET_ACCESSIBLE_CLASS (_gtk_menu_item_accessible_parent_class)->notify_gtk (obj, pspec);
231 _gtk_menu_item_accessible_class_init (GtkMenuItemAccessibleClass *klass)
233 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
234 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
235 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
237 widget_class->notify_gtk = gtk_menu_item_accessible_notify_gtk;
239 gobject_class->finalize = gtk_menu_item_accessible_finalize;
241 class->get_n_children = gtk_menu_item_accessible_get_n_children;
242 class->ref_child = gtk_menu_item_accessible_ref_child;
243 class->ref_state_set = gtk_menu_item_accessible_ref_state_set;
244 class->initialize = gtk_menu_item_accessible_initialize;
245 class->get_name = gtk_menu_item_accessible_get_name;
246 class->get_role = gtk_menu_item_accessible_get_role;
250 _gtk_menu_item_accessible_init (GtkMenuItemAccessible *menu_item)
255 get_label_from_container (GtkWidget *container)
258 GList *children, *tmp_list;
260 if (!GTK_IS_CONTAINER (container))
263 children = gtk_container_get_children (GTK_CONTAINER (container));
266 for (tmp_list = children; tmp_list != NULL; tmp_list = tmp_list->next)
268 if (GTK_IS_LABEL (tmp_list->data))
270 label = tmp_list->data;
273 else if (GTK_IS_CELL_VIEW (tmp_list->data))
275 label = tmp_list->data;
278 else if (GTK_IS_BOX (tmp_list->data))
280 label = get_label_from_container (GTK_WIDGET (tmp_list->data));
285 g_list_free (children);
291 get_text_from_label_widget (GtkWidget *label)
293 if (GTK_IS_LABEL (label))
294 return g_strdup (gtk_label_get_text (GTK_LABEL (label)));
295 else if (GTK_IS_CELL_VIEW (label))
304 model = gtk_cell_view_get_model (GTK_CELL_VIEW (label));
305 path = gtk_cell_view_get_displayed_row (GTK_CELL_VIEW (label));
306 gtk_tree_model_get_iter (model, &iter, path);
307 gtk_tree_path_free (path);
309 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (label));
310 gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
311 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (label));
314 for (l = cells; l; l = l->next)
316 GtkCellRenderer *cell = l->data;
318 if (GTK_IS_CELL_RENDERER_TEXT (cell))
320 g_object_get (cell, "text", &text, NULL);
334 ensure_menus_unposted (GtkMenuItemAccessible *menu_item)
339 parent = atk_object_get_parent (ATK_OBJECT (menu_item));
342 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (parent));
343 if (GTK_IS_MENU (widget))
345 if (gtk_widget_get_mapped (widget))
346 gtk_menu_shell_cancel (GTK_MENU_SHELL (widget));
350 parent = atk_object_get_parent (parent);
355 gtk_menu_item_accessible_do_action (AtkAction *action,
358 GtkWidget *item, *item_parent;
359 gboolean item_mapped;
361 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
368 if (!gtk_widget_get_sensitive (item) || !gtk_widget_get_visible (item))
371 item_parent = gtk_widget_get_parent (item);
372 if (!GTK_IS_MENU_SHELL (item_parent))
375 gtk_menu_shell_select_item (GTK_MENU_SHELL (item_parent), item);
376 item_mapped = gtk_widget_get_mapped (item);
378 /* This is what is called when <Return> is pressed for a menu item.
379 * The last argument means 'force hide'.
381 g_signal_emit_by_name (item_parent, "activate-current", 1);
383 ensure_menus_unposted (GTK_MENU_ITEM_ACCESSIBLE (action));
389 gtk_menu_item_accessible_get_n_actions (AtkAction *action)
393 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
397 if (!_gtk_menu_item_is_selectable (item))
404 gtk_menu_item_accessible_action_get_name (AtkAction *action,
407 if (i != 0 || gtk_menu_item_accessible_get_n_actions (action) == 0)
414 find_accel_by_widget (GtkAccelKey *key,
418 /* We assume that closure->data points to the widget
419 * pending gtk_widget_get_accel_closures being made public
421 return data == (gpointer) closure->data;
425 find_accel_by_closure (GtkAccelKey *key,
429 return data == (gpointer) closure;
432 /* This function returns a string of the form A;B;C where A is
433 * the keybinding for the widget; B is the keybinding to traverse
434 * from the menubar and C is the accelerator. The items in the
435 * keybinding to traverse from the menubar are separated by ":".
438 gtk_menu_item_accessible_get_keybinding (AtkAction *action,
441 gchar *keybinding = NULL;
442 gchar *item_keybinding = NULL;
443 gchar *full_keybinding = NULL;
444 gchar *accelerator = NULL;
446 GtkWidget *temp_item;
450 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
460 GdkModifierType mnemonic_modifier = 0;
462 gchar *key, *temp_keybinding;
464 child = gtk_bin_get_child (GTK_BIN (temp_item));
468 parent = gtk_widget_get_parent (temp_item);
470 /* parent can be NULL when activating a window from the panel */
473 if (GTK_IS_MENU_BAR (parent))
477 toplevel = gtk_widget_get_toplevel (parent);
478 if (toplevel && GTK_IS_WINDOW (toplevel))
480 gtk_window_get_mnemonic_modifier (GTK_WINDOW (toplevel));
483 if (GTK_IS_LABEL (child))
485 key_val = gtk_label_get_mnemonic_keyval (GTK_LABEL (child));
486 if (key_val != GDK_KEY_VoidSymbol)
488 key = gtk_accelerator_name (key_val, mnemonic_modifier);
490 temp_keybinding = g_strconcat (key, ":", full_keybinding, NULL);
492 temp_keybinding = g_strdup (key);
494 if (temp_item == item)
495 item_keybinding = g_strdup (key);
498 g_free (full_keybinding);
499 full_keybinding = temp_keybinding;
504 g_free (full_keybinding);
505 full_keybinding = NULL;
510 /* We have reached the menu bar so we are finished */
511 if (GTK_IS_MENU_BAR (parent))
514 g_return_val_if_fail (GTK_IS_MENU (parent), NULL);
515 temp_item = gtk_menu_get_attach_widget (GTK_MENU (parent));
516 if (!GTK_IS_MENU_ITEM (temp_item))
518 /* Menu is attached to something other than a menu item;
519 * probably an option menu
521 g_free (full_keybinding);
522 full_keybinding = NULL;
527 parent = gtk_widget_get_parent (item);
528 if (GTK_IS_MENU (parent))
530 GtkAccelGroup *group;
533 group = gtk_menu_get_accel_group (GTK_MENU (parent));
535 key = gtk_accel_group_find (group, find_accel_by_widget, item);
539 child = gtk_bin_get_child (GTK_BIN (item));
540 if (GTK_IS_ACCEL_LABEL (child))
542 GtkAccelLabel *accel_label;
543 GClosure *accel_closure;
545 accel_label = GTK_ACCEL_LABEL (child);
546 g_object_get (accel_label, "accel-closure", &accel_closure, NULL);
549 key = gtk_accel_group_find (gtk_accel_group_from_accel_closure (accel_closure),
550 find_accel_by_closure,
552 g_closure_unref (accel_closure);
558 accelerator = gtk_accelerator_name (key->accel_key, key->accel_mods);
561 /* Concatenate the bindings */
562 if (item_keybinding || full_keybinding || accelerator)
567 keybinding = g_strconcat (item_keybinding, KEYBINDING_SEPARATOR, NULL);
568 g_free (item_keybinding);
571 keybinding = g_strdup (KEYBINDING_SEPARATOR);
575 temp = g_strconcat (keybinding, full_keybinding,
576 KEYBINDING_SEPARATOR, NULL);
577 g_free (full_keybinding);
580 temp = g_strconcat (keybinding, KEYBINDING_SEPARATOR, NULL);
586 temp = g_strconcat (keybinding, accelerator, NULL);
587 g_free (accelerator);
597 atk_action_interface_init (AtkActionIface *iface)
599 iface->do_action = gtk_menu_item_accessible_do_action;
600 iface->get_n_actions = gtk_menu_item_accessible_get_n_actions;
601 iface->get_name = gtk_menu_item_accessible_action_get_name;
602 iface->get_keybinding = gtk_menu_item_accessible_get_keybinding;
606 menu_item_selection (GtkMenuItem *item,
609 AtkObject *obj, *parent;
612 obj = gtk_widget_get_accessible (GTK_WIDGET (item));
613 atk_object_notify_state_change (obj, ATK_STATE_SELECTED, selected);
615 for (i = 0; i < atk_object_get_n_accessible_children (obj); i++)
618 child = atk_object_ref_accessible_child (obj, i);
619 atk_object_notify_state_change (child, ATK_STATE_SHOWING, selected);
620 g_object_unref (child);
622 parent = atk_object_get_parent (obj);
623 g_signal_emit_by_name (parent, "selection-changed");
627 gtk_menu_item_accessible_add_selection (AtkSelection *selection,
637 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
641 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
645 shell = GTK_MENU_SHELL (menu);
646 kids = gtk_container_get_children (GTK_CONTAINER (shell));
647 length = g_list_length (kids);
648 if (i < 0 || i > length)
654 child = g_list_nth_data (kids, i);
656 g_return_val_if_fail (GTK_IS_MENU_ITEM (child), FALSE);
657 gtk_menu_shell_select_item (shell, GTK_WIDGET (child));
662 gtk_menu_item_accessible_clear_selection (AtkSelection *selection)
667 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
671 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
675 gtk_menu_shell_deselect (GTK_MENU_SHELL (menu));
681 gtk_menu_item_accessible_ref_selection (AtkSelection *selection,
693 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
697 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
701 shell = GTK_MENU_SHELL (menu);
703 item = gtk_menu_shell_get_selected_item (shell);
706 obj = gtk_widget_get_accessible (item);
715 gtk_menu_item_accessible_get_selection_count (AtkSelection *selection)
721 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
725 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
729 shell = GTK_MENU_SHELL (menu);
731 if (gtk_menu_shell_get_selected_item (shell) != NULL)
738 gtk_menu_item_accessible_is_child_selected (AtkSelection *selection,
748 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
752 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
756 shell = GTK_MENU_SHELL (menu);
758 item = gtk_menu_shell_get_selected_item (shell);
762 kids = gtk_container_get_children (GTK_CONTAINER (shell));
763 j = g_list_index (kids, item);
770 gtk_menu_item_accessible_remove_selection (AtkSelection *selection,
781 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
785 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
789 shell = GTK_MENU_SHELL (menu);
791 item = gtk_menu_shell_get_selected_item (shell);
792 if (item && gtk_menu_item_get_submenu (GTK_MENU_ITEM (item)))
793 gtk_menu_shell_deselect (shell);
799 atk_selection_interface_init (AtkSelectionIface *iface)
801 iface->add_selection = gtk_menu_item_accessible_add_selection;
802 iface->clear_selection = gtk_menu_item_accessible_clear_selection;
803 iface->ref_selection = gtk_menu_item_accessible_ref_selection;
804 iface->get_selection_count = gtk_menu_item_accessible_get_selection_count;
805 iface->is_child_selected = gtk_menu_item_accessible_is_child_selected;
806 iface->remove_selection = gtk_menu_item_accessible_remove_selection;
810 menu_item_add_gtk (GtkContainer *container,
813 GtkWidget *parent_widget;
814 AtkObject *atk_parent;
815 AtkObject *atk_child;
816 GtkContainerAccessible *container_accessible;
819 g_return_val_if_fail (GTK_IS_MENU (container), 1);
821 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (container));
822 if (GTK_IS_MENU_ITEM (parent_widget))
824 atk_parent = gtk_widget_get_accessible (parent_widget);
825 atk_child = gtk_widget_get_accessible (widget);
827 g_object_notify (G_OBJECT (atk_child), "accessible-parent");
828 container_accessible = GTK_CONTAINER_ACCESSIBLE (atk_parent);
829 g_list_free (container_accessible->children);
830 container_accessible->children = gtk_container_get_children (container);
831 index = g_list_index (container_accessible->children, widget);
832 g_signal_emit_by_name (atk_parent, "children-changed::add",
833 index, atk_child, NULL);
839 menu_item_remove_gtk (GtkContainer *container,
842 GtkWidget *parent_widget;
843 AtkObject *atk_parent;
844 AtkObject *atk_child;
845 GtkContainerAccessible *container_accessible;
849 g_return_val_if_fail (GTK_IS_MENU (container), 1);
851 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (container));
852 if (GTK_IS_MENU_ITEM (parent_widget))
854 atk_parent = gtk_widget_get_accessible (parent_widget);
855 atk_child = gtk_widget_get_accessible (widget);
857 g_object_notify (G_OBJECT (atk_child), "accessible-parent");
859 container_accessible = GTK_CONTAINER_ACCESSIBLE (atk_parent);
860 index = g_list_index (container_accessible->children, widget);
861 list_length = g_list_length (container_accessible->children);
862 g_list_free (container_accessible->children);
863 container_accessible->children = gtk_container_get_children (container);
864 if (index >= 0 && index <= list_length)
865 g_signal_emit_by_name (atk_parent, "children-changed::remove",
866 index, atk_child, NULL);
871 menu_item_select (GtkMenuItem *item)
873 menu_item_selection (item, TRUE);
877 menu_item_deselect (GtkMenuItem *item)
879 menu_item_selection (item, FALSE);