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/>.
21 #include <gtk/gtkpango.h>
22 #include "gtklabelaccessible.h"
24 struct _GtkLabelAccessiblePrivate
31 static void atk_text_interface_init (AtkTextIface *iface);
33 G_DEFINE_TYPE_WITH_CODE (GtkLabelAccessible, gtk_label_accessible, GTK_TYPE_WIDGET_ACCESSIBLE,
34 G_IMPLEMENT_INTERFACE (ATK_TYPE_TEXT, atk_text_interface_init))
37 gtk_label_accessible_init (GtkLabelAccessible *label)
39 label->priv = G_TYPE_INSTANCE_GET_PRIVATE (label,
40 GTK_TYPE_LABEL_ACCESSIBLE,
41 GtkLabelAccessiblePrivate);
45 gtk_label_accessible_initialize (AtkObject *obj,
49 GtkLabelAccessible *accessible;
51 ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->initialize (obj, data);
53 accessible = GTK_LABEL_ACCESSIBLE (obj);
55 widget = GTK_WIDGET (data);
57 accessible->priv->text = g_strdup (gtk_label_get_text (GTK_LABEL (widget)));
60 * Check whether ancestor of GtkLabel is a GtkButton and if so
61 * set accessible parent for GtkLabelAccessible
63 while (widget != NULL)
65 widget = gtk_widget_get_parent (widget);
66 if (GTK_IS_BUTTON (widget))
68 atk_object_set_parent (obj, gtk_widget_get_accessible (widget));
73 obj->role = ATK_ROLE_LABEL;
77 check_for_selection_change (GtkLabelAccessible *accessible,
80 gboolean ret_val = FALSE;
83 if (gtk_label_get_selection_bounds (label, &start, &end))
85 if (end != accessible->priv->cursor_position ||
86 start != accessible->priv->selection_bound)
91 ret_val = (accessible->priv->cursor_position != accessible->priv->selection_bound);
94 accessible->priv->cursor_position = end;
95 accessible->priv->selection_bound = start;
102 gtk_label_accessible_notify_gtk (GObject *obj,
105 GtkWidget *widget = GTK_WIDGET (obj);
106 AtkObject* atk_obj = gtk_widget_get_accessible (widget);
107 GtkLabelAccessible *accessible;
110 accessible = GTK_LABEL_ACCESSIBLE (atk_obj);
112 if (g_strcmp0 (pspec->name, "label") == 0)
116 text = gtk_label_get_text (GTK_LABEL (widget));
117 if (g_strcmp0 (accessible->priv->text, text) == 0)
120 /* Create a delete text and an insert text signal */
121 length = g_utf8_strlen (accessible->priv->text, -1);
123 g_signal_emit_by_name (atk_obj, "text-changed::delete", 0, length);
125 g_free (accessible->priv->text);
126 accessible->priv->text = g_strdup (text);
128 length = g_utf8_strlen (accessible->priv->text, -1);
130 g_signal_emit_by_name (atk_obj, "text-changed::insert", 0, length);
132 if (atk_obj->name == NULL)
133 /* The label has changed so notify a change in accessible-name */
134 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
136 g_signal_emit_by_name (atk_obj, "visible-data-changed");
138 else if (g_strcmp0 (pspec->name, "cursor-position") == 0)
140 g_signal_emit_by_name (atk_obj, "text-caret-moved",
141 _gtk_label_get_cursor_position (GTK_LABEL (widget)));
142 if (check_for_selection_change (accessible, GTK_LABEL (widget)))
143 g_signal_emit_by_name (atk_obj, "text-selection-changed");
145 else if (g_strcmp0 (pspec->name, "selection-bound") == 0)
147 if (check_for_selection_change (accessible, GTK_LABEL (widget)))
148 g_signal_emit_by_name (atk_obj, "text-selection-changed");
151 GTK_WIDGET_ACCESSIBLE_CLASS (gtk_label_accessible_parent_class)->notify_gtk (obj, pspec);
155 gtk_label_accessible_finalize (GObject *object)
157 GtkLabelAccessible *accessible = GTK_LABEL_ACCESSIBLE (object);
159 g_free (accessible->priv->text);
161 G_OBJECT_CLASS (gtk_label_accessible_parent_class)->finalize (object);
168 gtk_label_accessible_ref_state_set (AtkObject *accessible)
170 AtkStateSet *state_set;
173 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
177 state_set = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->ref_state_set (accessible);
178 atk_state_set_add_state (state_set, ATK_STATE_MULTI_LINE);
183 static AtkRelationSet *
184 gtk_label_accessible_ref_relation_set (AtkObject *obj)
187 AtkRelationSet *relation_set;
189 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (obj), NULL);
191 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
195 relation_set = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->ref_relation_set (obj);
197 if (!atk_relation_set_contains (relation_set, ATK_RELATION_LABEL_FOR))
199 /* Get the mnemonic widget.
200 * The relation set is not updated if the mnemonic widget is changed
202 GtkWidget *mnemonic_widget;
204 mnemonic_widget = gtk_label_get_mnemonic_widget (GTK_LABEL (widget));
208 AtkObject *accessible_array[1];
209 AtkRelation* relation;
211 if (!gtk_widget_get_can_focus (mnemonic_widget))
214 * Handle the case where a GtkFileChooserButton is specified
215 * as the mnemonic widget. use the combobox which is a child of the
216 * GtkFileChooserButton as the mnemonic widget. See bug #359843.
218 if (GTK_IS_BOX (mnemonic_widget))
222 list = gtk_container_get_children (GTK_CONTAINER (mnemonic_widget));
223 if (g_list_length (list) == 2)
225 tmpl = g_list_last (list);
226 if (GTK_IS_COMBO_BOX(tmpl->data))
228 mnemonic_widget = GTK_WIDGET(tmpl->data);
234 accessible_array[0] = gtk_widget_get_accessible (mnemonic_widget);
235 relation = atk_relation_new (accessible_array, 1,
236 ATK_RELATION_LABEL_FOR);
237 atk_relation_set_add (relation_set, relation);
239 * Unref the relation so that it is not leaked.
241 g_object_unref (relation);
248 gtk_label_accessible_get_name (AtkObject *accessible)
252 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (accessible), NULL);
254 name = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->get_name (accessible);
260 * Get the text on the label
264 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
268 g_return_val_if_fail (GTK_IS_LABEL (widget), NULL);
270 return gtk_label_get_text (GTK_LABEL (widget));
275 gtk_label_accessible_class_init (GtkLabelAccessibleClass *klass)
277 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
278 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
279 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
281 gobject_class->finalize = gtk_label_accessible_finalize;
283 widget_class->notify_gtk = gtk_label_accessible_notify_gtk;
285 class->get_name = gtk_label_accessible_get_name;
286 class->ref_state_set = gtk_label_accessible_ref_state_set;
287 class->ref_relation_set = gtk_label_accessible_ref_relation_set;
288 class->initialize = gtk_label_accessible_initialize;
290 g_type_class_add_private (klass, sizeof (GtkLabelAccessiblePrivate));
296 gtk_label_accessible_get_text (AtkText *atk_text,
303 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
307 text = gtk_label_get_text (GTK_LABEL (widget));
312 const gchar *start, *end;
314 length = g_utf8_strlen (text, -1);
315 if (end_pos < 0 || end_pos > length)
317 if (start_pos > length)
319 if (end_pos <= start_pos)
320 return g_strdup ("");
321 start = g_utf8_offset_to_pointer (text, start_pos);
322 end = g_utf8_offset_to_pointer (start, end_pos - start_pos);
323 return g_strndup (start, end - start);
330 gtk_label_accessible_get_text_before_offset (AtkText *text,
332 AtkTextBoundary boundary_type,
338 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
342 return _gtk_pango_get_text_before (gtk_label_get_layout (GTK_LABEL (widget)),
343 boundary_type, offset,
344 start_offset, end_offset);
348 gtk_label_accessible_get_text_at_offset (AtkText *text,
350 AtkTextBoundary boundary_type,
356 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
360 return _gtk_pango_get_text_at (gtk_label_get_layout (GTK_LABEL (widget)),
361 boundary_type, offset,
362 start_offset, end_offset);
366 gtk_label_accessible_get_text_after_offset (AtkText *text,
368 AtkTextBoundary boundary_type,
374 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
378 return _gtk_pango_get_text_after (gtk_label_get_layout (GTK_LABEL (widget)),
379 boundary_type, offset,
380 start_offset, end_offset);
384 gtk_label_accessible_get_character_count (AtkText *atk_text)
389 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
393 text = gtk_label_get_text (GTK_LABEL (widget));
396 return g_utf8_strlen (text, -1);
402 gtk_label_accessible_get_caret_offset (AtkText *text)
406 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
410 return _gtk_label_get_cursor_position (GTK_LABEL (widget));
414 gtk_label_accessible_set_caret_offset (AtkText *text,
420 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
424 label = GTK_LABEL (widget);
426 if (!gtk_label_get_selectable (label))
429 gtk_label_select_region (label, offset, offset);
435 gtk_label_accessible_get_n_selections (AtkText *text)
439 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
443 if (gtk_label_get_selection_bounds (GTK_LABEL (widget), NULL, NULL))
450 gtk_label_accessible_get_selection (AtkText *atk_text,
458 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
462 if (selection_num != 0)
465 label = GTK_LABEL (widget);
467 if (gtk_label_get_selection_bounds (label, start_pos, end_pos))
471 text = gtk_label_get_text (label);
474 return g_utf8_substring (text, *start_pos, *end_pos);
481 gtk_label_accessible_add_selection (AtkText *text,
489 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
493 label = GTK_LABEL (widget);
495 if (!gtk_label_get_selectable (label))
498 if (!gtk_label_get_selection_bounds (label, &start, &end))
500 gtk_label_select_region (label, start_pos, end_pos);
508 gtk_label_accessible_remove_selection (AtkText *text,
515 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
519 if (selection_num != 0)
522 label = GTK_LABEL (widget);
524 if (!gtk_label_get_selectable (label))
527 if (gtk_label_get_selection_bounds (label, &start, &end))
529 gtk_label_select_region (label, end, end);
537 gtk_label_accessible_set_selection (AtkText *text,
546 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
550 if (selection_num != 0)
553 label = GTK_LABEL (widget);
555 if (!gtk_label_get_selectable (label))
558 if (gtk_label_get_selection_bounds (label, &start, &end))
560 gtk_label_select_region (label, start_pos, end_pos);
568 gtk_label_accessible_get_character_extents (AtkText *text,
578 PangoRectangle char_rect;
579 const gchar *label_text;
580 gint index, x_layout, y_layout;
582 gint x_window, y_window;
584 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
588 label = GTK_LABEL (widget);
590 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
591 label_text = gtk_label_get_text (label);
592 index = g_utf8_offset_to_pointer (label_text, offset) - label_text;
593 pango_layout_index_to_pos (gtk_label_get_layout (label), index, &char_rect);
594 pango_extents_to_pixels (&char_rect, NULL);
596 window = gtk_widget_get_window (widget);
597 gdk_window_get_origin (window, &x_window, &y_window);
599 *x = x_window + x_layout + char_rect.x;
600 *y = y_window + y_layout + char_rect.y;
601 *width = char_rect.width;
602 *height = char_rect.height;
604 if (coords == ATK_XY_WINDOW)
606 window = gdk_window_get_toplevel (window);
607 gdk_window_get_origin (window, &x_window, &y_window);
615 gtk_label_accessible_get_offset_at_point (AtkText *atk_text,
623 gint index, x_layout, y_layout;
624 gint x_window, y_window;
625 gint x_local, y_local;
628 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
632 label = GTK_LABEL (widget);
634 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
636 window = gtk_widget_get_window (widget);
637 gdk_window_get_origin (window, &x_window, &y_window);
639 x_local = x - x_layout - x_window;
640 y_local = y - y_layout - y_window;
642 if (coords == ATK_XY_WINDOW)
644 window = gdk_window_get_toplevel (window);
645 gdk_window_get_origin (window, &x_window, &y_window);
651 if (!pango_layout_xy_to_index (gtk_label_get_layout (label),
652 x_local * PANGO_SCALE,
653 y_local * PANGO_SCALE,
656 if (x_local < 0 || y_local < 0)
664 text = gtk_label_get_text (label);
665 return g_utf8_pointer_to_offset (text, text + index);
671 static AtkAttributeSet *
672 add_attribute (AtkAttributeSet *attributes,
673 AtkTextAttribute attr,
678 at = g_new (AtkAttribute, 1);
679 at->name = g_strdup (atk_text_attribute_get_name (attr));
680 at->value = g_strdup (value);
682 return g_slist_prepend (attributes, at);
685 static AtkAttributeSet*
686 gtk_label_accessible_get_run_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_run_attributes (attributes,
703 gtk_label_get_layout (GTK_LABEL (widget)),
711 static AtkAttributeSet *
712 gtk_label_accessible_get_default_attributes (AtkText *text)
715 AtkAttributeSet *attributes;
717 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
722 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
723 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
724 gtk_widget_get_direction (widget)));
725 attributes = _gtk_pango_get_default_attributes (attributes,
726 gtk_label_get_layout (GTK_LABEL (widget)));
727 attributes = _gtk_style_context_get_attributes (attributes,
728 gtk_widget_get_style_context (widget),
729 gtk_widget_get_state_flags (widget));
735 gtk_label_accessible_get_character_at_offset (AtkText *atk_text,
742 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
746 text = gtk_label_get_text (GTK_LABEL (widget));
747 if (offset >= g_utf8_strlen (text, -1))
750 index = g_utf8_offset_to_pointer (text, offset);
752 return g_utf8_get_char (index);
756 atk_text_interface_init (AtkTextIface *iface)
758 iface->get_text = gtk_label_accessible_get_text;
759 iface->get_character_at_offset = gtk_label_accessible_get_character_at_offset;
760 iface->get_text_before_offset = gtk_label_accessible_get_text_before_offset;
761 iface->get_text_at_offset = gtk_label_accessible_get_text_at_offset;
762 iface->get_text_after_offset = gtk_label_accessible_get_text_after_offset;
763 iface->get_character_count = gtk_label_accessible_get_character_count;
764 iface->get_caret_offset = gtk_label_accessible_get_caret_offset;
765 iface->set_caret_offset = gtk_label_accessible_set_caret_offset;
766 iface->get_n_selections = gtk_label_accessible_get_n_selections;
767 iface->get_selection = gtk_label_accessible_get_selection;
768 iface->add_selection = gtk_label_accessible_add_selection;
769 iface->remove_selection = gtk_label_accessible_remove_selection;
770 iface->set_selection = gtk_label_accessible_set_selection;
771 iface->get_character_extents = gtk_label_accessible_get_character_extents;
772 iface->get_offset_at_point = gtk_label_accessible_get_offset_at_point;
773 iface->get_run_attributes = gtk_label_accessible_get_run_attributes;
774 iface->get_default_attributes = gtk_label_accessible_get_default_attributes;