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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
24 #include "gtkentryaccessible.h"
25 #include "gtkcomboboxaccessible.h"
29 static void insert_text_cb (GtkEditable *editable,
33 static void delete_text_cb (GtkEditable *editable,
37 static gboolean check_for_selection_change (GtkEntryAccessible *entry,
41 static void atk_editable_text_interface_init (AtkEditableTextIface *iface);
42 static void atk_text_interface_init (AtkTextIface *iface);
43 static void atk_action_interface_init (AtkActionIface *iface);
46 G_DEFINE_TYPE_WITH_CODE (GtkEntryAccessible, _gtk_entry_accessible, GTK_TYPE_WIDGET_ACCESSIBLE,
47 G_IMPLEMENT_INTERFACE (ATK_TYPE_EDITABLE_TEXT, atk_editable_text_interface_init)
48 G_IMPLEMENT_INTERFACE (ATK_TYPE_TEXT, atk_text_interface_init)
49 G_IMPLEMENT_INTERFACE (ATK_TYPE_ACTION, atk_action_interface_init))
53 gtk_entry_accessible_ref_state_set (AtkObject *accessible)
55 AtkStateSet *state_set;
59 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
63 state_set = ATK_OBJECT_CLASS (_gtk_entry_accessible_parent_class)->ref_state_set (accessible);
65 g_object_get (G_OBJECT (widget), "editable", &value, NULL);
67 atk_state_set_add_state (state_set, ATK_STATE_EDITABLE);
68 atk_state_set_add_state (state_set, ATK_STATE_SINGLE_LINE);
73 static AtkAttributeSet *
74 gtk_entry_accessible_get_attributes (AtkObject *accessible)
77 AtkAttributeSet *attributes;
78 AtkAttribute *placeholder_text;
81 attributes = ATK_OBJECT_CLASS (_gtk_entry_accessible_parent_class)->get_attributes (accessible);
83 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
87 text = gtk_entry_get_placeholder_text (GTK_ENTRY (widget));
91 placeholder_text = g_malloc (sizeof (AtkAttribute));
92 placeholder_text->name = g_strdup ("placeholder-text");
93 placeholder_text->value = g_strdup (text);
95 attributes = g_slist_append (attributes, placeholder_text);
101 gtk_entry_accessible_initialize (AtkObject *obj,
105 GtkEntryAccessible *gtk_entry_accessible;
106 gint start_pos, end_pos;
108 ATK_OBJECT_CLASS (_gtk_entry_accessible_parent_class)->initialize (obj, data);
110 gtk_entry_accessible = GTK_ENTRY_ACCESSIBLE (obj);
112 entry = GTK_ENTRY (data);
113 gtk_editable_get_selection_bounds (GTK_EDITABLE (entry),
114 &start_pos, &end_pos);
115 gtk_entry_accessible->cursor_position = end_pos;
116 gtk_entry_accessible->selection_bound = start_pos;
118 /* Set up signal callbacks */
119 g_signal_connect (entry, "insert-text", G_CALLBACK (insert_text_cb), NULL);
120 g_signal_connect (entry, "delete-text", G_CALLBACK (delete_text_cb), NULL);
122 if (gtk_entry_get_visibility (entry))
123 obj->role = ATK_ROLE_TEXT;
125 obj->role = ATK_ROLE_PASSWORD_TEXT;
129 gtk_entry_accessible_notify_gtk (GObject *obj,
135 GtkEntryAccessible* entry;
137 widget = GTK_WIDGET (obj);
138 atk_obj = gtk_widget_get_accessible (widget);
139 gtk_entry = GTK_ENTRY (widget);
140 entry = GTK_ENTRY_ACCESSIBLE (atk_obj);
142 if (g_strcmp0 (pspec->name, "cursor-position") == 0)
144 if (check_for_selection_change (entry, gtk_entry))
145 g_signal_emit_by_name (atk_obj, "text-selection-changed");
147 * The entry cursor position has moved so generate the signal.
149 g_signal_emit_by_name (atk_obj, "text-caret-moved",
150 entry->cursor_position);
152 else if (g_strcmp0 (pspec->name, "selection-bound") == 0)
154 if (check_for_selection_change (entry, gtk_entry))
155 g_signal_emit_by_name (atk_obj, "text-selection-changed");
157 else if (g_strcmp0 (pspec->name, "editable") == 0)
161 g_object_get (obj, "editable", &value, NULL);
162 atk_object_notify_state_change (atk_obj, ATK_STATE_EDITABLE, value);
164 else if (g_strcmp0 (pspec->name, "visibility") == 0)
169 visibility = gtk_entry_get_visibility (gtk_entry);
170 new_role = visibility ? ATK_ROLE_TEXT : ATK_ROLE_PASSWORD_TEXT;
171 atk_object_set_role (atk_obj, new_role);
174 GTK_WIDGET_ACCESSIBLE_CLASS (_gtk_entry_accessible_parent_class)->notify_gtk (obj, pspec);
178 gtk_entry_accessible_get_index_in_parent (AtkObject *accessible)
181 * If the parent widget is a combo box then the index is 1
182 * otherwise do the normal thing.
184 if (accessible->accessible_parent)
185 if (GTK_IS_COMBO_BOX_ACCESSIBLE (accessible->accessible_parent))
188 return ATK_OBJECT_CLASS (_gtk_entry_accessible_parent_class)->get_index_in_parent (accessible);
192 _gtk_entry_accessible_class_init (GtkEntryAccessibleClass *klass)
194 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
195 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
197 class->ref_state_set = gtk_entry_accessible_ref_state_set;
198 class->get_index_in_parent = gtk_entry_accessible_get_index_in_parent;
199 class->initialize = gtk_entry_accessible_initialize;
200 class->get_attributes = gtk_entry_accessible_get_attributes;
202 widget_class->notify_gtk = gtk_entry_accessible_notify_gtk;
206 _gtk_entry_accessible_init (GtkEntryAccessible *entry)
208 entry->cursor_position = 0;
209 entry->selection_bound = 0;
213 gtk_entry_accessible_get_text (AtkText *atk_text,
220 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
224 /* FIXME: is this acceptable ? */
225 if (!gtk_entry_get_visibility (GTK_ENTRY (widget)))
226 return g_strdup ("");
228 text = gtk_entry_get_text (GTK_ENTRY (widget));
231 return g_utf8_substring (text, start_pos, end_pos > -1 ? end_pos : g_utf8_strlen (text, -1));
237 gtk_entry_accessible_get_text_before_offset (AtkText *text,
239 AtkTextBoundary boundary_type,
245 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
249 /* FIXME: is this acceptable ? */
250 if (!gtk_entry_get_visibility (GTK_ENTRY (widget)))
251 return g_strdup ("");
253 return _gtk_pango_get_text_before (gtk_entry_get_layout (GTK_ENTRY (widget)),
254 boundary_type, offset,
255 start_offset, end_offset);
259 gtk_entry_accessible_get_text_at_offset (AtkText *text,
261 AtkTextBoundary boundary_type,
267 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
271 /* FIXME: is this acceptable ? */
272 if (!gtk_entry_get_visibility (GTK_ENTRY (widget)))
273 return g_strdup ("");
275 return _gtk_pango_get_text_at (gtk_entry_get_layout (GTK_ENTRY (widget)),
276 boundary_type, offset,
277 start_offset, end_offset);
281 gtk_entry_accessible_get_text_after_offset (AtkText *text,
283 AtkTextBoundary boundary_type,
289 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
293 /* FIXME: is this acceptable ? */
294 if (!gtk_entry_get_visibility (GTK_ENTRY (widget)))
295 return g_strdup ("");
297 return _gtk_pango_get_text_after (gtk_entry_get_layout (GTK_ENTRY (widget)),
298 boundary_type, offset,
299 start_offset, end_offset);
303 gtk_entry_accessible_get_character_count (AtkText *atk_text)
308 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
312 text = gtk_entry_get_text (GTK_ENTRY (widget));
315 return g_utf8_strlen (text, -1);
321 gtk_entry_accessible_get_caret_offset (AtkText *text)
325 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
329 return gtk_editable_get_position (GTK_EDITABLE (widget));
333 gtk_entry_accessible_set_caret_offset (AtkText *text,
338 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
342 gtk_editable_set_position (GTK_EDITABLE (widget), offset);
347 static AtkAttributeSet *
348 add_text_attribute (AtkAttributeSet *attributes,
349 AtkTextAttribute attr,
354 at = g_new (AtkAttribute, 1);
355 at->name = g_strdup (atk_text_attribute_get_name (attr));
356 at->value = g_strdup (atk_text_attribute_get_value (attr, i));
358 return g_slist_prepend (attributes, at);
361 static AtkAttributeSet *
362 gtk_entry_accessible_get_run_attributes (AtkText *text,
368 AtkAttributeSet *attributes;
370 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
375 attributes = add_text_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
376 gtk_widget_get_direction (widget));
377 attributes = _gtk_pango_get_run_attributes (attributes,
378 gtk_entry_get_layout (GTK_ENTRY (widget)),
386 static AtkAttributeSet *
387 gtk_entry_accessible_get_default_attributes (AtkText *text)
390 AtkAttributeSet *attributes;
392 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
397 attributes = add_text_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
398 gtk_widget_get_direction (widget));
399 attributes = _gtk_pango_get_default_attributes (attributes,
400 gtk_entry_get_layout (GTK_ENTRY (widget)));
401 attributes = _gtk_style_context_get_attributes (attributes,
402 gtk_widget_get_style_context (widget),
403 gtk_widget_get_state_flags (widget));
409 gtk_entry_accessible_get_character_extents (AtkText *text,
419 PangoRectangle char_rect;
420 const gchar *entry_text;
421 gint index, x_layout, y_layout;
423 gint x_window, y_window;
425 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
429 entry = GTK_ENTRY (widget);
431 gtk_entry_get_layout_offsets (entry, &x_layout, &y_layout);
432 entry_text = gtk_entry_get_text (entry);
433 index = g_utf8_offset_to_pointer (entry_text, offset) - entry_text;
434 pango_layout_index_to_pos (gtk_entry_get_layout (entry), index, &char_rect);
435 pango_extents_to_pixels (&char_rect, NULL);
437 window = gtk_widget_get_window (widget);
438 gdk_window_get_origin (window, &x_window, &y_window);
440 *x = x_window + x_layout + char_rect.x;
441 *y = y_window + y_layout + char_rect.y;
442 *width = char_rect.width;
443 *height = char_rect.height;
445 if (coords == ATK_XY_WINDOW)
447 window = gdk_window_get_toplevel (window);
448 gdk_window_get_origin (window, &x_window, &y_window);
456 gtk_entry_accessible_get_offset_at_point (AtkText *atk_text,
464 gint index, x_layout, y_layout;
465 gint x_window, y_window;
466 gint x_local, y_local;
469 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
473 entry = GTK_ENTRY (widget);
475 gtk_entry_get_layout_offsets (entry, &x_layout, &y_layout);
477 window = gtk_widget_get_window (widget);
478 gdk_window_get_origin (window, &x_window, &y_window);
480 x_local = x - x_layout - x_window;
481 y_local = y - y_layout - y_window;
483 if (coords == ATK_XY_WINDOW)
485 window = gdk_window_get_toplevel (window);
486 gdk_window_get_origin (window, &x_window, &y_window);
491 if (!pango_layout_xy_to_index (gtk_entry_get_layout (entry),
492 x_local * PANGO_SCALE,
493 y_local * PANGO_SCALE,
496 if (x_local < 0 || y_local < 0)
504 text = gtk_entry_get_text (entry);
505 return g_utf8_pointer_to_offset (text, text + index);
512 gtk_entry_accessible_get_n_selections (AtkText *text)
517 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
521 if (gtk_editable_get_selection_bounds (GTK_EDITABLE (widget), &start, &end))
528 gtk_entry_accessible_get_selection (AtkText *text,
535 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
539 if (selection_num != 0)
542 if (gtk_editable_get_selection_bounds (GTK_EDITABLE (widget), start_pos, end_pos))
543 return gtk_editable_get_chars (GTK_EDITABLE (widget), *start_pos, *end_pos);
549 gtk_entry_accessible_add_selection (AtkText *text,
557 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
561 entry = GTK_ENTRY (widget);
563 if (!gtk_editable_get_selection_bounds (GTK_EDITABLE (entry), &start, &end))
565 gtk_editable_select_region (GTK_EDITABLE (entry), start_pos, end_pos);
573 gtk_entry_accessible_remove_selection (AtkText *text,
579 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
583 if (selection_num != 0)
586 if (gtk_editable_get_selection_bounds (GTK_EDITABLE (widget), &start, &end))
588 gtk_editable_select_region (GTK_EDITABLE (widget), end, end);
596 gtk_entry_accessible_set_selection (AtkText *text,
604 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
608 if (selection_num != 0)
611 if (gtk_editable_get_selection_bounds (GTK_EDITABLE (widget), &start, &end))
613 gtk_editable_select_region (GTK_EDITABLE (widget), start_pos, end_pos);
621 gtk_entry_accessible_get_character_at_offset (AtkText *atk_text,
628 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
632 if (!gtk_entry_get_visibility (GTK_ENTRY (widget)))
635 text = gtk_entry_get_text (GTK_ENTRY (widget));
636 if (offset >= g_utf8_strlen (text, -1))
639 index = g_utf8_offset_to_pointer (text, offset);
641 return g_utf8_get_char (index);
645 atk_text_interface_init (AtkTextIface *iface)
647 iface->get_text = gtk_entry_accessible_get_text;
648 iface->get_character_at_offset = gtk_entry_accessible_get_character_at_offset;
649 iface->get_text_before_offset = gtk_entry_accessible_get_text_before_offset;
650 iface->get_text_at_offset = gtk_entry_accessible_get_text_at_offset;
651 iface->get_text_after_offset = gtk_entry_accessible_get_text_after_offset;
652 iface->get_caret_offset = gtk_entry_accessible_get_caret_offset;
653 iface->set_caret_offset = gtk_entry_accessible_set_caret_offset;
654 iface->get_character_count = gtk_entry_accessible_get_character_count;
655 iface->get_n_selections = gtk_entry_accessible_get_n_selections;
656 iface->get_selection = gtk_entry_accessible_get_selection;
657 iface->add_selection = gtk_entry_accessible_add_selection;
658 iface->remove_selection = gtk_entry_accessible_remove_selection;
659 iface->set_selection = gtk_entry_accessible_set_selection;
660 iface->get_run_attributes = gtk_entry_accessible_get_run_attributes;
661 iface->get_default_attributes = gtk_entry_accessible_get_default_attributes;
662 iface->get_character_extents = gtk_entry_accessible_get_character_extents;
663 iface->get_offset_at_point = gtk_entry_accessible_get_offset_at_point;
667 gtk_entry_accessible_set_text_contents (AtkEditableText *text,
672 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
676 if (!gtk_editable_get_editable (GTK_EDITABLE (widget)))
679 gtk_entry_set_text (GTK_ENTRY (widget), string);
683 gtk_entry_accessible_insert_text (AtkEditableText *text,
689 GtkEditable *editable;
691 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
695 editable = GTK_EDITABLE (widget);
696 if (!gtk_editable_get_editable (editable))
699 gtk_editable_insert_text (editable, string, length, position);
700 gtk_editable_set_position (editable, *position);
704 gtk_entry_accessible_copy_text (AtkEditableText *text,
709 GtkEditable *editable;
711 GtkClipboard *clipboard;
713 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
717 if (!gtk_widget_has_screen (widget))
720 editable = GTK_EDITABLE (widget);
721 str = gtk_editable_get_chars (editable, start_pos, end_pos);
722 clipboard = gtk_widget_get_clipboard (widget, GDK_SELECTION_CLIPBOARD);
723 gtk_clipboard_set_text (clipboard, str, -1);
728 gtk_entry_accessible_cut_text (AtkEditableText *text,
733 GtkEditable *editable;
735 GtkClipboard *clipboard;
737 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
741 if (!gtk_widget_has_screen (widget))
744 editable = GTK_EDITABLE (widget);
745 if (!gtk_editable_get_editable (editable))
748 str = gtk_editable_get_chars (editable, start_pos, end_pos);
749 clipboard = gtk_widget_get_clipboard (widget, GDK_SELECTION_CLIPBOARD);
750 gtk_clipboard_set_text (clipboard, str, -1);
751 gtk_editable_delete_text (editable, start_pos, end_pos);
755 gtk_entry_accessible_delete_text (AtkEditableText *text,
760 GtkEditable *editable;
762 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
766 editable = GTK_EDITABLE (widget);
767 if (!gtk_editable_get_editable (editable))
770 gtk_editable_delete_text (editable, start_pos, end_pos);
780 paste_received_cb (GtkClipboard *clipboard,
784 PasteData *paste = data;
787 gtk_editable_insert_text (GTK_EDITABLE (paste->entry), text, -1,
790 g_object_unref (paste->entry);
795 gtk_entry_accessible_paste_text (AtkEditableText *text,
799 GtkEditable *editable;
801 GtkClipboard *clipboard;
803 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
807 if (!gtk_widget_has_screen (widget))
810 editable = GTK_EDITABLE (widget);
811 if (!gtk_editable_get_editable (editable))
814 paste = g_new0 (PasteData, 1);
815 paste->entry = GTK_ENTRY (widget);
816 paste->position = position;
818 g_object_ref (paste->entry);
819 clipboard = gtk_widget_get_clipboard (widget, GDK_SELECTION_CLIPBOARD);
820 gtk_clipboard_request_text (clipboard, paste_received_cb, paste);
824 atk_editable_text_interface_init (AtkEditableTextIface *iface)
826 iface->set_text_contents = gtk_entry_accessible_set_text_contents;
827 iface->insert_text = gtk_entry_accessible_insert_text;
828 iface->copy_text = gtk_entry_accessible_copy_text;
829 iface->cut_text = gtk_entry_accessible_cut_text;
830 iface->delete_text = gtk_entry_accessible_delete_text;
831 iface->paste_text = gtk_entry_accessible_paste_text;
832 iface->set_run_attributes = NULL;
835 /* We connect to GtkEditable::insert-text, since it carries
836 * the information we need. But we delay emitting our own
837 * text_changed::insert signal until the entry has update
838 * all its internal state and emits GtkEntry::changed.
841 insert_text_cb (GtkEditable *editable,
843 gint new_text_length,
846 GtkEntryAccessible *accessible;
848 if (new_text_length == 0)
851 accessible = GTK_ENTRY_ACCESSIBLE (gtk_widget_get_accessible (GTK_WIDGET (editable)));
853 g_signal_emit_by_name (accessible,
854 "text-changed::insert",
856 g_utf8_strlen (new_text, new_text_length));
859 /* We connect to GtkEditable::delete-text, since it carries
860 * the information we need. But we delay emitting our own
861 * text_changed::delete signal until the entry has update
862 * all its internal state and emits GtkEntry::changed.
865 delete_text_cb (GtkEditable *editable,
869 GtkEntryAccessible *accessible;
871 accessible = GTK_ENTRY_ACCESSIBLE (gtk_widget_get_accessible (GTK_WIDGET (editable)));
877 text = gtk_entry_get_text (GTK_ENTRY (editable));
878 end = g_utf8_strlen (text, -1);
884 g_signal_emit_by_name (accessible,
885 "text-changed::delete",
891 check_for_selection_change (GtkEntryAccessible *accessible,
894 gboolean ret_val = FALSE;
897 if (gtk_editable_get_selection_bounds (GTK_EDITABLE (entry), &start, &end))
899 if (end != accessible->cursor_position ||
900 start != accessible->selection_bound)
902 * This check is here as this function can be called
903 * for notification of selection_bound and current_pos.
904 * The values of current_pos and selection_bound may be the same
905 * for both notifications and we only want to generate one
906 * text_selection_changed signal.
912 /* We had a selection */
913 ret_val = (accessible->cursor_position != accessible->selection_bound);
916 accessible->cursor_position = end;
917 accessible->selection_bound = start;
923 gtk_entry_accessible_do_action (AtkAction *action,
928 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
932 if (!gtk_widget_get_sensitive (widget) || !gtk_widget_get_visible (widget))
938 gtk_widget_activate (widget);
944 gtk_entry_accessible_get_n_actions (AtkAction *action)
950 gtk_entry_accessible_get_keybinding (AtkAction *action,
956 AtkRelation *relation;
958 gpointer target_object;
964 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (action));
968 set = atk_object_ref_relation_set (ATK_OBJECT (action));
973 relation = atk_relation_set_get_relation_by_type (set, ATK_RELATION_LABELLED_BY);
976 target = atk_relation_get_target (relation);
978 target_object = g_ptr_array_index (target, 0);
979 label = gtk_accessible_get_widget (GTK_ACCESSIBLE (target_object));
982 g_object_unref (set);
984 if (GTK_IS_LABEL (label))
986 key_val = gtk_label_get_mnemonic_keyval (GTK_LABEL (label));
987 if (key_val != GDK_KEY_VoidSymbol)
988 return gtk_accelerator_name (key_val, GDK_MOD1_MASK);
995 gtk_entry_accessible_action_get_name (AtkAction *action,
1005 atk_action_interface_init (AtkActionIface *iface)
1007 iface->do_action = gtk_entry_accessible_do_action;
1008 iface->get_n_actions = gtk_entry_accessible_get_n_actions;
1009 iface->get_keybinding = gtk_entry_accessible_get_keybinding;
1010 iface->get_name = gtk_entry_accessible_action_get_name;