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));
310 return g_utf8_substring (text, start_pos, end_pos > -1 ? end_pos : g_utf8_strlen (text, -1));
316 gtk_label_accessible_get_text_before_offset (AtkText *text,
318 AtkTextBoundary boundary_type,
324 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
328 return _gtk_pango_get_text_before (gtk_label_get_layout (GTK_LABEL (widget)),
329 boundary_type, offset,
330 start_offset, end_offset);
334 gtk_label_accessible_get_text_at_offset (AtkText *text,
336 AtkTextBoundary boundary_type,
342 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
346 return _gtk_pango_get_text_at (gtk_label_get_layout (GTK_LABEL (widget)),
347 boundary_type, offset,
348 start_offset, end_offset);
352 gtk_label_accessible_get_text_after_offset (AtkText *text,
354 AtkTextBoundary boundary_type,
360 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
364 return _gtk_pango_get_text_after (gtk_label_get_layout (GTK_LABEL (widget)),
365 boundary_type, offset,
366 start_offset, end_offset);
370 gtk_label_accessible_get_character_count (AtkText *atk_text)
375 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
379 text = gtk_label_get_text (GTK_LABEL (widget));
382 return g_utf8_strlen (text, -1);
388 gtk_label_accessible_get_caret_offset (AtkText *text)
392 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
396 return _gtk_label_get_cursor_position (GTK_LABEL (widget));
400 gtk_label_accessible_set_caret_offset (AtkText *text,
406 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
410 label = GTK_LABEL (widget);
412 if (!gtk_label_get_selectable (label))
415 gtk_label_select_region (label, offset, offset);
421 gtk_label_accessible_get_n_selections (AtkText *text)
425 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
429 if (gtk_label_get_selection_bounds (GTK_LABEL (widget), NULL, NULL))
436 gtk_label_accessible_get_selection (AtkText *atk_text,
444 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
448 if (selection_num != 0)
451 label = GTK_LABEL (widget);
453 if (gtk_label_get_selection_bounds (label, start_pos, end_pos))
457 text = gtk_label_get_text (label);
460 return g_utf8_substring (text, *start_pos, *end_pos);
467 gtk_label_accessible_add_selection (AtkText *text,
475 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
479 label = GTK_LABEL (widget);
481 if (!gtk_label_get_selectable (label))
484 if (!gtk_label_get_selection_bounds (label, &start, &end))
486 gtk_label_select_region (label, start_pos, end_pos);
494 gtk_label_accessible_remove_selection (AtkText *text,
501 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
505 if (selection_num != 0)
508 label = GTK_LABEL (widget);
510 if (!gtk_label_get_selectable (label))
513 if (gtk_label_get_selection_bounds (label, &start, &end))
515 gtk_label_select_region (label, end, end);
523 gtk_label_accessible_set_selection (AtkText *text,
532 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
536 if (selection_num != 0)
539 label = GTK_LABEL (widget);
541 if (!gtk_label_get_selectable (label))
544 if (gtk_label_get_selection_bounds (label, &start, &end))
546 gtk_label_select_region (label, start_pos, end_pos);
554 gtk_label_accessible_get_character_extents (AtkText *text,
564 PangoRectangle char_rect;
565 const gchar *label_text;
566 gint index, x_layout, y_layout;
568 gint x_window, y_window;
570 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
574 label = GTK_LABEL (widget);
576 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
577 label_text = gtk_label_get_text (label);
578 index = g_utf8_offset_to_pointer (label_text, offset) - label_text;
579 pango_layout_index_to_pos (gtk_label_get_layout (label), index, &char_rect);
580 pango_extents_to_pixels (&char_rect, NULL);
582 window = gtk_widget_get_window (widget);
583 gdk_window_get_origin (window, &x_window, &y_window);
585 *x = x_window + x_layout + char_rect.x;
586 *y = y_window + y_layout + char_rect.y;
587 *width = char_rect.width;
588 *height = char_rect.height;
590 if (coords == ATK_XY_WINDOW)
592 window = gdk_window_get_toplevel (window);
593 gdk_window_get_origin (window, &x_window, &y_window);
601 gtk_label_accessible_get_offset_at_point (AtkText *atk_text,
609 gint index, x_layout, y_layout;
610 gint x_window, y_window;
611 gint x_local, y_local;
614 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
618 label = GTK_LABEL (widget);
620 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
622 window = gtk_widget_get_window (widget);
623 gdk_window_get_origin (window, &x_window, &y_window);
625 x_local = x - x_layout - x_window;
626 y_local = y - y_layout - y_window;
628 if (coords == ATK_XY_WINDOW)
630 window = gdk_window_get_toplevel (window);
631 gdk_window_get_origin (window, &x_window, &y_window);
637 if (!pango_layout_xy_to_index (gtk_label_get_layout (label),
638 x_local * PANGO_SCALE,
639 y_local * PANGO_SCALE,
642 if (x_local < 0 || y_local < 0)
650 text = gtk_label_get_text (label);
651 return g_utf8_pointer_to_offset (text, text + index);
657 static AtkAttributeSet *
658 add_attribute (AtkAttributeSet *attributes,
659 AtkTextAttribute attr,
664 at = g_new (AtkAttribute, 1);
665 at->name = g_strdup (atk_text_attribute_get_name (attr));
666 at->value = g_strdup (value);
668 return g_slist_prepend (attributes, at);
671 static AtkAttributeSet*
672 gtk_label_accessible_get_run_attributes (AtkText *text,
678 AtkAttributeSet *attributes;
680 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
685 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
686 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
687 gtk_widget_get_direction (widget)));
688 attributes = _gtk_pango_get_run_attributes (attributes,
689 gtk_label_get_layout (GTK_LABEL (widget)),
697 static AtkAttributeSet *
698 gtk_label_accessible_get_default_attributes (AtkText *text)
701 AtkAttributeSet *attributes;
703 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
708 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
709 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
710 gtk_widget_get_direction (widget)));
711 attributes = _gtk_pango_get_default_attributes (attributes,
712 gtk_label_get_layout (GTK_LABEL (widget)));
713 attributes = _gtk_style_context_get_attributes (attributes,
714 gtk_widget_get_style_context (widget),
715 gtk_widget_get_state_flags (widget));
721 gtk_label_accessible_get_character_at_offset (AtkText *atk_text,
728 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
732 text = gtk_label_get_text (GTK_LABEL (widget));
733 if (offset >= g_utf8_strlen (text, -1))
736 index = g_utf8_offset_to_pointer (text, offset);
738 return g_utf8_get_char (index);
742 atk_text_interface_init (AtkTextIface *iface)
744 iface->get_text = gtk_label_accessible_get_text;
745 iface->get_character_at_offset = gtk_label_accessible_get_character_at_offset;
746 iface->get_text_before_offset = gtk_label_accessible_get_text_before_offset;
747 iface->get_text_at_offset = gtk_label_accessible_get_text_at_offset;
748 iface->get_text_after_offset = gtk_label_accessible_get_text_after_offset;
749 iface->get_character_count = gtk_label_accessible_get_character_count;
750 iface->get_caret_offset = gtk_label_accessible_get_caret_offset;
751 iface->set_caret_offset = gtk_label_accessible_set_caret_offset;
752 iface->get_n_selections = gtk_label_accessible_get_n_selections;
753 iface->get_selection = gtk_label_accessible_get_selection;
754 iface->add_selection = gtk_label_accessible_add_selection;
755 iface->remove_selection = gtk_label_accessible_remove_selection;
756 iface->set_selection = gtk_label_accessible_set_selection;
757 iface->get_character_extents = gtk_label_accessible_get_character_extents;
758 iface->get_offset_at_point = gtk_label_accessible_get_offset_at_point;
759 iface->get_run_attributes = gtk_label_accessible_get_run_attributes;
760 iface->get_default_attributes = gtk_label_accessible_get_default_attributes;