1 /* GAIL - The GNOME Accessibility Enabling 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/>.
21 #include <gtk/gtkpango.h>
22 #include "gtklabelaccessible.h"
25 static void atk_text_interface_init (AtkTextIface *iface);
27 G_DEFINE_TYPE_WITH_CODE (GtkLabelAccessible, _gtk_label_accessible, GTK_TYPE_WIDGET_ACCESSIBLE,
28 G_IMPLEMENT_INTERFACE (ATK_TYPE_TEXT, atk_text_interface_init))
31 _gtk_label_accessible_init (GtkLabelAccessible *label)
36 gtk_label_accessible_initialize (AtkObject *obj,
40 GtkLabelAccessible *accessible;
42 ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->initialize (obj, data);
44 accessible = GTK_LABEL_ACCESSIBLE (obj);
46 widget = GTK_WIDGET (data);
48 accessible->text = g_strdup (gtk_label_get_text (GTK_LABEL (widget)));
51 * Check whether ancestor of GtkLabel is a GtkButton and if so
52 * set accessible parent for GtkLabelAccessible
54 while (widget != NULL)
56 widget = gtk_widget_get_parent (widget);
57 if (GTK_IS_BUTTON (widget))
59 atk_object_set_parent (obj, gtk_widget_get_accessible (widget));
64 obj->role = ATK_ROLE_LABEL;
68 check_for_selection_change (GtkLabelAccessible *accessible,
71 gboolean ret_val = FALSE;
74 if (gtk_label_get_selection_bounds (label, &start, &end))
76 if (end != accessible->cursor_position ||
77 start != accessible->selection_bound)
82 ret_val = (accessible->cursor_position != accessible->selection_bound);
85 accessible->cursor_position = end;
86 accessible->selection_bound = start;
93 gtk_label_accessible_notify_gtk (GObject *obj,
96 GtkWidget *widget = GTK_WIDGET (obj);
97 AtkObject* atk_obj = gtk_widget_get_accessible (widget);
98 GtkLabelAccessible *accessible;
101 accessible = GTK_LABEL_ACCESSIBLE (atk_obj);
103 if (g_strcmp0 (pspec->name, "label") == 0)
107 text = gtk_label_get_text (GTK_LABEL (widget));
108 if (g_strcmp0 (accessible->text, text) == 0)
111 /* Create a delete text and an insert text signal */
112 length = g_utf8_strlen (accessible->text, -1);
114 g_signal_emit_by_name (atk_obj, "text-changed::delete", 0, length);
116 g_free (accessible->text);
117 accessible->text = g_strdup (text);
119 length = g_utf8_strlen (accessible->text, -1);
121 g_signal_emit_by_name (atk_obj, "text-changed::insert", 0, length);
123 if (atk_obj->name == NULL)
124 /* The label has changed so notify a change in accessible-name */
125 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
127 g_signal_emit_by_name (atk_obj, "visible-data-changed");
129 else if (g_strcmp0 (pspec->name, "cursor-position") == 0)
131 g_signal_emit_by_name (atk_obj, "text-caret-moved",
132 _gtk_label_get_cursor_position (GTK_LABEL (widget)));
133 if (check_for_selection_change (accessible, GTK_LABEL (widget)))
134 g_signal_emit_by_name (atk_obj, "text-selection-changed");
136 else if (g_strcmp0 (pspec->name, "selection-bound") == 0)
138 if (check_for_selection_change (accessible, GTK_LABEL (widget)))
139 g_signal_emit_by_name (atk_obj, "text-selection-changed");
142 GTK_WIDGET_ACCESSIBLE_CLASS (_gtk_label_accessible_parent_class)->notify_gtk (obj, pspec);
146 gtk_label_accessible_finalize (GObject *object)
148 GtkLabelAccessible *accessible = GTK_LABEL_ACCESSIBLE (object);
150 g_free (accessible->text);
152 G_OBJECT_CLASS (_gtk_label_accessible_parent_class)->finalize (object);
159 gtk_label_accessible_ref_state_set (AtkObject *accessible)
161 AtkStateSet *state_set;
164 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
168 state_set = ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->ref_state_set (accessible);
169 atk_state_set_add_state (state_set, ATK_STATE_MULTI_LINE);
174 static AtkRelationSet *
175 gtk_label_accessible_ref_relation_set (AtkObject *obj)
178 AtkRelationSet *relation_set;
180 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (obj), NULL);
182 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
186 relation_set = ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->ref_relation_set (obj);
188 if (!atk_relation_set_contains (relation_set, ATK_RELATION_LABEL_FOR))
190 /* Get the mnemonic widget.
191 * The relation set is not updated if the mnemonic widget is changed
193 GtkWidget *mnemonic_widget;
195 mnemonic_widget = gtk_label_get_mnemonic_widget (GTK_LABEL (widget));
199 AtkObject *accessible_array[1];
200 AtkRelation* relation;
202 if (!gtk_widget_get_can_focus (mnemonic_widget))
205 * Handle the case where a GtkFileChooserButton is specified
206 * as the mnemonic widget. use the combobox which is a child of the
207 * GtkFileChooserButton as the mnemonic widget. See bug #359843.
209 if (GTK_IS_BOX (mnemonic_widget))
213 list = gtk_container_get_children (GTK_CONTAINER (mnemonic_widget));
214 if (g_list_length (list) == 2)
216 tmpl = g_list_last (list);
217 if (GTK_IS_COMBO_BOX(tmpl->data))
219 mnemonic_widget = GTK_WIDGET(tmpl->data);
225 accessible_array[0] = gtk_widget_get_accessible (mnemonic_widget);
226 relation = atk_relation_new (accessible_array, 1,
227 ATK_RELATION_LABEL_FOR);
228 atk_relation_set_add (relation_set, relation);
230 * Unref the relation so that it is not leaked.
232 g_object_unref (relation);
239 gtk_label_accessible_get_name (AtkObject *accessible)
243 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (accessible), NULL);
245 name = ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->get_name (accessible);
251 * Get the text on the label
255 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
259 g_return_val_if_fail (GTK_IS_LABEL (widget), NULL);
261 return gtk_label_get_text (GTK_LABEL (widget));
266 _gtk_label_accessible_class_init (GtkLabelAccessibleClass *klass)
268 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
269 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
270 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
272 gobject_class->finalize = gtk_label_accessible_finalize;
274 widget_class->notify_gtk = gtk_label_accessible_notify_gtk;
276 class->get_name = gtk_label_accessible_get_name;
277 class->ref_state_set = gtk_label_accessible_ref_state_set;
278 class->ref_relation_set = gtk_label_accessible_ref_relation_set;
279 class->initialize = gtk_label_accessible_initialize;
285 gtk_label_accessible_get_text (AtkText *atk_text,
292 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
296 text = gtk_label_get_text (GTK_LABEL (widget));
299 return g_utf8_substring (text, start_pos, end_pos > -1 ? end_pos : g_utf8_strlen (text, -1));
305 gtk_label_accessible_get_text_before_offset (AtkText *text,
307 AtkTextBoundary boundary_type,
313 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
317 return _gtk_pango_get_text_before (gtk_label_get_layout (GTK_LABEL (widget)),
318 boundary_type, offset,
319 start_offset, end_offset);
323 gtk_label_accessible_get_text_at_offset (AtkText *text,
325 AtkTextBoundary boundary_type,
331 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
335 return _gtk_pango_get_text_at (gtk_label_get_layout (GTK_LABEL (widget)),
336 boundary_type, offset,
337 start_offset, end_offset);
341 gtk_label_accessible_get_text_after_offset (AtkText *text,
343 AtkTextBoundary boundary_type,
349 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
353 return _gtk_pango_get_text_after (gtk_label_get_layout (GTK_LABEL (widget)),
354 boundary_type, offset,
355 start_offset, end_offset);
359 gtk_label_accessible_get_character_count (AtkText *atk_text)
364 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
368 text = gtk_label_get_text (GTK_LABEL (widget));
371 return g_utf8_strlen (text, -1);
377 gtk_label_accessible_get_caret_offset (AtkText *text)
381 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
385 return _gtk_label_get_cursor_position (GTK_LABEL (widget));
389 gtk_label_accessible_set_caret_offset (AtkText *text,
395 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
399 label = GTK_LABEL (widget);
401 if (!gtk_label_get_selectable (label))
404 gtk_label_select_region (label, offset, offset);
410 gtk_label_accessible_get_n_selections (AtkText *text)
414 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
418 if (gtk_label_get_selection_bounds (GTK_LABEL (widget), NULL, NULL))
425 gtk_label_accessible_get_selection (AtkText *atk_text,
433 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
437 if (selection_num != 0)
440 label = GTK_LABEL (widget);
442 if (gtk_label_get_selection_bounds (label, start_pos, end_pos))
446 text = gtk_label_get_text (label);
449 return g_utf8_substring (text, *start_pos, *end_pos);
456 gtk_label_accessible_add_selection (AtkText *text,
464 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
468 label = GTK_LABEL (widget);
470 if (!gtk_label_get_selectable (label))
473 if (!gtk_label_get_selection_bounds (label, &start, &end))
475 gtk_label_select_region (label, start_pos, end_pos);
483 gtk_label_accessible_remove_selection (AtkText *text,
490 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
494 if (selection_num != 0)
497 label = GTK_LABEL (widget);
499 if (!gtk_label_get_selectable (label))
502 if (gtk_label_get_selection_bounds (label, &start, &end))
504 gtk_label_select_region (label, end, end);
512 gtk_label_accessible_set_selection (AtkText *text,
521 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
525 if (selection_num != 0)
528 label = GTK_LABEL (widget);
530 if (!gtk_label_get_selectable (label))
533 if (gtk_label_get_selection_bounds (label, &start, &end))
535 gtk_label_select_region (label, start_pos, end_pos);
543 gtk_label_accessible_get_character_extents (AtkText *text,
553 PangoRectangle char_rect;
554 const gchar *label_text;
555 gint index, x_layout, y_layout;
557 gint x_window, y_window;
559 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
563 label = GTK_LABEL (widget);
565 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
566 label_text = gtk_label_get_text (label);
567 index = g_utf8_offset_to_pointer (label_text, offset) - label_text;
568 pango_layout_index_to_pos (gtk_label_get_layout (label), index, &char_rect);
569 pango_extents_to_pixels (&char_rect, NULL);
571 window = gtk_widget_get_window (widget);
572 gdk_window_get_origin (window, &x_window, &y_window);
574 *x = x_window + x_layout + char_rect.x;
575 *y = y_window + y_layout + char_rect.y;
576 *width = char_rect.width;
577 *height = char_rect.height;
579 if (coords == ATK_XY_WINDOW)
581 window = gdk_window_get_toplevel (window);
582 gdk_window_get_origin (window, &x_window, &y_window);
590 gtk_label_accessible_get_offset_at_point (AtkText *atk_text,
598 gint index, x_layout, y_layout;
599 gint x_window, y_window;
600 gint x_local, y_local;
603 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
607 label = GTK_LABEL (widget);
609 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
611 window = gtk_widget_get_window (widget);
612 gdk_window_get_origin (window, &x_window, &y_window);
614 x_local = x - x_layout - x_window;
615 y_local = y - y_layout - y_window;
617 if (coords == ATK_XY_WINDOW)
619 window = gdk_window_get_toplevel (window);
620 gdk_window_get_origin (window, &x_window, &y_window);
626 if (!pango_layout_xy_to_index (gtk_label_get_layout (label),
627 x_local * PANGO_SCALE,
628 y_local * PANGO_SCALE,
631 if (x_local < 0 || y_local < 0)
639 text = gtk_label_get_text (label);
640 return g_utf8_pointer_to_offset (text, text + index);
646 static AtkAttributeSet *
647 add_attribute (AtkAttributeSet *attributes,
648 AtkTextAttribute attr,
653 at = g_new (AtkAttribute, 1);
654 at->name = g_strdup (atk_text_attribute_get_name (attr));
655 at->value = g_strdup (value);
657 return g_slist_prepend (attributes, at);
660 static AtkAttributeSet*
661 gtk_label_accessible_get_run_attributes (AtkText *text,
667 AtkAttributeSet *attributes;
669 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
674 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
675 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
676 gtk_widget_get_direction (widget)));
677 attributes = _gtk_pango_get_run_attributes (attributes,
678 gtk_label_get_layout (GTK_LABEL (widget)),
686 static AtkAttributeSet *
687 gtk_label_accessible_get_default_attributes (AtkText *text)
690 AtkAttributeSet *attributes;
692 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
697 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
698 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
699 gtk_widget_get_direction (widget)));
700 attributes = _gtk_pango_get_default_attributes (attributes,
701 gtk_label_get_layout (GTK_LABEL (widget)));
702 attributes = _gtk_style_context_get_attributes (attributes,
703 gtk_widget_get_style_context (widget),
704 gtk_widget_get_state_flags (widget));
710 gtk_label_accessible_get_character_at_offset (AtkText *atk_text,
717 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
721 text = gtk_label_get_text (GTK_LABEL (widget));
722 if (offset >= g_utf8_strlen (text, -1))
725 index = g_utf8_offset_to_pointer (text, offset);
727 return g_utf8_get_char (index);
731 atk_text_interface_init (AtkTextIface *iface)
733 iface->get_text = gtk_label_accessible_get_text;
734 iface->get_character_at_offset = gtk_label_accessible_get_character_at_offset;
735 iface->get_text_before_offset = gtk_label_accessible_get_text_before_offset;
736 iface->get_text_at_offset = gtk_label_accessible_get_text_at_offset;
737 iface->get_text_after_offset = gtk_label_accessible_get_text_after_offset;
738 iface->get_character_count = gtk_label_accessible_get_character_count;
739 iface->get_caret_offset = gtk_label_accessible_get_caret_offset;
740 iface->set_caret_offset = gtk_label_accessible_set_caret_offset;
741 iface->get_n_selections = gtk_label_accessible_get_n_selections;
742 iface->get_selection = gtk_label_accessible_get_selection;
743 iface->add_selection = gtk_label_accessible_add_selection;
744 iface->remove_selection = gtk_label_accessible_remove_selection;
745 iface->set_selection = gtk_label_accessible_set_selection;
746 iface->get_character_extents = gtk_label_accessible_get_character_extents;
747 iface->get_offset_at_point = gtk_label_accessible_get_offset_at_point;
748 iface->get_run_attributes = gtk_label_accessible_get_run_attributes;
749 iface->get_default_attributes = gtk_label_accessible_get_default_attributes;