1 /* GTK+ - accessibility implementations
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 <glib/gi18n-lib.h>
23 #include "gtkmenuitemaccessible.h"
24 #include "gtkwidgetaccessibleprivate.h"
25 #include "gtk/gtkmenuitemprivate.h"
27 struct _GtkMenuItemAccessiblePrivate
33 #define KEYBINDING_SEPARATOR ";"
35 static void menu_item_select (GtkMenuItem *item);
36 static void menu_item_deselect (GtkMenuItem *item);
38 static GtkWidget *get_label_from_container (GtkWidget *container);
39 static gchar *get_text_from_label_widget (GtkWidget *widget);
41 static gint menu_item_add_gtk (GtkContainer *container,
43 static gint menu_item_remove_gtk (GtkContainer *container,
46 static void atk_action_interface_init (AtkActionIface *iface);
47 static void atk_selection_interface_init (AtkSelectionIface *iface);
49 G_DEFINE_TYPE_WITH_CODE (GtkMenuItemAccessible, gtk_menu_item_accessible, GTK_TYPE_CONTAINER_ACCESSIBLE,
50 G_IMPLEMENT_INTERFACE (ATK_TYPE_ACTION, atk_action_interface_init);
51 G_IMPLEMENT_INTERFACE (ATK_TYPE_SELECTION, atk_selection_interface_init))
54 gtk_menu_item_accessible_initialize (AtkObject *obj,
61 ATK_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->initialize (obj, data);
63 g_signal_connect (data, "select", G_CALLBACK (menu_item_select), NULL);
64 g_signal_connect (data, "deselect", G_CALLBACK (menu_item_deselect), NULL);
66 widget = GTK_WIDGET (data);
67 parent = gtk_widget_get_parent (widget);
68 if (GTK_IS_MENU (parent))
70 GtkWidget *parent_widget;
72 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (parent));
74 if (!GTK_IS_MENU_ITEM (parent_widget))
75 parent_widget = gtk_widget_get_parent (widget);
77 atk_object_set_parent (obj, gtk_widget_get_accessible (parent_widget));
80 _gtk_widget_accessible_set_layer (GTK_WIDGET_ACCESSIBLE (obj), ATK_LAYER_POPUP);
82 obj->role = ATK_ROLE_MENU_ITEM;
84 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (data));
87 g_signal_connect (menu, "add", G_CALLBACK (menu_item_add_gtk), NULL);
88 g_signal_connect (menu, "remove", G_CALLBACK (menu_item_remove_gtk), NULL);
93 gtk_menu_item_accessible_get_n_children (AtkObject *obj)
99 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
103 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
108 children = gtk_container_get_children (GTK_CONTAINER (submenu));
109 count = g_list_length (children);
110 g_list_free (children);
116 gtk_menu_item_accessible_ref_child (AtkObject *obj,
119 AtkObject *accessible;
123 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
128 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
134 children = gtk_container_get_children (GTK_CONTAINER (submenu));
135 tmp_list = g_list_nth (children, i);
138 accessible = gtk_widget_get_accessible (GTK_WIDGET (tmp_list->data));
139 g_object_ref (accessible);
141 g_list_free (children);
148 gtk_menu_item_accessible_ref_state_set (AtkObject *obj)
150 AtkObject *menu_item;
151 AtkStateSet *state_set, *parent_state_set;
153 state_set = ATK_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->ref_state_set (obj);
155 atk_state_set_add_state (state_set, ATK_STATE_SELECTABLE);
156 if (GTK_MENU_ITEM_ACCESSIBLE (obj)->priv->selected)
157 atk_state_set_add_state (state_set, ATK_STATE_SELECTED);
159 menu_item = atk_object_get_parent (obj);
163 if (!GTK_IS_MENU_ITEM (gtk_accessible_get_widget (GTK_ACCESSIBLE (menu_item))))
166 parent_state_set = atk_object_ref_state_set (menu_item);
167 if (!atk_state_set_contains_state (parent_state_set, ATK_STATE_SELECTED))
169 atk_state_set_remove_state (state_set, ATK_STATE_FOCUSED);
170 atk_state_set_remove_state (state_set, ATK_STATE_SHOWING);
172 g_object_unref (parent_state_set);
179 gtk_menu_item_accessible_get_role (AtkObject *obj)
183 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
184 if (widget != NULL &&
185 gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget)))
186 return ATK_ROLE_MENU;
188 return ATK_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->get_role (obj);
192 gtk_menu_item_accessible_get_name (AtkObject *obj)
197 GtkMenuItemAccessible *accessible;
199 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
203 name = ATK_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->get_name (obj);
207 accessible = GTK_MENU_ITEM_ACCESSIBLE (obj);
208 label = get_label_from_container (widget);
210 g_free (accessible->priv->text);
211 accessible->priv->text = get_text_from_label_widget (label);
213 return accessible->priv->text;
217 gtk_menu_item_accessible_finalize (GObject *object)
219 GtkMenuItemAccessible *accessible = GTK_MENU_ITEM_ACCESSIBLE (object);
221 g_free (accessible->priv->text);
223 G_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->finalize (object);
227 gtk_menu_item_accessible_notify_gtk (GObject *obj,
232 atk_obj = gtk_widget_get_accessible (GTK_WIDGET (obj));
234 if (strcmp (pspec->name, "label") == 0)
236 if (atk_obj->name == NULL)
237 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
238 g_signal_emit_by_name (atk_obj, "visible-data-changed");
241 GTK_WIDGET_ACCESSIBLE_CLASS (gtk_menu_item_accessible_parent_class)->notify_gtk (obj, pspec);
245 gtk_menu_item_accessible_class_init (GtkMenuItemAccessibleClass *klass)
247 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
248 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
249 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
251 widget_class->notify_gtk = gtk_menu_item_accessible_notify_gtk;
253 gobject_class->finalize = gtk_menu_item_accessible_finalize;
255 class->get_n_children = gtk_menu_item_accessible_get_n_children;
256 class->ref_child = gtk_menu_item_accessible_ref_child;
257 class->ref_state_set = gtk_menu_item_accessible_ref_state_set;
258 class->initialize = gtk_menu_item_accessible_initialize;
259 class->get_name = gtk_menu_item_accessible_get_name;
260 class->get_role = gtk_menu_item_accessible_get_role;
262 g_type_class_add_private (klass, sizeof (GtkMenuItemAccessiblePrivate));
266 gtk_menu_item_accessible_init (GtkMenuItemAccessible *menu_item)
268 menu_item->priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_item,
269 GTK_TYPE_MENU_ITEM_ACCESSIBLE,
270 GtkMenuItemAccessiblePrivate);
274 get_label_from_container (GtkWidget *container)
277 GList *children, *tmp_list;
279 if (!GTK_IS_CONTAINER (container))
282 children = gtk_container_get_children (GTK_CONTAINER (container));
285 for (tmp_list = children; tmp_list != NULL; tmp_list = tmp_list->next)
287 if (GTK_IS_LABEL (tmp_list->data))
289 label = tmp_list->data;
292 else if (GTK_IS_CELL_VIEW (tmp_list->data))
294 label = tmp_list->data;
297 else if (GTK_IS_BOX (tmp_list->data))
299 label = get_label_from_container (GTK_WIDGET (tmp_list->data));
304 g_list_free (children);
310 get_text_from_label_widget (GtkWidget *label)
312 if (GTK_IS_LABEL (label))
313 return g_strdup (gtk_label_get_text (GTK_LABEL (label)));
314 else if (GTK_IS_CELL_VIEW (label))
323 model = gtk_cell_view_get_model (GTK_CELL_VIEW (label));
324 path = gtk_cell_view_get_displayed_row (GTK_CELL_VIEW (label));
325 gtk_tree_model_get_iter (model, &iter, path);
326 gtk_tree_path_free (path);
328 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (label));
329 gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
330 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (label));
333 for (l = cells; l; l = l->next)
335 GtkCellRenderer *cell = l->data;
337 if (GTK_IS_CELL_RENDERER_TEXT (cell))
339 g_object_get (cell, "text", &text, NULL);
353 ensure_menus_unposted (GtkMenuItemAccessible *menu_item)
358 parent = atk_object_get_parent (ATK_OBJECT (menu_item));
361 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (parent));
362 if (GTK_IS_MENU (widget))
364 if (gtk_widget_get_mapped (widget))
365 gtk_menu_shell_cancel (GTK_MENU_SHELL (widget));
369 parent = atk_object_get_parent (parent);
374 gtk_menu_item_accessible_do_action (AtkAction *action,
377 GtkWidget *item, *item_parent;
378 gboolean item_mapped;
380 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
387 if (!gtk_widget_get_sensitive (item) || !gtk_widget_get_visible (item))
390 item_parent = gtk_widget_get_parent (item);
391 if (!GTK_IS_MENU_SHELL (item_parent))
394 gtk_menu_shell_select_item (GTK_MENU_SHELL (item_parent), item);
395 item_mapped = gtk_widget_get_mapped (item);
397 /* This is what is called when <Return> is pressed for a menu item.
398 * The last argument means 'force hide'.
400 g_signal_emit_by_name (item_parent, "activate-current", 1);
402 ensure_menus_unposted (GTK_MENU_ITEM_ACCESSIBLE (action));
408 gtk_menu_item_accessible_get_n_actions (AtkAction *action)
412 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
416 if (!_gtk_menu_item_is_selectable (item))
423 gtk_menu_item_accessible_action_get_name (AtkAction *action,
426 if (i == 0 && gtk_menu_item_accessible_get_n_actions (action) > 0)
432 gtk_menu_item_accessible_action_get_localized_name (AtkAction *action,
435 if (i == 0 && gtk_menu_item_accessible_get_n_actions (action) > 0)
436 return C_("Action name", "Click");
441 gtk_menu_item_accessible_action_get_description (AtkAction *action,
444 if (i == 0 && gtk_menu_item_accessible_get_n_actions (action) > 0)
445 return C_("Action description", "Clicks the menuitem");
450 find_accel_by_widget (GtkAccelKey *key,
454 /* We assume that closure->data points to the widget
455 * pending gtk_widget_get_accel_closures being made public
457 return data == (gpointer) closure->data;
461 find_accel_by_closure (GtkAccelKey *key,
465 return data == (gpointer) closure;
468 /* This function returns a string of the form A;B;C where A is
469 * the keybinding for the widget; B is the keybinding to traverse
470 * from the menubar and C is the accelerator. The items in the
471 * keybinding to traverse from the menubar are separated by ":".
474 gtk_menu_item_accessible_get_keybinding (AtkAction *action,
477 gchar *keybinding = NULL;
478 gchar *item_keybinding = NULL;
479 gchar *full_keybinding = NULL;
480 gchar *accelerator = NULL;
482 GtkWidget *temp_item;
486 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
496 GdkModifierType mnemonic_modifier = 0;
498 gchar *key, *temp_keybinding;
500 child = gtk_bin_get_child (GTK_BIN (temp_item));
504 parent = gtk_widget_get_parent (temp_item);
506 /* parent can be NULL when activating a window from the panel */
509 if (GTK_IS_MENU_BAR (parent))
513 toplevel = gtk_widget_get_toplevel (parent);
514 if (toplevel && GTK_IS_WINDOW (toplevel))
516 gtk_window_get_mnemonic_modifier (GTK_WINDOW (toplevel));
519 if (GTK_IS_LABEL (child))
521 key_val = gtk_label_get_mnemonic_keyval (GTK_LABEL (child));
522 if (key_val != GDK_KEY_VoidSymbol)
524 key = gtk_accelerator_name (key_val, mnemonic_modifier);
526 temp_keybinding = g_strconcat (key, ":", full_keybinding, NULL);
528 temp_keybinding = g_strdup (key);
530 if (temp_item == item)
531 item_keybinding = g_strdup (key);
534 g_free (full_keybinding);
535 full_keybinding = temp_keybinding;
540 g_free (full_keybinding);
541 full_keybinding = NULL;
546 /* We have reached the menu bar so we are finished */
547 if (GTK_IS_MENU_BAR (parent))
550 g_return_val_if_fail (GTK_IS_MENU (parent), NULL);
551 temp_item = gtk_menu_get_attach_widget (GTK_MENU (parent));
552 if (!GTK_IS_MENU_ITEM (temp_item))
554 /* Menu is attached to something other than a menu item;
555 * probably an option menu
557 g_free (full_keybinding);
558 full_keybinding = NULL;
563 parent = gtk_widget_get_parent (item);
564 if (GTK_IS_MENU (parent))
566 GtkAccelGroup *group;
569 group = gtk_menu_get_accel_group (GTK_MENU (parent));
571 key = gtk_accel_group_find (group, find_accel_by_widget, item);
575 child = gtk_bin_get_child (GTK_BIN (item));
576 if (GTK_IS_ACCEL_LABEL (child))
578 GtkAccelLabel *accel_label;
579 GClosure *accel_closure;
581 accel_label = GTK_ACCEL_LABEL (child);
582 g_object_get (accel_label, "accel-closure", &accel_closure, NULL);
585 key = gtk_accel_group_find (gtk_accel_group_from_accel_closure (accel_closure),
586 find_accel_by_closure,
588 g_closure_unref (accel_closure);
594 accelerator = gtk_accelerator_name (key->accel_key, key->accel_mods);
597 /* Concatenate the bindings */
598 if (item_keybinding || full_keybinding || accelerator)
603 keybinding = g_strconcat (item_keybinding, KEYBINDING_SEPARATOR, NULL);
604 g_free (item_keybinding);
607 keybinding = g_strdup (KEYBINDING_SEPARATOR);
611 temp = g_strconcat (keybinding, full_keybinding,
612 KEYBINDING_SEPARATOR, NULL);
613 g_free (full_keybinding);
616 temp = g_strconcat (keybinding, KEYBINDING_SEPARATOR, NULL);
622 temp = g_strconcat (keybinding, accelerator, NULL);
623 g_free (accelerator);
633 atk_action_interface_init (AtkActionIface *iface)
635 iface->do_action = gtk_menu_item_accessible_do_action;
636 iface->get_n_actions = gtk_menu_item_accessible_get_n_actions;
637 iface->get_name = gtk_menu_item_accessible_action_get_name;
638 iface->get_localized_name = gtk_menu_item_accessible_action_get_localized_name;
639 iface->get_description = gtk_menu_item_accessible_action_get_description;
640 iface->get_keybinding = gtk_menu_item_accessible_get_keybinding;
644 menu_item_selection (GtkMenuItem *item,
647 AtkObject *obj, *parent;
650 obj = gtk_widget_get_accessible (GTK_WIDGET (item));
651 GTK_MENU_ITEM_ACCESSIBLE (obj)->priv->selected = selected;
652 atk_object_notify_state_change (obj, ATK_STATE_SELECTED, selected);
654 for (i = 0; i < atk_object_get_n_accessible_children (obj); i++)
657 child = atk_object_ref_accessible_child (obj, i);
658 atk_object_notify_state_change (child, ATK_STATE_SHOWING, selected);
659 g_object_unref (child);
661 parent = atk_object_get_parent (obj);
662 g_signal_emit_by_name (parent, "selection-changed");
666 gtk_menu_item_accessible_add_selection (AtkSelection *selection,
676 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
680 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
684 shell = GTK_MENU_SHELL (menu);
685 kids = gtk_container_get_children (GTK_CONTAINER (shell));
686 length = g_list_length (kids);
687 if (i < 0 || i > length)
693 child = g_list_nth_data (kids, i);
695 g_return_val_if_fail (GTK_IS_MENU_ITEM (child), FALSE);
696 gtk_menu_shell_select_item (shell, GTK_WIDGET (child));
701 gtk_menu_item_accessible_clear_selection (AtkSelection *selection)
706 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
710 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
714 gtk_menu_shell_deselect (GTK_MENU_SHELL (menu));
720 gtk_menu_item_accessible_ref_selection (AtkSelection *selection,
732 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
736 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
740 shell = GTK_MENU_SHELL (menu);
742 item = gtk_menu_shell_get_selected_item (shell);
745 obj = gtk_widget_get_accessible (item);
754 gtk_menu_item_accessible_get_selection_count (AtkSelection *selection)
760 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
764 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
768 shell = GTK_MENU_SHELL (menu);
770 if (gtk_menu_shell_get_selected_item (shell) != NULL)
777 gtk_menu_item_accessible_is_child_selected (AtkSelection *selection,
787 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
791 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
795 shell = GTK_MENU_SHELL (menu);
797 item = gtk_menu_shell_get_selected_item (shell);
801 kids = gtk_container_get_children (GTK_CONTAINER (shell));
802 j = g_list_index (kids, item);
809 gtk_menu_item_accessible_remove_selection (AtkSelection *selection,
820 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
824 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
828 shell = GTK_MENU_SHELL (menu);
830 item = gtk_menu_shell_get_selected_item (shell);
831 if (item && gtk_menu_item_get_submenu (GTK_MENU_ITEM (item)))
832 gtk_menu_shell_deselect (shell);
838 atk_selection_interface_init (AtkSelectionIface *iface)
840 iface->add_selection = gtk_menu_item_accessible_add_selection;
841 iface->clear_selection = gtk_menu_item_accessible_clear_selection;
842 iface->ref_selection = gtk_menu_item_accessible_ref_selection;
843 iface->get_selection_count = gtk_menu_item_accessible_get_selection_count;
844 iface->is_child_selected = gtk_menu_item_accessible_is_child_selected;
845 iface->remove_selection = gtk_menu_item_accessible_remove_selection;
849 menu_item_add_gtk (GtkContainer *container,
852 GtkWidget *parent_widget;
854 g_return_val_if_fail (GTK_IS_MENU (container), 1);
856 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (container));
857 if (GTK_IS_MENU_ITEM (parent_widget))
859 GTK_CONTAINER_ACCESSIBLE_CLASS (gtk_menu_item_accessible_parent_class)->add_gtk (container, widget, gtk_widget_get_accessible (parent_widget));
866 menu_item_remove_gtk (GtkContainer *container,
869 GtkWidget *parent_widget;
871 g_return_val_if_fail (GTK_IS_MENU (container), 1);
873 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (container));
874 if (GTK_IS_MENU_ITEM (parent_widget))
876 GTK_CONTAINER_ACCESSIBLE_CLASS (gtk_menu_item_accessible_parent_class)->remove_gtk (container, widget, gtk_widget_get_accessible (parent_widget));
881 menu_item_select (GtkMenuItem *item)
883 menu_item_selection (item, TRUE);
887 menu_item_deselect (GtkMenuItem *item)
889 menu_item_selection (item, FALSE);