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
28 #define KEYBINDING_SEPARATOR ";"
30 static void menu_item_select (GtkMenuItem *item);
31 static void menu_item_deselect (GtkMenuItem *item);
33 static GtkWidget *get_label_from_container (GtkWidget *container);
34 static gchar *get_text_from_label_widget (GtkWidget *widget);
36 static gint menu_item_add_gtk (GtkContainer *container,
38 static gint menu_item_remove_gtk (GtkContainer *container,
41 static void atk_action_interface_init (AtkActionIface *iface);
42 static void atk_selection_interface_init (AtkSelectionIface *iface);
44 G_DEFINE_TYPE_WITH_CODE (GtkMenuItemAccessible, _gtk_menu_item_accessible, GTK_TYPE_CONTAINER_ACCESSIBLE,
45 G_IMPLEMENT_INTERFACE (ATK_TYPE_ACTION, atk_action_interface_init);
46 G_IMPLEMENT_INTERFACE (ATK_TYPE_SELECTION, atk_selection_interface_init))
49 gtk_menu_item_accessible_initialize (AtkObject *obj,
56 ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->initialize (obj, data);
58 g_signal_connect (data, "select", G_CALLBACK (menu_item_select), NULL);
59 g_signal_connect (data, "deselect", G_CALLBACK (menu_item_deselect), NULL);
61 widget = GTK_WIDGET (data);
62 parent = gtk_widget_get_parent (widget);
63 if (GTK_IS_MENU (parent))
65 GtkWidget *parent_widget;
67 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (parent));
69 if (!GTK_IS_MENU_ITEM (parent_widget))
70 parent_widget = gtk_widget_get_parent (widget);
72 atk_object_set_parent (obj, gtk_widget_get_accessible (parent_widget));
75 _gtk_widget_accessible_set_layer (GTK_WIDGET_ACCESSIBLE (obj), ATK_LAYER_POPUP);
77 obj->role = ATK_ROLE_MENU_ITEM;
79 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (data));
82 g_signal_connect (menu, "add", G_CALLBACK (menu_item_add_gtk), NULL);
83 g_signal_connect (menu, "remove", G_CALLBACK (menu_item_remove_gtk), NULL);
88 gtk_menu_item_accessible_get_n_children (AtkObject *obj)
94 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
98 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
103 children = gtk_container_get_children (GTK_CONTAINER (submenu));
104 count = g_list_length (children);
105 g_list_free (children);
111 gtk_menu_item_accessible_ref_child (AtkObject *obj,
114 AtkObject *accessible;
118 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
123 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
129 children = gtk_container_get_children (GTK_CONTAINER (submenu));
130 tmp_list = g_list_nth (children, i);
133 accessible = gtk_widget_get_accessible (GTK_WIDGET (tmp_list->data));
134 g_object_ref (accessible);
136 g_list_free (children);
143 gtk_menu_item_accessible_ref_state_set (AtkObject *obj)
145 AtkObject *menu_item;
146 AtkStateSet *state_set, *parent_state_set;
148 state_set = ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->ref_state_set (obj);
150 menu_item = atk_object_get_parent (obj);
154 if (!GTK_IS_MENU_ITEM (gtk_accessible_get_widget (GTK_ACCESSIBLE (menu_item))))
157 parent_state_set = atk_object_ref_state_set (menu_item);
158 if (!atk_state_set_contains_state (parent_state_set, ATK_STATE_SELECTED))
160 atk_state_set_remove_state (state_set, ATK_STATE_FOCUSED);
161 atk_state_set_remove_state (state_set, ATK_STATE_SHOWING);
163 g_object_unref (parent_state_set);
170 gtk_menu_item_accessible_get_role (AtkObject *obj)
174 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
175 if (widget != NULL &&
176 gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget)))
177 return ATK_ROLE_MENU;
179 return ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->get_role (obj);
183 gtk_menu_item_accessible_get_name (AtkObject *obj)
188 GtkMenuItemAccessible *accessible;
190 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
194 name = ATK_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->get_name (obj);
198 accessible = GTK_MENU_ITEM_ACCESSIBLE (obj);
199 label = get_label_from_container (widget);
201 g_free (accessible->priv->text);
202 accessible->priv->text = get_text_from_label_widget (label);
204 return accessible->priv->text;
208 gtk_menu_item_accessible_finalize (GObject *object)
210 GtkMenuItemAccessible *accessible = GTK_MENU_ITEM_ACCESSIBLE (object);
212 g_free (accessible->priv->text);
214 G_OBJECT_CLASS (_gtk_menu_item_accessible_parent_class)->finalize (object);
218 gtk_menu_item_accessible_notify_gtk (GObject *obj,
223 atk_obj = gtk_widget_get_accessible (GTK_WIDGET (obj));
225 if (strcmp (pspec->name, "label") == 0)
227 if (atk_obj->name == NULL)
228 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
229 g_signal_emit_by_name (atk_obj, "visible-data-changed");
232 GTK_WIDGET_ACCESSIBLE_CLASS (_gtk_menu_item_accessible_parent_class)->notify_gtk (obj, pspec);
236 _gtk_menu_item_accessible_class_init (GtkMenuItemAccessibleClass *klass)
238 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
239 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
240 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
242 widget_class->notify_gtk = gtk_menu_item_accessible_notify_gtk;
244 gobject_class->finalize = gtk_menu_item_accessible_finalize;
246 class->get_n_children = gtk_menu_item_accessible_get_n_children;
247 class->ref_child = gtk_menu_item_accessible_ref_child;
248 class->ref_state_set = gtk_menu_item_accessible_ref_state_set;
249 class->initialize = gtk_menu_item_accessible_initialize;
250 class->get_name = gtk_menu_item_accessible_get_name;
251 class->get_role = gtk_menu_item_accessible_get_role;
253 g_type_class_add_private (klass, sizeof (GtkMenuItemAccessiblePrivate));
257 _gtk_menu_item_accessible_init (GtkMenuItemAccessible *menu_item)
259 menu_item->priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_item,
260 GTK_TYPE_MENU_ITEM_ACCESSIBLE,
261 GtkMenuItemAccessiblePrivate);
265 get_label_from_container (GtkWidget *container)
268 GList *children, *tmp_list;
270 if (!GTK_IS_CONTAINER (container))
273 children = gtk_container_get_children (GTK_CONTAINER (container));
276 for (tmp_list = children; tmp_list != NULL; tmp_list = tmp_list->next)
278 if (GTK_IS_LABEL (tmp_list->data))
280 label = tmp_list->data;
283 else if (GTK_IS_CELL_VIEW (tmp_list->data))
285 label = tmp_list->data;
288 else if (GTK_IS_BOX (tmp_list->data))
290 label = get_label_from_container (GTK_WIDGET (tmp_list->data));
295 g_list_free (children);
301 get_text_from_label_widget (GtkWidget *label)
303 if (GTK_IS_LABEL (label))
304 return g_strdup (gtk_label_get_text (GTK_LABEL (label)));
305 else if (GTK_IS_CELL_VIEW (label))
314 model = gtk_cell_view_get_model (GTK_CELL_VIEW (label));
315 path = gtk_cell_view_get_displayed_row (GTK_CELL_VIEW (label));
316 gtk_tree_model_get_iter (model, &iter, path);
317 gtk_tree_path_free (path);
319 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (label));
320 gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
321 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (label));
324 for (l = cells; l; l = l->next)
326 GtkCellRenderer *cell = l->data;
328 if (GTK_IS_CELL_RENDERER_TEXT (cell))
330 g_object_get (cell, "text", &text, NULL);
344 ensure_menus_unposted (GtkMenuItemAccessible *menu_item)
349 parent = atk_object_get_parent (ATK_OBJECT (menu_item));
352 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (parent));
353 if (GTK_IS_MENU (widget))
355 if (gtk_widget_get_mapped (widget))
356 gtk_menu_shell_cancel (GTK_MENU_SHELL (widget));
360 parent = atk_object_get_parent (parent);
365 gtk_menu_item_accessible_do_action (AtkAction *action,
368 GtkWidget *item, *item_parent;
369 gboolean item_mapped;
371 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
378 if (!gtk_widget_get_sensitive (item) || !gtk_widget_get_visible (item))
381 item_parent = gtk_widget_get_parent (item);
382 if (!GTK_IS_MENU_SHELL (item_parent))
385 gtk_menu_shell_select_item (GTK_MENU_SHELL (item_parent), item);
386 item_mapped = gtk_widget_get_mapped (item);
388 /* This is what is called when <Return> is pressed for a menu item.
389 * The last argument means 'force hide'.
391 g_signal_emit_by_name (item_parent, "activate-current", 1);
393 ensure_menus_unposted (GTK_MENU_ITEM_ACCESSIBLE (action));
399 gtk_menu_item_accessible_get_n_actions (AtkAction *action)
403 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
407 if (!_gtk_menu_item_is_selectable (item))
414 gtk_menu_item_accessible_action_get_name (AtkAction *action,
417 if (i != 0 || gtk_menu_item_accessible_get_n_actions (action) == 0)
424 find_accel_by_widget (GtkAccelKey *key,
428 /* We assume that closure->data points to the widget
429 * pending gtk_widget_get_accel_closures being made public
431 return data == (gpointer) closure->data;
435 find_accel_by_closure (GtkAccelKey *key,
439 return data == (gpointer) closure;
442 /* This function returns a string of the form A;B;C where A is
443 * the keybinding for the widget; B is the keybinding to traverse
444 * from the menubar and C is the accelerator. The items in the
445 * keybinding to traverse from the menubar are separated by ":".
448 gtk_menu_item_accessible_get_keybinding (AtkAction *action,
451 gchar *keybinding = NULL;
452 gchar *item_keybinding = NULL;
453 gchar *full_keybinding = NULL;
454 gchar *accelerator = NULL;
456 GtkWidget *temp_item;
460 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
470 GdkModifierType mnemonic_modifier = 0;
472 gchar *key, *temp_keybinding;
474 child = gtk_bin_get_child (GTK_BIN (temp_item));
478 parent = gtk_widget_get_parent (temp_item);
480 /* parent can be NULL when activating a window from the panel */
483 if (GTK_IS_MENU_BAR (parent))
487 toplevel = gtk_widget_get_toplevel (parent);
488 if (toplevel && GTK_IS_WINDOW (toplevel))
490 gtk_window_get_mnemonic_modifier (GTK_WINDOW (toplevel));
493 if (GTK_IS_LABEL (child))
495 key_val = gtk_label_get_mnemonic_keyval (GTK_LABEL (child));
496 if (key_val != GDK_KEY_VoidSymbol)
498 key = gtk_accelerator_name (key_val, mnemonic_modifier);
500 temp_keybinding = g_strconcat (key, ":", full_keybinding, NULL);
502 temp_keybinding = g_strdup (key);
504 if (temp_item == item)
505 item_keybinding = g_strdup (key);
508 g_free (full_keybinding);
509 full_keybinding = temp_keybinding;
514 g_free (full_keybinding);
515 full_keybinding = NULL;
520 /* We have reached the menu bar so we are finished */
521 if (GTK_IS_MENU_BAR (parent))
524 g_return_val_if_fail (GTK_IS_MENU (parent), NULL);
525 temp_item = gtk_menu_get_attach_widget (GTK_MENU (parent));
526 if (!GTK_IS_MENU_ITEM (temp_item))
528 /* Menu is attached to something other than a menu item;
529 * probably an option menu
531 g_free (full_keybinding);
532 full_keybinding = NULL;
537 parent = gtk_widget_get_parent (item);
538 if (GTK_IS_MENU (parent))
540 GtkAccelGroup *group;
543 group = gtk_menu_get_accel_group (GTK_MENU (parent));
545 key = gtk_accel_group_find (group, find_accel_by_widget, item);
549 child = gtk_bin_get_child (GTK_BIN (item));
550 if (GTK_IS_ACCEL_LABEL (child))
552 GtkAccelLabel *accel_label;
553 GClosure *accel_closure;
555 accel_label = GTK_ACCEL_LABEL (child);
556 g_object_get (accel_label, "accel-closure", &accel_closure, NULL);
559 key = gtk_accel_group_find (gtk_accel_group_from_accel_closure (accel_closure),
560 find_accel_by_closure,
562 g_closure_unref (accel_closure);
568 accelerator = gtk_accelerator_name (key->accel_key, key->accel_mods);
571 /* Concatenate the bindings */
572 if (item_keybinding || full_keybinding || accelerator)
577 keybinding = g_strconcat (item_keybinding, KEYBINDING_SEPARATOR, NULL);
578 g_free (item_keybinding);
581 keybinding = g_strdup (KEYBINDING_SEPARATOR);
585 temp = g_strconcat (keybinding, full_keybinding,
586 KEYBINDING_SEPARATOR, NULL);
587 g_free (full_keybinding);
590 temp = g_strconcat (keybinding, KEYBINDING_SEPARATOR, NULL);
596 temp = g_strconcat (keybinding, accelerator, NULL);
597 g_free (accelerator);
607 atk_action_interface_init (AtkActionIface *iface)
609 iface->do_action = gtk_menu_item_accessible_do_action;
610 iface->get_n_actions = gtk_menu_item_accessible_get_n_actions;
611 iface->get_name = gtk_menu_item_accessible_action_get_name;
612 iface->get_keybinding = gtk_menu_item_accessible_get_keybinding;
616 menu_item_selection (GtkMenuItem *item,
619 AtkObject *obj, *parent;
622 obj = gtk_widget_get_accessible (GTK_WIDGET (item));
623 atk_object_notify_state_change (obj, ATK_STATE_SELECTED, selected);
625 for (i = 0; i < atk_object_get_n_accessible_children (obj); i++)
628 child = atk_object_ref_accessible_child (obj, i);
629 atk_object_notify_state_change (child, ATK_STATE_SHOWING, selected);
630 g_object_unref (child);
632 parent = atk_object_get_parent (obj);
633 g_signal_emit_by_name (parent, "selection-changed");
637 gtk_menu_item_accessible_add_selection (AtkSelection *selection,
647 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
651 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
655 shell = GTK_MENU_SHELL (menu);
656 kids = gtk_container_get_children (GTK_CONTAINER (shell));
657 length = g_list_length (kids);
658 if (i < 0 || i > length)
664 child = g_list_nth_data (kids, i);
666 g_return_val_if_fail (GTK_IS_MENU_ITEM (child), FALSE);
667 gtk_menu_shell_select_item (shell, GTK_WIDGET (child));
672 gtk_menu_item_accessible_clear_selection (AtkSelection *selection)
677 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
681 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
685 gtk_menu_shell_deselect (GTK_MENU_SHELL (menu));
691 gtk_menu_item_accessible_ref_selection (AtkSelection *selection,
703 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
707 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
711 shell = GTK_MENU_SHELL (menu);
713 item = gtk_menu_shell_get_selected_item (shell);
716 obj = gtk_widget_get_accessible (item);
725 gtk_menu_item_accessible_get_selection_count (AtkSelection *selection)
731 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
735 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
739 shell = GTK_MENU_SHELL (menu);
741 if (gtk_menu_shell_get_selected_item (shell) != NULL)
748 gtk_menu_item_accessible_is_child_selected (AtkSelection *selection,
758 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
762 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
766 shell = GTK_MENU_SHELL (menu);
768 item = gtk_menu_shell_get_selected_item (shell);
772 kids = gtk_container_get_children (GTK_CONTAINER (shell));
773 j = g_list_index (kids, item);
780 gtk_menu_item_accessible_remove_selection (AtkSelection *selection,
791 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
795 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
799 shell = GTK_MENU_SHELL (menu);
801 item = gtk_menu_shell_get_selected_item (shell);
802 if (item && gtk_menu_item_get_submenu (GTK_MENU_ITEM (item)))
803 gtk_menu_shell_deselect (shell);
809 atk_selection_interface_init (AtkSelectionIface *iface)
811 iface->add_selection = gtk_menu_item_accessible_add_selection;
812 iface->clear_selection = gtk_menu_item_accessible_clear_selection;
813 iface->ref_selection = gtk_menu_item_accessible_ref_selection;
814 iface->get_selection_count = gtk_menu_item_accessible_get_selection_count;
815 iface->is_child_selected = gtk_menu_item_accessible_is_child_selected;
816 iface->remove_selection = gtk_menu_item_accessible_remove_selection;
820 menu_item_add_gtk (GtkContainer *container,
823 GtkWidget *parent_widget;
825 g_return_val_if_fail (GTK_IS_MENU (container), 1);
827 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (container));
828 if (GTK_IS_MENU_ITEM (parent_widget))
830 GTK_CONTAINER_ACCESSIBLE_CLASS (_gtk_menu_item_accessible_parent_class)->add_gtk (container, widget, gtk_widget_get_accessible (parent_widget));
837 menu_item_remove_gtk (GtkContainer *container,
840 GtkWidget *parent_widget;
842 g_return_val_if_fail (GTK_IS_MENU (container), 1);
844 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (container));
845 if (GTK_IS_MENU_ITEM (parent_widget))
847 GTK_CONTAINER_ACCESSIBLE_CLASS (_gtk_menu_item_accessible_parent_class)->remove_gtk (container, widget, gtk_widget_get_accessible (parent_widget));
852 menu_item_select (GtkMenuItem *item)
854 menu_item_selection (item, TRUE);
858 menu_item_deselect (GtkMenuItem *item)
860 menu_item_selection (item, FALSE);