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 "gtkmenuitemaccessible.h"
21 #include "gtkwidgetaccessibleprivate.h"
22 #include "gtk/gtkmenuitemprivate.h"
24 struct _GtkMenuItemAccessiblePrivate
30 #define KEYBINDING_SEPARATOR ";"
32 static void menu_item_select (GtkMenuItem *item);
33 static void menu_item_deselect (GtkMenuItem *item);
35 static GtkWidget *get_label_from_container (GtkWidget *container);
36 static gchar *get_text_from_label_widget (GtkWidget *widget);
38 static gint menu_item_add_gtk (GtkContainer *container,
40 static gint menu_item_remove_gtk (GtkContainer *container,
43 static void atk_action_interface_init (AtkActionIface *iface);
44 static void atk_selection_interface_init (AtkSelectionIface *iface);
46 G_DEFINE_TYPE_WITH_CODE (GtkMenuItemAccessible, gtk_menu_item_accessible, GTK_TYPE_CONTAINER_ACCESSIBLE,
47 G_IMPLEMENT_INTERFACE (ATK_TYPE_ACTION, atk_action_interface_init);
48 G_IMPLEMENT_INTERFACE (ATK_TYPE_SELECTION, atk_selection_interface_init))
51 gtk_menu_item_accessible_initialize (AtkObject *obj,
58 ATK_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->initialize (obj, data);
60 g_signal_connect (data, "select", G_CALLBACK (menu_item_select), NULL);
61 g_signal_connect (data, "deselect", G_CALLBACK (menu_item_deselect), NULL);
63 widget = GTK_WIDGET (data);
64 parent = gtk_widget_get_parent (widget);
65 if (GTK_IS_MENU (parent))
67 GtkWidget *parent_widget;
69 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (parent));
71 if (!GTK_IS_MENU_ITEM (parent_widget))
72 parent_widget = gtk_widget_get_parent (widget);
74 atk_object_set_parent (obj, gtk_widget_get_accessible (parent_widget));
77 _gtk_widget_accessible_set_layer (GTK_WIDGET_ACCESSIBLE (obj), ATK_LAYER_POPUP);
79 obj->role = ATK_ROLE_MENU_ITEM;
81 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (data));
84 g_signal_connect (menu, "add", G_CALLBACK (menu_item_add_gtk), NULL);
85 g_signal_connect (menu, "remove", G_CALLBACK (menu_item_remove_gtk), NULL);
90 gtk_menu_item_accessible_get_n_children (AtkObject *obj)
96 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
100 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
105 children = gtk_container_get_children (GTK_CONTAINER (submenu));
106 count = g_list_length (children);
107 g_list_free (children);
113 gtk_menu_item_accessible_ref_child (AtkObject *obj,
116 AtkObject *accessible;
120 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
125 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
131 children = gtk_container_get_children (GTK_CONTAINER (submenu));
132 tmp_list = g_list_nth (children, i);
135 accessible = gtk_widget_get_accessible (GTK_WIDGET (tmp_list->data));
136 g_object_ref (accessible);
138 g_list_free (children);
145 gtk_menu_item_accessible_ref_state_set (AtkObject *obj)
147 AtkObject *menu_item;
148 AtkStateSet *state_set, *parent_state_set;
150 state_set = ATK_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->ref_state_set (obj);
152 atk_state_set_add_state (state_set, ATK_STATE_SELECTABLE);
153 if (GTK_MENU_ITEM_ACCESSIBLE (obj)->priv->selected)
154 atk_state_set_add_state (state_set, ATK_STATE_SELECTED);
156 menu_item = atk_object_get_parent (obj);
160 if (!GTK_IS_MENU_ITEM (gtk_accessible_get_widget (GTK_ACCESSIBLE (menu_item))))
163 parent_state_set = atk_object_ref_state_set (menu_item);
164 if (!atk_state_set_contains_state (parent_state_set, ATK_STATE_SELECTED))
166 atk_state_set_remove_state (state_set, ATK_STATE_FOCUSED);
167 atk_state_set_remove_state (state_set, ATK_STATE_SHOWING);
169 g_object_unref (parent_state_set);
176 gtk_menu_item_accessible_get_role (AtkObject *obj)
180 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
181 if (widget != NULL &&
182 gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget)))
183 return ATK_ROLE_MENU;
185 return ATK_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->get_role (obj);
189 gtk_menu_item_accessible_get_name (AtkObject *obj)
194 GtkMenuItemAccessible *accessible;
196 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
200 name = ATK_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->get_name (obj);
204 accessible = GTK_MENU_ITEM_ACCESSIBLE (obj);
205 label = get_label_from_container (widget);
207 g_free (accessible->priv->text);
208 accessible->priv->text = get_text_from_label_widget (label);
210 return accessible->priv->text;
214 gtk_menu_item_accessible_finalize (GObject *object)
216 GtkMenuItemAccessible *accessible = GTK_MENU_ITEM_ACCESSIBLE (object);
218 g_free (accessible->priv->text);
220 G_OBJECT_CLASS (gtk_menu_item_accessible_parent_class)->finalize (object);
224 gtk_menu_item_accessible_notify_gtk (GObject *obj,
229 atk_obj = gtk_widget_get_accessible (GTK_WIDGET (obj));
231 if (strcmp (pspec->name, "label") == 0)
233 if (atk_obj->name == NULL)
234 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
235 g_signal_emit_by_name (atk_obj, "visible-data-changed");
238 GTK_WIDGET_ACCESSIBLE_CLASS (gtk_menu_item_accessible_parent_class)->notify_gtk (obj, pspec);
242 gtk_menu_item_accessible_class_init (GtkMenuItemAccessibleClass *klass)
244 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
245 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
246 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
248 widget_class->notify_gtk = gtk_menu_item_accessible_notify_gtk;
250 gobject_class->finalize = gtk_menu_item_accessible_finalize;
252 class->get_n_children = gtk_menu_item_accessible_get_n_children;
253 class->ref_child = gtk_menu_item_accessible_ref_child;
254 class->ref_state_set = gtk_menu_item_accessible_ref_state_set;
255 class->initialize = gtk_menu_item_accessible_initialize;
256 class->get_name = gtk_menu_item_accessible_get_name;
257 class->get_role = gtk_menu_item_accessible_get_role;
259 g_type_class_add_private (klass, sizeof (GtkMenuItemAccessiblePrivate));
263 gtk_menu_item_accessible_init (GtkMenuItemAccessible *menu_item)
265 menu_item->priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_item,
266 GTK_TYPE_MENU_ITEM_ACCESSIBLE,
267 GtkMenuItemAccessiblePrivate);
271 get_label_from_container (GtkWidget *container)
274 GList *children, *tmp_list;
276 if (!GTK_IS_CONTAINER (container))
279 children = gtk_container_get_children (GTK_CONTAINER (container));
282 for (tmp_list = children; tmp_list != NULL; tmp_list = tmp_list->next)
284 if (GTK_IS_LABEL (tmp_list->data))
286 label = tmp_list->data;
289 else if (GTK_IS_CELL_VIEW (tmp_list->data))
291 label = tmp_list->data;
294 else if (GTK_IS_BOX (tmp_list->data))
296 label = get_label_from_container (GTK_WIDGET (tmp_list->data));
301 g_list_free (children);
307 get_text_from_label_widget (GtkWidget *label)
309 if (GTK_IS_LABEL (label))
310 return g_strdup (gtk_label_get_text (GTK_LABEL (label)));
311 else if (GTK_IS_CELL_VIEW (label))
320 model = gtk_cell_view_get_model (GTK_CELL_VIEW (label));
321 path = gtk_cell_view_get_displayed_row (GTK_CELL_VIEW (label));
322 gtk_tree_model_get_iter (model, &iter, path);
323 gtk_tree_path_free (path);
325 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (label));
326 gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
327 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (label));
330 for (l = cells; l; l = l->next)
332 GtkCellRenderer *cell = l->data;
334 if (GTK_IS_CELL_RENDERER_TEXT (cell))
336 g_object_get (cell, "text", &text, NULL);
350 ensure_menus_unposted (GtkMenuItemAccessible *menu_item)
355 parent = atk_object_get_parent (ATK_OBJECT (menu_item));
358 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (parent));
359 if (GTK_IS_MENU (widget))
361 if (gtk_widget_get_mapped (widget))
362 gtk_menu_shell_cancel (GTK_MENU_SHELL (widget));
366 parent = atk_object_get_parent (parent);
371 gtk_menu_item_accessible_do_action (AtkAction *action,
374 GtkWidget *item, *item_parent;
375 gboolean item_mapped;
377 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
384 if (!gtk_widget_get_sensitive (item) || !gtk_widget_get_visible (item))
387 item_parent = gtk_widget_get_parent (item);
388 if (!GTK_IS_MENU_SHELL (item_parent))
391 gtk_menu_shell_select_item (GTK_MENU_SHELL (item_parent), item);
392 item_mapped = gtk_widget_get_mapped (item);
394 /* This is what is called when <Return> is pressed for a menu item.
395 * The last argument means 'force hide'.
397 g_signal_emit_by_name (item_parent, "activate-current", 1);
399 ensure_menus_unposted (GTK_MENU_ITEM_ACCESSIBLE (action));
405 gtk_menu_item_accessible_get_n_actions (AtkAction *action)
409 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
413 if (!_gtk_menu_item_is_selectable (item))
420 gtk_menu_item_accessible_action_get_name (AtkAction *action,
423 if (i != 0 || gtk_menu_item_accessible_get_n_actions (action) == 0)
430 find_accel_by_widget (GtkAccelKey *key,
434 /* We assume that closure->data points to the widget
435 * pending gtk_widget_get_accel_closures being made public
437 return data == (gpointer) closure->data;
441 find_accel_by_closure (GtkAccelKey *key,
445 return data == (gpointer) closure;
448 /* This function returns a string of the form A;B;C where A is
449 * the keybinding for the widget; B is the keybinding to traverse
450 * from the menubar and C is the accelerator. The items in the
451 * keybinding to traverse from the menubar are separated by ":".
454 gtk_menu_item_accessible_get_keybinding (AtkAction *action,
457 gchar *keybinding = NULL;
458 gchar *item_keybinding = NULL;
459 gchar *full_keybinding = NULL;
460 gchar *accelerator = NULL;
462 GtkWidget *temp_item;
466 item = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
476 GdkModifierType mnemonic_modifier = 0;
478 gchar *key, *temp_keybinding;
480 child = gtk_bin_get_child (GTK_BIN (temp_item));
484 parent = gtk_widget_get_parent (temp_item);
486 /* parent can be NULL when activating a window from the panel */
489 if (GTK_IS_MENU_BAR (parent))
493 toplevel = gtk_widget_get_toplevel (parent);
494 if (toplevel && GTK_IS_WINDOW (toplevel))
496 gtk_window_get_mnemonic_modifier (GTK_WINDOW (toplevel));
499 if (GTK_IS_LABEL (child))
501 key_val = gtk_label_get_mnemonic_keyval (GTK_LABEL (child));
502 if (key_val != GDK_KEY_VoidSymbol)
504 key = gtk_accelerator_name (key_val, mnemonic_modifier);
506 temp_keybinding = g_strconcat (key, ":", full_keybinding, NULL);
508 temp_keybinding = g_strdup (key);
510 if (temp_item == item)
511 item_keybinding = g_strdup (key);
514 g_free (full_keybinding);
515 full_keybinding = temp_keybinding;
520 g_free (full_keybinding);
521 full_keybinding = NULL;
526 /* We have reached the menu bar so we are finished */
527 if (GTK_IS_MENU_BAR (parent))
530 g_return_val_if_fail (GTK_IS_MENU (parent), NULL);
531 temp_item = gtk_menu_get_attach_widget (GTK_MENU (parent));
532 if (!GTK_IS_MENU_ITEM (temp_item))
534 /* Menu is attached to something other than a menu item;
535 * probably an option menu
537 g_free (full_keybinding);
538 full_keybinding = NULL;
543 parent = gtk_widget_get_parent (item);
544 if (GTK_IS_MENU (parent))
546 GtkAccelGroup *group;
549 group = gtk_menu_get_accel_group (GTK_MENU (parent));
551 key = gtk_accel_group_find (group, find_accel_by_widget, item);
555 child = gtk_bin_get_child (GTK_BIN (item));
556 if (GTK_IS_ACCEL_LABEL (child))
558 GtkAccelLabel *accel_label;
559 GClosure *accel_closure;
561 accel_label = GTK_ACCEL_LABEL (child);
562 g_object_get (accel_label, "accel-closure", &accel_closure, NULL);
565 key = gtk_accel_group_find (gtk_accel_group_from_accel_closure (accel_closure),
566 find_accel_by_closure,
568 g_closure_unref (accel_closure);
574 accelerator = gtk_accelerator_name (key->accel_key, key->accel_mods);
577 /* Concatenate the bindings */
578 if (item_keybinding || full_keybinding || accelerator)
583 keybinding = g_strconcat (item_keybinding, KEYBINDING_SEPARATOR, NULL);
584 g_free (item_keybinding);
587 keybinding = g_strdup (KEYBINDING_SEPARATOR);
591 temp = g_strconcat (keybinding, full_keybinding,
592 KEYBINDING_SEPARATOR, NULL);
593 g_free (full_keybinding);
596 temp = g_strconcat (keybinding, KEYBINDING_SEPARATOR, NULL);
602 temp = g_strconcat (keybinding, accelerator, NULL);
603 g_free (accelerator);
613 atk_action_interface_init (AtkActionIface *iface)
615 iface->do_action = gtk_menu_item_accessible_do_action;
616 iface->get_n_actions = gtk_menu_item_accessible_get_n_actions;
617 iface->get_name = gtk_menu_item_accessible_action_get_name;
618 iface->get_keybinding = gtk_menu_item_accessible_get_keybinding;
622 menu_item_selection (GtkMenuItem *item,
625 AtkObject *obj, *parent;
628 obj = gtk_widget_get_accessible (GTK_WIDGET (item));
629 GTK_MENU_ITEM_ACCESSIBLE (obj)->priv->selected = selected;
630 atk_object_notify_state_change (obj, ATK_STATE_SELECTED, selected);
632 for (i = 0; i < atk_object_get_n_accessible_children (obj); i++)
635 child = atk_object_ref_accessible_child (obj, i);
636 atk_object_notify_state_change (child, ATK_STATE_SHOWING, selected);
637 g_object_unref (child);
639 parent = atk_object_get_parent (obj);
640 g_signal_emit_by_name (parent, "selection-changed");
644 gtk_menu_item_accessible_add_selection (AtkSelection *selection,
654 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
658 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
662 shell = GTK_MENU_SHELL (menu);
663 kids = gtk_container_get_children (GTK_CONTAINER (shell));
664 length = g_list_length (kids);
665 if (i < 0 || i > length)
671 child = g_list_nth_data (kids, i);
673 g_return_val_if_fail (GTK_IS_MENU_ITEM (child), FALSE);
674 gtk_menu_shell_select_item (shell, GTK_WIDGET (child));
679 gtk_menu_item_accessible_clear_selection (AtkSelection *selection)
684 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
688 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
692 gtk_menu_shell_deselect (GTK_MENU_SHELL (menu));
698 gtk_menu_item_accessible_ref_selection (AtkSelection *selection,
710 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
714 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
718 shell = GTK_MENU_SHELL (menu);
720 item = gtk_menu_shell_get_selected_item (shell);
723 obj = gtk_widget_get_accessible (item);
732 gtk_menu_item_accessible_get_selection_count (AtkSelection *selection)
738 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
742 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
746 shell = GTK_MENU_SHELL (menu);
748 if (gtk_menu_shell_get_selected_item (shell) != NULL)
755 gtk_menu_item_accessible_is_child_selected (AtkSelection *selection,
765 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
769 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
773 shell = GTK_MENU_SHELL (menu);
775 item = gtk_menu_shell_get_selected_item (shell);
779 kids = gtk_container_get_children (GTK_CONTAINER (shell));
780 j = g_list_index (kids, item);
787 gtk_menu_item_accessible_remove_selection (AtkSelection *selection,
798 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
802 menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
806 shell = GTK_MENU_SHELL (menu);
808 item = gtk_menu_shell_get_selected_item (shell);
809 if (item && gtk_menu_item_get_submenu (GTK_MENU_ITEM (item)))
810 gtk_menu_shell_deselect (shell);
816 atk_selection_interface_init (AtkSelectionIface *iface)
818 iface->add_selection = gtk_menu_item_accessible_add_selection;
819 iface->clear_selection = gtk_menu_item_accessible_clear_selection;
820 iface->ref_selection = gtk_menu_item_accessible_ref_selection;
821 iface->get_selection_count = gtk_menu_item_accessible_get_selection_count;
822 iface->is_child_selected = gtk_menu_item_accessible_is_child_selected;
823 iface->remove_selection = gtk_menu_item_accessible_remove_selection;
827 menu_item_add_gtk (GtkContainer *container,
830 GtkWidget *parent_widget;
832 g_return_val_if_fail (GTK_IS_MENU (container), 1);
834 parent_widget = gtk_menu_get_attach_widget (GTK_MENU (container));
835 if (GTK_IS_MENU_ITEM (parent_widget))
837 GTK_CONTAINER_ACCESSIBLE_CLASS (gtk_menu_item_accessible_parent_class)->add_gtk (container, widget, gtk_widget_get_accessible (parent_widget));
844 menu_item_remove_gtk (GtkContainer *container,
847 GtkWidget *parent_widget;
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 GTK_CONTAINER_ACCESSIBLE_CLASS (gtk_menu_item_accessible_parent_class)->remove_gtk (container, widget, gtk_widget_get_accessible (parent_widget));
859 menu_item_select (GtkMenuItem *item)
861 menu_item_selection (item, TRUE);
865 menu_item_deselect (GtkMenuItem *item)
867 menu_item_selection (item, FALSE);