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 if (GTK_IS_ACCEL_LABEL (widget))
67 obj->role = ATK_ROLE_ACCEL_LABEL;
69 obj->role = ATK_ROLE_LABEL;
73 check_for_selection_change (GtkLabelAccessible *accessible,
76 gboolean ret_val = FALSE;
79 if (gtk_label_get_selection_bounds (label, &start, &end))
81 if (end != accessible->cursor_position ||
82 start != accessible->selection_bound)
87 ret_val = (accessible->cursor_position != accessible->selection_bound);
90 accessible->cursor_position = end;
91 accessible->selection_bound = start;
98 gtk_label_accessible_notify_gtk (GObject *obj,
101 GtkWidget *widget = GTK_WIDGET (obj);
102 AtkObject* atk_obj = gtk_widget_get_accessible (widget);
103 GtkLabelAccessible *accessible;
106 accessible = GTK_LABEL_ACCESSIBLE (atk_obj);
108 if (g_strcmp0 (pspec->name, "label") == 0)
112 text = gtk_label_get_text (GTK_LABEL (widget));
113 if (g_strcmp0 (accessible->text, text) == 0)
116 /* Create a delete text and an insert text signal */
117 length = g_utf8_strlen (accessible->text, -1);
119 g_signal_emit_by_name (atk_obj, "text-changed::delete", 0, length);
121 g_free (accessible->text);
122 accessible->text = g_strdup (text);
124 length = g_utf8_strlen (accessible->text, -1);
126 g_signal_emit_by_name (atk_obj, "text-changed::insert", 0, length);
128 if (atk_obj->name == NULL)
129 /* The label has changed so notify a change in accessible-name */
130 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
132 g_signal_emit_by_name (atk_obj, "visible-data-changed");
134 else if (g_strcmp0 (pspec->name, "cursor-position") == 0)
136 g_signal_emit_by_name (atk_obj, "text-caret-moved",
137 _gtk_label_get_cursor_position (GTK_LABEL (widget)));
138 if (check_for_selection_change (accessible, GTK_LABEL (widget)))
139 g_signal_emit_by_name (atk_obj, "text-selection-changed");
141 else if (g_strcmp0 (pspec->name, "selection-bound") == 0)
143 if (check_for_selection_change (accessible, GTK_LABEL (widget)))
144 g_signal_emit_by_name (atk_obj, "text-selection-changed");
147 GTK_WIDGET_ACCESSIBLE_CLASS (_gtk_label_accessible_parent_class)->notify_gtk (obj, pspec);
151 gtk_label_accessible_finalize (GObject *object)
153 GtkLabelAccessible *accessible = GTK_LABEL_ACCESSIBLE (object);
155 g_free (accessible->text);
157 G_OBJECT_CLASS (_gtk_label_accessible_parent_class)->finalize (object);
164 gtk_label_accessible_ref_state_set (AtkObject *accessible)
166 AtkStateSet *state_set;
169 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
173 state_set = ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->ref_state_set (accessible);
174 atk_state_set_add_state (state_set, ATK_STATE_MULTI_LINE);
179 static AtkRelationSet *
180 gtk_label_accessible_ref_relation_set (AtkObject *obj)
183 AtkRelationSet *relation_set;
185 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (obj), NULL);
187 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
191 relation_set = ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->ref_relation_set (obj);
193 if (!atk_relation_set_contains (relation_set, ATK_RELATION_LABEL_FOR))
195 /* Get the mnemonic widget.
196 * The relation set is not updated if the mnemonic widget is changed
198 GtkWidget *mnemonic_widget;
200 mnemonic_widget = gtk_label_get_mnemonic_widget (GTK_LABEL (widget));
204 AtkObject *accessible_array[1];
205 AtkRelation* relation;
207 if (!gtk_widget_get_can_focus (mnemonic_widget))
210 * Handle the case where a GtkFileChooserButton is specified
211 * as the mnemonic widget. use the combobox which is a child of the
212 * GtkFileChooserButton as the mnemonic widget. See bug #359843.
214 if (GTK_IS_BOX (mnemonic_widget))
218 list = gtk_container_get_children (GTK_CONTAINER (mnemonic_widget));
219 if (g_list_length (list) == 2)
221 tmpl = g_list_last (list);
222 if (GTK_IS_COMBO_BOX(tmpl->data))
224 mnemonic_widget = GTK_WIDGET(tmpl->data);
230 accessible_array[0] = gtk_widget_get_accessible (mnemonic_widget);
231 relation = atk_relation_new (accessible_array, 1,
232 ATK_RELATION_LABEL_FOR);
233 atk_relation_set_add (relation_set, relation);
235 * Unref the relation so that it is not leaked.
237 g_object_unref (relation);
244 gtk_label_accessible_get_name (AtkObject *accessible)
248 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (accessible), NULL);
250 name = ATK_OBJECT_CLASS (_gtk_label_accessible_parent_class)->get_name (accessible);
256 * Get the text on the label
260 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
264 g_return_val_if_fail (GTK_IS_LABEL (widget), NULL);
266 return gtk_label_get_text (GTK_LABEL (widget));
271 _gtk_label_accessible_class_init (GtkLabelAccessibleClass *klass)
273 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
274 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
275 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
277 gobject_class->finalize = gtk_label_accessible_finalize;
279 widget_class->notify_gtk = gtk_label_accessible_notify_gtk;
281 class->get_name = gtk_label_accessible_get_name;
282 class->ref_state_set = gtk_label_accessible_ref_state_set;
283 class->ref_relation_set = gtk_label_accessible_ref_relation_set;
284 class->initialize = gtk_label_accessible_initialize;
290 gtk_label_accessible_get_text (AtkText *atk_text,
297 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
301 text = gtk_label_get_text (GTK_LABEL (widget));
304 return g_utf8_substring (text, start_pos, end_pos > -1 ? end_pos : g_utf8_strlen (text, -1));
310 gtk_label_accessible_get_text_before_offset (AtkText *text,
312 AtkTextBoundary boundary_type,
318 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
322 return _gtk_pango_get_text_before (gtk_label_get_layout (GTK_LABEL (widget)),
323 boundary_type, offset,
324 start_offset, end_offset);
328 gtk_label_accessible_get_text_at_offset (AtkText *text,
330 AtkTextBoundary boundary_type,
336 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
340 return _gtk_pango_get_text_at (gtk_label_get_layout (GTK_LABEL (widget)),
341 boundary_type, offset,
342 start_offset, end_offset);
346 gtk_label_accessible_get_text_after_offset (AtkText *text,
348 AtkTextBoundary boundary_type,
354 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
358 return _gtk_pango_get_text_after (gtk_label_get_layout (GTK_LABEL (widget)),
359 boundary_type, offset,
360 start_offset, end_offset);
364 gtk_label_accessible_get_character_count (AtkText *atk_text)
369 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
373 text = gtk_label_get_text (GTK_LABEL (widget));
376 return g_utf8_strlen (text, -1);
382 gtk_label_accessible_get_caret_offset (AtkText *text)
386 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
390 return _gtk_label_get_cursor_position (GTK_LABEL (widget));
394 gtk_label_accessible_set_caret_offset (AtkText *text,
400 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
404 label = GTK_LABEL (widget);
406 if (!gtk_label_get_selectable (label))
409 gtk_label_select_region (label, offset, offset);
415 gtk_label_accessible_get_n_selections (AtkText *text)
419 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
423 if (gtk_label_get_selection_bounds (GTK_LABEL (widget), NULL, NULL))
430 gtk_label_accessible_get_selection (AtkText *atk_text,
438 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
442 if (selection_num != 0)
445 label = GTK_LABEL (widget);
447 if (gtk_label_get_selection_bounds (label, start_pos, end_pos))
451 text = gtk_label_get_text (label);
454 return g_utf8_substring (text, *start_pos, *end_pos);
461 gtk_label_accessible_add_selection (AtkText *text,
469 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
473 label = GTK_LABEL (widget);
475 if (!gtk_label_get_selectable (label))
478 if (!gtk_label_get_selection_bounds (label, &start, &end))
480 gtk_label_select_region (label, start_pos, end_pos);
488 gtk_label_accessible_remove_selection (AtkText *text,
495 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
499 if (selection_num != 0)
502 label = GTK_LABEL (widget);
504 if (!gtk_label_get_selectable (label))
507 if (gtk_label_get_selection_bounds (label, &start, &end))
509 gtk_label_select_region (label, end, end);
517 gtk_label_accessible_set_selection (AtkText *text,
526 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
530 if (selection_num != 0)
533 label = GTK_LABEL (widget);
535 if (!gtk_label_get_selectable (label))
538 if (gtk_label_get_selection_bounds (label, &start, &end))
540 gtk_label_select_region (label, start_pos, end_pos);
548 gtk_label_accessible_get_character_extents (AtkText *text,
558 PangoRectangle char_rect;
559 const gchar *label_text;
560 gint index, x_layout, y_layout;
562 gint x_window, y_window;
564 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
568 label = GTK_LABEL (widget);
570 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
571 label_text = gtk_label_get_text (label);
572 index = g_utf8_offset_to_pointer (label_text, offset) - label_text;
573 pango_layout_index_to_pos (gtk_label_get_layout (label), index, &char_rect);
574 pango_extents_to_pixels (&char_rect, NULL);
576 window = gtk_widget_get_window (widget);
577 gdk_window_get_origin (window, &x_window, &y_window);
579 *x = x_window + x_layout + char_rect.x;
580 *y = x_window + y_layout + char_rect.y;
581 *width = char_rect.width;
582 *height = char_rect.height;
584 if (coords == ATK_XY_WINDOW)
586 window = gdk_window_get_toplevel (window);
587 gdk_window_get_origin (window, &x_window, &y_window);
595 gtk_label_accessible_get_offset_at_point (AtkText *atk_text,
603 gint index, x_layout, y_layout;
604 gint x_window, y_window;
605 gint x_local, y_local;
608 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
612 label = GTK_LABEL (widget);
614 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
616 window = gtk_widget_get_window (widget);
617 gdk_window_get_origin (window, &x_window, &y_window);
619 x_local = x - x_layout - x_window;
620 y_local = y - y_layout - y_window;
622 if (coords == ATK_XY_WINDOW)
624 window = gdk_window_get_toplevel (window);
625 gdk_window_get_origin (window, &x_window, &y_window);
631 if (!pango_layout_xy_to_index (gtk_label_get_layout (label),
632 x_local * PANGO_SCALE,
633 y_local * PANGO_SCALE,
636 if (x_local < 0 || y_local < 0)
644 text = gtk_label_get_text (label);
645 return g_utf8_pointer_to_offset (text, text + index);
651 static AtkAttributeSet *
652 add_attribute (AtkAttributeSet *attributes,
653 AtkTextAttribute attr,
658 at = g_new (AtkAttribute, 1);
659 at->name = g_strdup (atk_text_attribute_get_name (attr));
660 at->value = g_strdup (value);
662 return g_slist_prepend (attributes, at);
665 static AtkAttributeSet*
666 gtk_label_accessible_get_run_attributes (AtkText *text,
672 AtkAttributeSet *attributes;
674 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
679 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
680 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
681 gtk_widget_get_direction (widget)));
682 attributes = _gtk_pango_get_run_attributes (attributes,
683 gtk_label_get_layout (GTK_LABEL (widget)),
691 static AtkAttributeSet *
692 gtk_label_accessible_get_default_attributes (AtkText *text)
695 AtkAttributeSet *attributes;
697 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
702 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
703 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
704 gtk_widget_get_direction (widget)));
705 attributes = _gtk_pango_get_default_attributes (attributes,
706 gtk_label_get_layout (GTK_LABEL (widget)));
707 attributes = _gtk_style_context_get_attributes (attributes,
708 gtk_widget_get_style_context (widget),
709 gtk_widget_get_state_flags (widget));
715 gtk_label_accessible_get_character_at_offset (AtkText *atk_text,
722 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
726 text = gtk_label_get_text (GTK_LABEL (widget));
727 if (offset >= g_utf8_strlen (text, -1))
730 index = g_utf8_offset_to_pointer (text, offset);
732 return g_utf8_get_char (index);
736 atk_text_interface_init (AtkTextIface *iface)
738 iface->get_text = gtk_label_accessible_get_text;
739 iface->get_character_at_offset = gtk_label_accessible_get_character_at_offset;
740 iface->get_text_before_offset = gtk_label_accessible_get_text_before_offset;
741 iface->get_text_at_offset = gtk_label_accessible_get_text_at_offset;
742 iface->get_text_after_offset = gtk_label_accessible_get_text_after_offset;
743 iface->get_character_count = gtk_label_accessible_get_character_count;
744 iface->get_caret_offset = gtk_label_accessible_get_caret_offset;
745 iface->set_caret_offset = gtk_label_accessible_set_caret_offset;
746 iface->get_n_selections = gtk_label_accessible_get_n_selections;
747 iface->get_selection = gtk_label_accessible_get_selection;
748 iface->add_selection = gtk_label_accessible_add_selection;
749 iface->remove_selection = gtk_label_accessible_remove_selection;
750 iface->set_selection = gtk_label_accessible_set_selection;
751 iface->get_character_extents = gtk_label_accessible_get_character_extents;
752 iface->get_offset_at_point = gtk_label_accessible_get_offset_at_point;
753 iface->get_run_attributes = gtk_label_accessible_get_run_attributes;
754 iface->get_default_attributes = gtk_label_accessible_get_default_attributes;