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.
25 #include <gtk/gtkpango.h>
26 #include "gtklabelaccessible.h"
29 static void atk_text_interface_init (AtkTextIface *iface);
31 G_DEFINE_TYPE_WITH_CODE (GtkLabelAccessible, gtk_label_accessible, GTK_TYPE_WIDGET_ACCESSIBLE,
32 G_IMPLEMENT_INTERFACE (ATK_TYPE_TEXT, atk_text_interface_init))
35 gtk_label_accessible_init (GtkLabelAccessible *label)
40 gtk_label_accessible_initialize (AtkObject *obj,
44 GtkLabelAccessible *accessible;
46 ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->initialize (obj, data);
48 accessible = GTK_LABEL_ACCESSIBLE (obj);
50 widget = GTK_WIDGET (data);
52 accessible->text = g_strdup (gtk_label_get_text (GTK_LABEL (widget)));
55 * Check whether ancestor of GtkLabel is a GtkButton and if so
56 * set accessible parent for GtkLabelAccessible
58 while (widget != NULL)
60 widget = gtk_widget_get_parent (widget);
61 if (GTK_IS_BUTTON (widget))
63 atk_object_set_parent (obj, gtk_widget_get_accessible (widget));
68 if (GTK_IS_ACCEL_LABEL (widget))
69 obj->role = ATK_ROLE_ACCEL_LABEL;
71 obj->role = ATK_ROLE_LABEL;
75 gtk_label_accessible_notify_gtk (GObject *obj,
78 GtkWidget *widget = GTK_WIDGET (obj);
79 AtkObject* atk_obj = gtk_widget_get_accessible (widget);
80 GtkLabelAccessible *accessible;
83 accessible = GTK_LABEL_ACCESSIBLE (atk_obj);
85 if (strcmp (pspec->name, "label") == 0)
89 text = gtk_label_get_text (GTK_LABEL (widget));
90 if (strcmp (accessible->text, text) == 0)
93 /* Create a delete text and an insert text signal */
94 length = g_utf8_strlen (accessible->text, -1);
96 g_signal_emit_by_name (atk_obj, "text_changed::delete", 0, length);
98 g_free (accessible->text);
99 accessible->text = g_strdup (text);
101 length = g_utf8_strlen (accessible->text, -1);
103 g_signal_emit_by_name (atk_obj, "text_changed::insert", 0, length);
105 if (atk_obj->name == NULL)
106 /* The label has changed so notify a change in accessible-name */
107 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
109 g_signal_emit_by_name (atk_obj, "visible_data_changed");
111 else if (strcmp (pspec->name, "cursor-position") == 0)
113 g_signal_emit_by_name (atk_obj, "text_caret_moved",
114 _gtk_label_get_cursor_position (GTK_LABEL (widget)));
115 g_signal_emit_by_name (atk_obj, "text_selection_changed");
117 else if (strcmp (pspec->name, "selection-bound") == 0)
119 g_signal_emit_by_name (atk_obj, "text_selection_changed");
122 GTK_WIDGET_ACCESSIBLE_CLASS (gtk_label_accessible_parent_class)->notify_gtk (obj, pspec);
126 gtk_label_accessible_finalize (GObject *object)
128 GtkLabelAccessible *accessible = GTK_LABEL_ACCESSIBLE (object);
130 g_free (accessible->text);
132 G_OBJECT_CLASS (gtk_label_accessible_parent_class)->finalize (object);
139 gtk_label_accessible_ref_state_set (AtkObject *accessible)
141 AtkStateSet *state_set;
144 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
148 state_set = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->ref_state_set (accessible);
149 atk_state_set_add_state (state_set, ATK_STATE_MULTI_LINE);
155 gtk_label_accessible_ref_relation_set (AtkObject *obj)
158 AtkRelationSet *relation_set;
160 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (obj), NULL);
162 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
166 relation_set = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->ref_relation_set (obj);
168 if (!atk_relation_set_contains (relation_set, ATK_RELATION_LABEL_FOR))
170 /* Get the mnemonic widget.
171 * The relation set is not updated if the mnemonic widget is changed
173 GtkWidget *mnemonic_widget;
175 mnemonic_widget = gtk_label_get_mnemonic_widget (GTK_LABEL (widget));
179 AtkObject *accessible_array[1];
180 AtkRelation* relation;
182 if (!gtk_widget_get_can_focus (mnemonic_widget))
185 * Handle the case where a GtkFileChooserButton is specified
186 * as the mnemonic widget. use the combobox which is a child of the
187 * GtkFileChooserButton as the mnemonic widget. See bug #359843.
189 if (GTK_IS_BOX (mnemonic_widget))
193 list = gtk_container_get_children (GTK_CONTAINER (mnemonic_widget));
194 if (g_list_length (list) == 2)
196 tmpl = g_list_last (list);
197 if (GTK_IS_COMBO_BOX(tmpl->data))
199 mnemonic_widget = GTK_WIDGET(tmpl->data);
205 accessible_array[0] = gtk_widget_get_accessible (mnemonic_widget);
206 relation = atk_relation_new (accessible_array, 1,
207 ATK_RELATION_LABEL_FOR);
208 atk_relation_set_add (relation_set, relation);
210 * Unref the relation so that it is not leaked.
212 g_object_unref (relation);
219 gtk_label_accessible_get_name (AtkObject *accessible)
223 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (accessible), NULL);
225 name = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->get_name (accessible);
231 * Get the text on the label
235 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
239 g_return_val_if_fail (GTK_IS_LABEL (widget), NULL);
241 return gtk_label_get_text (GTK_LABEL (widget));
246 gtk_label_accessible_class_init (GtkLabelAccessibleClass *klass)
248 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
249 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
250 GtkWidgetAccessibleClass *widget_class = (GtkWidgetAccessibleClass*)klass;
252 gobject_class->finalize = gtk_label_accessible_finalize;
254 widget_class->notify_gtk = gtk_label_accessible_notify_gtk;
256 class->get_name = gtk_label_accessible_get_name;
257 class->ref_state_set = gtk_label_accessible_ref_state_set;
258 class->ref_relation_set = gtk_label_accessible_ref_relation_set;
259 class->initialize = gtk_label_accessible_initialize;
265 gtk_label_accessible_get_text (AtkText *atk_text,
272 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
276 text = gtk_label_get_text (GTK_LABEL (widget));
279 return g_utf8_substring (text, start_pos, end_pos > -1 ? end_pos : g_utf8_strlen (text, -1));
285 gtk_label_accessible_get_text_before_offset (AtkText *text,
287 AtkTextBoundary boundary_type,
293 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
297 return _gtk_pango_get_text_before (gtk_label_get_layout (GTK_LABEL (widget)),
298 boundary_type, offset,
299 start_offset, end_offset);
303 gtk_label_accessible_get_text_at_offset (AtkText *text,
305 AtkTextBoundary boundary_type,
311 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
315 return _gtk_pango_get_text_at (gtk_label_get_layout (GTK_LABEL (widget)),
316 boundary_type, offset,
317 start_offset, end_offset);
321 gtk_label_accessible_get_text_after_offset (AtkText *text,
323 AtkTextBoundary boundary_type,
329 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
333 return _gtk_pango_get_text_after (gtk_label_get_layout (GTK_LABEL (widget)),
334 boundary_type, offset,
335 start_offset, end_offset);
339 gtk_label_accessible_get_character_count (AtkText *atk_text)
344 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
348 text = gtk_label_get_text (GTK_LABEL (widget));
351 return g_utf8_strlen (text, -1);
357 gtk_label_accessible_get_caret_offset (AtkText *text)
361 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
365 return _gtk_label_get_cursor_position (GTK_LABEL (widget));
369 gtk_label_accessible_set_caret_offset (AtkText *text,
375 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
379 label = GTK_LABEL (widget);
381 if (!gtk_label_get_selectable (label))
384 gtk_label_select_region (label, offset, offset);
390 gtk_label_accessible_get_n_selections (AtkText *text)
394 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
398 if (gtk_label_get_selection_bounds (GTK_LABEL (widget), NULL, NULL))
405 gtk_label_accessible_get_selection (AtkText *text,
413 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
417 if (selection_num != 0)
420 label = GTK_LABEL (widget);
422 if (gtk_label_get_selection_bounds (label, start_pos, end_pos))
426 text = gtk_label_get_text (label);
429 return g_utf8_substring (text, *start_pos, *end_pos);
436 gtk_label_accessible_add_selection (AtkText *text,
444 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
448 label = GTK_LABEL (widget);
450 if (!gtk_label_get_selectable (label))
453 if (!gtk_label_get_selection_bounds (label, &start, &end))
455 gtk_label_select_region (label, start_pos, end_pos);
463 gtk_label_accessible_remove_selection (AtkText *text,
470 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
474 if (selection_num != 0)
477 label = GTK_LABEL (widget);
479 if (!gtk_label_get_selectable (label))
482 if (gtk_label_get_selection_bounds (label, &start, &end))
484 gtk_label_select_region (label, end, end);
492 gtk_label_accessible_set_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, start_pos, end_pos);
523 gtk_label_accessible_get_character_extents (AtkText *text,
533 PangoRectangle char_rect;
534 const gchar *label_text;
535 gint index, x_layout, y_layout;
537 gint x_window, y_window;
539 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
543 label = GTK_LABEL (widget);
545 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
546 label_text = gtk_label_get_text (label);
547 index = g_utf8_offset_to_pointer (label_text, offset) - label_text;
548 pango_layout_index_to_pos (gtk_label_get_layout (label), index, &char_rect);
549 pango_extents_to_pixels (&char_rect, NULL);
551 window = gtk_widget_get_window (widget);
552 gdk_window_get_origin (window, &x_window, &y_window);
554 *x = x_window + x_layout + char_rect.x;
555 *y = x_window + y_layout + char_rect.y;
556 *width = char_rect.width;
557 *height = char_rect.height;
559 if (coords == ATK_XY_WINDOW)
561 window = gdk_window_get_toplevel (window);
562 gdk_window_get_origin (window, &x_window, &y_window);
570 gtk_label_accessible_get_offset_at_point (AtkText *atk_text,
578 gint index, x_layout, y_layout;
579 gint x_window, y_window;
580 gint x_local, y_local;
583 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
587 label = GTK_LABEL (widget);
589 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
591 window = gtk_widget_get_window (widget);
592 gdk_window_get_origin (window, &x_window, &y_window);
594 x_local = x - x_layout - x_window;
595 y_local = y - y_layout - y_window;
597 if (coords == ATK_XY_WINDOW)
599 window = gdk_window_get_toplevel (window);
600 gdk_window_get_origin (window, &x_window, &y_window);
606 if (!pango_layout_xy_to_index (gtk_label_get_layout (label),
607 x_local * PANGO_SCALE,
608 y_local * PANGO_SCALE,
611 if (x_local < 0 || y_local < 0)
619 text = gtk_label_get_text (label);
620 return g_utf8_pointer_to_offset (text, text + index);
626 static AtkAttributeSet *
627 add_attribute (AtkAttributeSet *attributes,
628 AtkTextAttribute attr,
633 at = g_new (AtkAttribute, 1);
634 at->name = g_strdup (atk_text_attribute_get_name (attr));
635 at->value = g_strdup (value);
637 return g_slist_prepend (attributes, at);
640 static AtkAttributeSet*
641 gtk_label_accessible_get_run_attributes (AtkText *text,
647 AtkAttributeSet *attributes;
649 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
654 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
655 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
656 gtk_widget_get_direction (widget)));
657 attributes = _gtk_pango_get_run_attributes (attributes,
658 gtk_label_get_layout (GTK_LABEL (widget)),
666 static AtkAttributeSet *
667 gtk_label_accessible_get_default_attributes (AtkText *text)
670 AtkAttributeSet *attributes;
672 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
677 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
678 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
679 gtk_widget_get_direction (widget)));
680 attributes = _gtk_pango_get_default_attributes (attributes,
681 gtk_label_get_layout (GTK_LABEL (widget)));
682 attributes = _gtk_style_context_get_attributes (attributes,
683 gtk_widget_get_style_context (widget),
684 gtk_widget_get_state_flags (widget));
690 gtk_label_accessible_get_character_at_offset (AtkText *atk_text,
697 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
701 text = gtk_label_get_text (GTK_LABEL (widget));
702 if (offset >= g_utf8_strlen (text, -1))
705 index = g_utf8_offset_to_pointer (text, offset);
707 return g_utf8_get_char (index);
711 atk_text_interface_init (AtkTextIface *iface)
713 iface->get_text = gtk_label_accessible_get_text;
714 iface->get_character_at_offset = gtk_label_accessible_get_character_at_offset;
715 iface->get_text_before_offset = gtk_label_accessible_get_text_before_offset;
716 iface->get_text_at_offset = gtk_label_accessible_get_text_at_offset;
717 iface->get_text_after_offset = gtk_label_accessible_get_text_after_offset;
718 iface->get_character_count = gtk_label_accessible_get_character_count;
719 iface->get_caret_offset = gtk_label_accessible_get_caret_offset;
720 iface->set_caret_offset = gtk_label_accessible_set_caret_offset;
721 iface->get_n_selections = gtk_label_accessible_get_n_selections;
722 iface->get_selection = gtk_label_accessible_get_selection;
723 iface->add_selection = gtk_label_accessible_add_selection;
724 iface->remove_selection = gtk_label_accessible_remove_selection;
725 iface->set_selection = gtk_label_accessible_set_selection;
726 iface->get_character_extents = gtk_label_accessible_get_character_extents;
727 iface->get_offset_at_point = gtk_label_accessible_get_offset_at_point;
728 iface->get_run_attributes = gtk_label_accessible_get_run_attributes;
729 iface->get_default_attributes = gtk_label_accessible_get_default_attributes;