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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
23 #include <gtk/gtkpango.h>
24 #include "gtklabelaccessible.h"
27 static void atk_text_interface_init (AtkTextIface *iface);
29 G_DEFINE_TYPE_WITH_CODE (GtkLabelAccessible, _gtk_label_accessible, GTK_TYPE_WIDGET_ACCESSIBLE,
30 G_IMPLEMENT_INTERFACE (ATK_TYPE_TEXT, atk_text_interface_init))
33 _gtk_label_accessible_init (GtkLabelAccessible *label)
38 gtk_label_accessible_initialize (AtkObject *obj,
42 GtkLabelAccessible *accessible;
44 ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->initialize (obj, data);
46 accessible = GTK_LABEL_ACCESSIBLE (obj);
48 widget = GTK_WIDGET (data);
50 accessible->text = g_strdup (gtk_label_get_text (GTK_LABEL (widget)));
53 * Check whether ancestor of GtkLabel is a GtkButton and if so
54 * set accessible parent for GtkLabelAccessible
56 while (widget != NULL)
58 widget = gtk_widget_get_parent (widget);
59 if (GTK_IS_BUTTON (widget))
61 atk_object_set_parent (obj, gtk_widget_get_accessible (widget));
66 obj->role = ATK_ROLE_LABEL;
70 check_for_selection_change (GtkLabelAccessible *accessible,
73 gboolean ret_val = FALSE;
76 if (gtk_label_get_selection_bounds (label, &start, &end))
78 if (end != accessible->cursor_position ||
79 start != accessible->selection_bound)
84 ret_val = (accessible->cursor_position != accessible->selection_bound);
87 accessible->cursor_position = end;
88 accessible->selection_bound = start;
95 gtk_label_accessible_notify_gtk (GObject *obj,
98 GtkWidget *widget = GTK_WIDGET (obj);
99 AtkObject* atk_obj = gtk_widget_get_accessible (widget);
100 GtkLabelAccessible *accessible;
103 accessible = GTK_LABEL_ACCESSIBLE (atk_obj);
105 if (g_strcmp0 (pspec->name, "label") == 0)
109 text = gtk_label_get_text (GTK_LABEL (widget));
110 if (g_strcmp0 (accessible->text, text) == 0)
113 /* Create a delete text and an insert text signal */
114 length = g_utf8_strlen (accessible->text, -1);
116 g_signal_emit_by_name (atk_obj, "text-changed::delete", 0, length);
118 g_free (accessible->text);
119 accessible->text = g_strdup (text);
121 length = g_utf8_strlen (accessible->text, -1);
123 g_signal_emit_by_name (atk_obj, "text-changed::insert", 0, length);
125 if (atk_obj->name == NULL)
126 /* The label has changed so notify a change in accessible-name */
127 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
129 g_signal_emit_by_name (atk_obj, "visible-data-changed");
131 else if (g_strcmp0 (pspec->name, "cursor-position") == 0)
133 g_signal_emit_by_name (atk_obj, "text-caret-moved",
134 _gtk_label_get_cursor_position (GTK_LABEL (widget)));
135 if (check_for_selection_change (accessible, GTK_LABEL (widget)))
136 g_signal_emit_by_name (atk_obj, "text-selection-changed");
138 else if (g_strcmp0 (pspec->name, "selection-bound") == 0)
140 if (check_for_selection_change (accessible, GTK_LABEL (widget)))
141 g_signal_emit_by_name (atk_obj, "text-selection-changed");
144 GTK_WIDGET_ACCESSIBLE_CLASS (_gtk_label_accessible_parent_class)->notify_gtk (obj, pspec);
148 gtk_label_accessible_finalize (GObject *object)
150 GtkLabelAccessible *accessible = GTK_LABEL_ACCESSIBLE (object);
152 g_free (accessible->text);
154 G_OBJECT_CLASS (_gtk_label_accessible_parent_class)->finalize (object);
161 gtk_label_accessible_ref_state_set (AtkObject *accessible)
163 AtkStateSet *state_set;
166 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
170 state_set = ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->ref_state_set (accessible);
171 atk_state_set_add_state (state_set, ATK_STATE_MULTI_LINE);
176 static AtkRelationSet *
177 gtk_label_accessible_ref_relation_set (AtkObject *obj)
180 AtkRelationSet *relation_set;
182 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (obj), NULL);
184 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
188 relation_set = ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->ref_relation_set (obj);
190 if (!atk_relation_set_contains (relation_set, ATK_RELATION_LABEL_FOR))
192 /* Get the mnemonic widget.
193 * The relation set is not updated if the mnemonic widget is changed
195 GtkWidget *mnemonic_widget;
197 mnemonic_widget = gtk_label_get_mnemonic_widget (GTK_LABEL (widget));
201 AtkObject *accessible_array[1];
202 AtkRelation* relation;
204 if (!gtk_widget_get_can_focus (mnemonic_widget))
207 * Handle the case where a GtkFileChooserButton is specified
208 * as the mnemonic widget. use the combobox which is a child of the
209 * GtkFileChooserButton as the mnemonic widget. See bug #359843.
211 if (GTK_IS_BOX (mnemonic_widget))
215 list = gtk_container_get_children (GTK_CONTAINER (mnemonic_widget));
216 if (g_list_length (list) == 2)
218 tmpl = g_list_last (list);
219 if (GTK_IS_COMBO_BOX(tmpl->data))
221 mnemonic_widget = GTK_WIDGET(tmpl->data);
227 accessible_array[0] = gtk_widget_get_accessible (mnemonic_widget);
228 relation = atk_relation_new (accessible_array, 1,
229 ATK_RELATION_LABEL_FOR);
230 atk_relation_set_add (relation_set, relation);
232 * Unref the relation so that it is not leaked.
234 g_object_unref (relation);
241 gtk_label_accessible_get_name (AtkObject *accessible)
245 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (accessible), NULL);
247 name = ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->get_name (accessible);
253 * Get the text on the label
257 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
261 g_return_val_if_fail (GTK_IS_LABEL (widget), NULL);
263 return gtk_label_get_text (GTK_LABEL (widget));
268 _gtk_label_accessible_class_init (GtkLabelAccessibleClass *klass)
270 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
271 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
272 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
274 gobject_class->finalize = gtk_label_accessible_finalize;
276 widget_class->notify_gtk = gtk_label_accessible_notify_gtk;
278 class->get_name = gtk_label_accessible_get_name;
279 class->ref_state_set = gtk_label_accessible_ref_state_set;
280 class->ref_relation_set = gtk_label_accessible_ref_relation_set;
281 class->initialize = gtk_label_accessible_initialize;
287 gtk_label_accessible_get_text (AtkText *atk_text,
294 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
298 text = gtk_label_get_text (GTK_LABEL (widget));
301 return g_utf8_substring (text, start_pos, end_pos > -1 ? end_pos : g_utf8_strlen (text, -1));
307 gtk_label_accessible_get_text_before_offset (AtkText *text,
309 AtkTextBoundary boundary_type,
315 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
319 return _gtk_pango_get_text_before (gtk_label_get_layout (GTK_LABEL (widget)),
320 boundary_type, offset,
321 start_offset, end_offset);
325 gtk_label_accessible_get_text_at_offset (AtkText *text,
327 AtkTextBoundary boundary_type,
333 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
337 return _gtk_pango_get_text_at (gtk_label_get_layout (GTK_LABEL (widget)),
338 boundary_type, offset,
339 start_offset, end_offset);
343 gtk_label_accessible_get_text_after_offset (AtkText *text,
345 AtkTextBoundary boundary_type,
351 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
355 return _gtk_pango_get_text_after (gtk_label_get_layout (GTK_LABEL (widget)),
356 boundary_type, offset,
357 start_offset, end_offset);
361 gtk_label_accessible_get_character_count (AtkText *atk_text)
366 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
370 text = gtk_label_get_text (GTK_LABEL (widget));
373 return g_utf8_strlen (text, -1);
379 gtk_label_accessible_get_caret_offset (AtkText *text)
383 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
387 return _gtk_label_get_cursor_position (GTK_LABEL (widget));
391 gtk_label_accessible_set_caret_offset (AtkText *text,
397 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
401 label = GTK_LABEL (widget);
403 if (!gtk_label_get_selectable (label))
406 gtk_label_select_region (label, offset, offset);
412 gtk_label_accessible_get_n_selections (AtkText *text)
416 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
420 if (gtk_label_get_selection_bounds (GTK_LABEL (widget), NULL, NULL))
427 gtk_label_accessible_get_selection (AtkText *atk_text,
435 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
439 if (selection_num != 0)
442 label = GTK_LABEL (widget);
444 if (gtk_label_get_selection_bounds (label, start_pos, end_pos))
448 text = gtk_label_get_text (label);
451 return g_utf8_substring (text, *start_pos, *end_pos);
458 gtk_label_accessible_add_selection (AtkText *text,
466 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
470 label = GTK_LABEL (widget);
472 if (!gtk_label_get_selectable (label))
475 if (!gtk_label_get_selection_bounds (label, &start, &end))
477 gtk_label_select_region (label, start_pos, end_pos);
485 gtk_label_accessible_remove_selection (AtkText *text,
492 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
496 if (selection_num != 0)
499 label = GTK_LABEL (widget);
501 if (!gtk_label_get_selectable (label))
504 if (gtk_label_get_selection_bounds (label, &start, &end))
506 gtk_label_select_region (label, end, end);
514 gtk_label_accessible_set_selection (AtkText *text,
523 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
527 if (selection_num != 0)
530 label = GTK_LABEL (widget);
532 if (!gtk_label_get_selectable (label))
535 if (gtk_label_get_selection_bounds (label, &start, &end))
537 gtk_label_select_region (label, start_pos, end_pos);
545 gtk_label_accessible_get_character_extents (AtkText *text,
555 PangoRectangle char_rect;
556 const gchar *label_text;
557 gint index, x_layout, y_layout;
559 gint x_window, y_window;
561 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
565 label = GTK_LABEL (widget);
567 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
568 label_text = gtk_label_get_text (label);
569 index = g_utf8_offset_to_pointer (label_text, offset) - label_text;
570 pango_layout_index_to_pos (gtk_label_get_layout (label), index, &char_rect);
571 pango_extents_to_pixels (&char_rect, NULL);
573 window = gtk_widget_get_window (widget);
574 gdk_window_get_origin (window, &x_window, &y_window);
576 *x = x_window + x_layout + char_rect.x;
577 *y = y_window + y_layout + char_rect.y;
578 *width = char_rect.width;
579 *height = char_rect.height;
581 if (coords == ATK_XY_WINDOW)
583 window = gdk_window_get_toplevel (window);
584 gdk_window_get_origin (window, &x_window, &y_window);
592 gtk_label_accessible_get_offset_at_point (AtkText *atk_text,
600 gint index, x_layout, y_layout;
601 gint x_window, y_window;
602 gint x_local, y_local;
605 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
609 label = GTK_LABEL (widget);
611 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
613 window = gtk_widget_get_window (widget);
614 gdk_window_get_origin (window, &x_window, &y_window);
616 x_local = x - x_layout - x_window;
617 y_local = y - y_layout - y_window;
619 if (coords == ATK_XY_WINDOW)
621 window = gdk_window_get_toplevel (window);
622 gdk_window_get_origin (window, &x_window, &y_window);
628 if (!pango_layout_xy_to_index (gtk_label_get_layout (label),
629 x_local * PANGO_SCALE,
630 y_local * PANGO_SCALE,
633 if (x_local < 0 || y_local < 0)
641 text = gtk_label_get_text (label);
642 return g_utf8_pointer_to_offset (text, text + index);
648 static AtkAttributeSet *
649 add_attribute (AtkAttributeSet *attributes,
650 AtkTextAttribute attr,
655 at = g_new (AtkAttribute, 1);
656 at->name = g_strdup (atk_text_attribute_get_name (attr));
657 at->value = g_strdup (value);
659 return g_slist_prepend (attributes, at);
662 static AtkAttributeSet*
663 gtk_label_accessible_get_run_attributes (AtkText *text,
669 AtkAttributeSet *attributes;
671 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
676 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
677 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
678 gtk_widget_get_direction (widget)));
679 attributes = _gtk_pango_get_run_attributes (attributes,
680 gtk_label_get_layout (GTK_LABEL (widget)),
688 static AtkAttributeSet *
689 gtk_label_accessible_get_default_attributes (AtkText *text)
692 AtkAttributeSet *attributes;
694 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
699 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
700 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
701 gtk_widget_get_direction (widget)));
702 attributes = _gtk_pango_get_default_attributes (attributes,
703 gtk_label_get_layout (GTK_LABEL (widget)));
704 attributes = _gtk_style_context_get_attributes (attributes,
705 gtk_widget_get_style_context (widget),
706 gtk_widget_get_state_flags (widget));
712 gtk_label_accessible_get_character_at_offset (AtkText *atk_text,
719 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
723 text = gtk_label_get_text (GTK_LABEL (widget));
724 if (offset >= g_utf8_strlen (text, -1))
727 index = g_utf8_offset_to_pointer (text, offset);
729 return g_utf8_get_char (index);
733 atk_text_interface_init (AtkTextIface *iface)
735 iface->get_text = gtk_label_accessible_get_text;
736 iface->get_character_at_offset = gtk_label_accessible_get_character_at_offset;
737 iface->get_text_before_offset = gtk_label_accessible_get_text_before_offset;
738 iface->get_text_at_offset = gtk_label_accessible_get_text_at_offset;
739 iface->get_text_after_offset = gtk_label_accessible_get_text_after_offset;
740 iface->get_character_count = gtk_label_accessible_get_character_count;
741 iface->get_caret_offset = gtk_label_accessible_get_caret_offset;
742 iface->set_caret_offset = gtk_label_accessible_set_caret_offset;
743 iface->get_n_selections = gtk_label_accessible_get_n_selections;
744 iface->get_selection = gtk_label_accessible_get_selection;
745 iface->add_selection = gtk_label_accessible_add_selection;
746 iface->remove_selection = gtk_label_accessible_remove_selection;
747 iface->set_selection = gtk_label_accessible_set_selection;
748 iface->get_character_extents = gtk_label_accessible_get_character_extents;
749 iface->get_offset_at_point = gtk_label_accessible_get_offset_at_point;
750 iface->get_run_attributes = gtk_label_accessible_get_run_attributes;
751 iface->get_default_attributes = gtk_label_accessible_get_default_attributes;