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"
27 #include <libgail-util/gailmisc.h>
30 static void atk_text_interface_init (AtkTextIface *iface);
32 G_DEFINE_TYPE_WITH_CODE (GtkLabelAccessible, gtk_label_accessible, GAIL_TYPE_WIDGET,
33 G_IMPLEMENT_INTERFACE (ATK_TYPE_TEXT, atk_text_interface_init))
36 gtk_label_accessible_init (GtkLabelAccessible *label)
41 gtk_label_accessible_initialize (AtkObject *obj,
45 GtkLabelAccessible *accessible;
47 ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->initialize (obj, data);
49 accessible = GTK_LABEL_ACCESSIBLE (obj);
51 widget = GTK_WIDGET (data);
53 accessible->text = g_strdup (gtk_label_get_text (GTK_LABEL (widget)));
56 * Check whether ancestor of GtkLabel is a GtkButton and if so
57 * set accessible parent for GtkLabelAccessible
59 while (widget != NULL)
61 widget = gtk_widget_get_parent (widget);
62 if (GTK_IS_BUTTON (widget))
64 atk_object_set_parent (obj, gtk_widget_get_accessible (widget));
69 if (GTK_IS_ACCEL_LABEL (widget))
70 obj->role = ATK_ROLE_ACCEL_LABEL;
72 obj->role = ATK_ROLE_LABEL;
76 gtk_label_accessible_notify_gtk (GObject *obj,
79 GtkWidget *widget = GTK_WIDGET (obj);
80 AtkObject* atk_obj = gtk_widget_get_accessible (widget);
81 GtkLabelAccessible *accessible;
84 accessible = GTK_LABEL_ACCESSIBLE (atk_obj);
86 if (strcmp (pspec->name, "label") == 0)
90 text = gtk_label_get_text (GTK_LABEL (widget));
91 if (strcmp (accessible->text, text) == 0)
94 /* Create a delete text and an insert text signal */
95 length = g_utf8_strlen (accessible->text, -1);
97 g_signal_emit_by_name (atk_obj, "text_changed::delete", 0, length);
99 g_free (accessible->text);
100 accessible->text = g_strdup (text);
102 length = g_utf8_strlen (accessible->text, -1);
104 g_signal_emit_by_name (atk_obj, "text_changed::insert", 0, length);
106 if (atk_obj->name == NULL)
107 /* The label has changed so notify a change in accessible-name */
108 g_object_notify (G_OBJECT (atk_obj), "accessible-name");
110 g_signal_emit_by_name (atk_obj, "visible_data_changed");
112 else if (strcmp (pspec->name, "cursor-position") == 0)
114 g_signal_emit_by_name (atk_obj, "text_caret_moved",
115 _gtk_label_get_cursor_position (GTK_LABEL (widget)));
116 g_signal_emit_by_name (atk_obj, "text_selection_changed");
119 GAIL_WIDGET_CLASS (gtk_label_accessible_parent_class)->notify_gtk (obj, pspec);
123 gtk_label_accessible_finalize (GObject *object)
125 GtkLabelAccessible *accessible = GTK_LABEL_ACCESSIBLE (object);
127 g_free (accessible->text);
129 G_OBJECT_CLASS (gtk_label_accessible_parent_class)->finalize (object);
136 gtk_label_accessible_ref_state_set (AtkObject *accessible)
138 AtkStateSet *state_set;
141 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
145 state_set = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->ref_state_set (accessible);
146 atk_state_set_add_state (state_set, ATK_STATE_MULTI_LINE);
152 gtk_label_accessible_ref_relation_set (AtkObject *obj)
155 AtkRelationSet *relation_set;
157 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (obj), NULL);
159 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
163 relation_set = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->ref_relation_set (obj);
165 if (!atk_relation_set_contains (relation_set, ATK_RELATION_LABEL_FOR))
167 /* Get the mnemonic widget.
168 * The relation set is not updated if the mnemonic widget is changed
170 GtkWidget *mnemonic_widget;
172 mnemonic_widget = gtk_label_get_mnemonic_widget (GTK_LABEL (widget));
176 AtkObject *accessible_array[1];
177 AtkRelation* relation;
179 if (!gtk_widget_get_can_focus (mnemonic_widget))
182 * Handle the case where a GtkFileChooserButton is specified
183 * as the mnemonic widget. use the combobox which is a child of the
184 * GtkFileChooserButton as the mnemonic widget. See bug #359843.
186 if (GTK_IS_BOX (mnemonic_widget))
190 list = gtk_container_get_children (GTK_CONTAINER (mnemonic_widget));
191 if (g_list_length (list) == 2)
193 tmpl = g_list_last (list);
194 if (GTK_IS_COMBO_BOX(tmpl->data))
196 mnemonic_widget = GTK_WIDGET(tmpl->data);
202 accessible_array[0] = gtk_widget_get_accessible (mnemonic_widget);
203 relation = atk_relation_new (accessible_array, 1,
204 ATK_RELATION_LABEL_FOR);
205 atk_relation_set_add (relation_set, relation);
207 * Unref the relation so that it is not leaked.
209 g_object_unref (relation);
216 gtk_label_accessible_get_name (AtkObject *accessible)
220 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (accessible), NULL);
222 name = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->get_name (accessible);
228 * Get the text on the label
232 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
236 g_return_val_if_fail (GTK_IS_LABEL (widget), NULL);
238 return gtk_label_get_text (GTK_LABEL (widget));
243 gtk_label_accessible_class_init (GtkLabelAccessibleClass *klass)
245 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
246 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
247 GailWidgetClass *widget_class = (GailWidgetClass*)klass;
249 gobject_class->finalize = gtk_label_accessible_finalize;
251 widget_class->notify_gtk = gtk_label_accessible_notify_gtk;
253 class->get_name = gtk_label_accessible_get_name;
254 class->ref_state_set = gtk_label_accessible_ref_state_set;
255 class->ref_relation_set = gtk_label_accessible_ref_relation_set;
256 class->initialize = gtk_label_accessible_initialize;
262 gtk_label_accessible_get_text (AtkText *atk_text,
269 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
273 text = gtk_label_get_text (GTK_LABEL (widget));
276 return g_utf8_substring (text, start_pos, end_pos > -1 ? end_pos : g_utf8_strlen (text, -1));
282 gtk_label_accessible_get_text_before_offset (AtkText *text,
284 AtkTextBoundary boundary_type,
290 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
294 return _gtk_pango_get_text_before (gtk_label_get_layout (GTK_LABEL (widget)),
295 boundary_type, offset,
296 start_offset, end_offset);
300 gtk_label_accessible_get_text_at_offset (AtkText *text,
302 AtkTextBoundary boundary_type,
308 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
312 return _gtk_pango_get_text_at (gtk_label_get_layout (GTK_LABEL (widget)),
313 boundary_type, offset,
314 start_offset, end_offset);
318 gtk_label_accessible_get_text_after_offset (AtkText *text,
320 AtkTextBoundary boundary_type,
326 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
330 return _gtk_pango_get_text_after (gtk_label_get_layout (GTK_LABEL (widget)),
331 boundary_type, offset,
332 start_offset, end_offset);
336 gtk_label_accessible_get_character_count (AtkText *atk_text)
341 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
345 text = gtk_label_get_text (GTK_LABEL (widget));
348 return g_utf8_strlen (text, -1);
354 gtk_label_accessible_get_caret_offset (AtkText *text)
358 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
362 return _gtk_label_get_cursor_position (GTK_LABEL (widget));
366 gtk_label_accessible_set_caret_offset (AtkText *text,
372 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
376 label = GTK_LABEL (widget);
378 if (!gtk_label_get_selectable (label))
381 gtk_label_select_region (label, offset, offset);
387 gtk_label_accessible_get_n_selections (AtkText *text)
392 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
396 if (gtk_label_get_selection_bounds (GTK_LABEL (widget), &start, &end))
403 gtk_label_accessible_get_selection (AtkText *text,
411 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
415 label = GTK_LABEL (widget);
417 if (selection_num != 0)
420 if (gtk_label_get_selection_bounds (label, start_pos, end_pos))
424 text = gtk_label_get_text (label);
427 return g_utf8_substring (text, *start_pos, *end_pos);
434 gtk_label_accessible_add_selection (AtkText *text,
442 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
446 label = GTK_LABEL (widget);
448 if (!gtk_label_get_selectable (label))
451 if (!gtk_label_get_selection_bounds (label, &start, &end))
453 gtk_label_select_region (label, start_pos, end_pos);
461 gtk_label_accessible_remove_selection (AtkText *text,
468 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
472 if (selection_num != 0)
475 label = GTK_LABEL (widget);
477 if (!gtk_label_get_selectable (label))
480 if (gtk_label_get_selection_bounds (label, &start, &end))
482 gtk_label_select_region (label, 0, 0);
490 gtk_label_accessible_set_selection (AtkText *text,
499 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
503 if (selection_num != 0)
506 label = GTK_LABEL (widget);
508 if (!gtk_label_get_selectable (label))
511 if (gtk_label_get_selection_bounds (label, &start, &end))
513 gtk_label_select_region (label, start_pos, end_pos);
521 gtk_label_accessible_get_character_extents (AtkText *text,
531 PangoRectangle char_rect;
532 const gchar *label_text;
533 gint index, x_layout, y_layout;
535 gint x_window, y_window;
537 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
541 label = GTK_LABEL (widget);
543 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
544 label_text = gtk_label_get_text (label);
545 index = g_utf8_offset_to_pointer (label_text, offset) - label_text;
546 pango_layout_index_to_pos (gtk_label_get_layout (label), index, &char_rect);
547 pango_extents_to_pixels (&char_rect, NULL);
549 window = gtk_widget_get_window (widget);
550 gdk_window_get_origin (window, &x_window, &y_window);
552 *x = x_window + x_layout + char_rect.x;
553 *y = x_window + y_layout + char_rect.y;
554 *width = char_rect.width;
555 *height = char_rect.height;
557 if (coords == ATK_XY_WINDOW)
559 window = gdk_window_get_toplevel (window);
560 gdk_window_get_origin (window, &x_window, &y_window);
568 gtk_label_accessible_get_offset_at_point (AtkText *atk_text,
576 gint index, x_layout, y_layout;
577 gint x_window, y_window;
578 gint x_local, y_local;
581 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
585 label = GTK_LABEL (widget);
587 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
589 window = gtk_widget_get_window (widget);
590 gdk_window_get_origin (window, &x_window, &y_window);
592 x_local = x - x_layout - x_window;
593 y_local = y - y_layout - y_window;
595 if (coords == ATK_XY_WINDOW)
597 window = gdk_window_get_toplevel (window);
598 gdk_window_get_origin (window, &x_window, &y_window);
604 if (!pango_layout_xy_to_index (gtk_label_get_layout (label),
605 x_local * PANGO_SCALE,
606 y_local * PANGO_SCALE,
609 if (x_local < 0 || y_local < 0)
617 text = gtk_label_get_text (label);
618 return g_utf8_pointer_to_offset (text, text + index);
624 static AtkAttributeSet *
625 add_attribute (AtkAttributeSet *attributes,
626 AtkTextAttribute attr,
631 at = g_new (AtkAttribute, 1);
632 at->name = g_strdup (atk_text_attribute_get_name (attr));
633 at->value = g_strdup (value);
635 return g_slist_prepend (attributes, at);
638 static AtkAttributeSet*
639 gtk_label_accessible_get_run_attributes (AtkText *text,
645 AtkAttributeSet *attributes;
647 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
652 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
653 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
654 gtk_widget_get_direction (widget)));
655 attributes = _gtk_pango_get_run_attributes (attributes,
656 gtk_label_get_layout (GTK_LABEL (widget)),
664 static AtkAttributeSet *
665 gtk_label_accessible_get_default_attributes (AtkText *text)
668 AtkAttributeSet *attributes;
670 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
675 attributes = add_attribute (attributes, ATK_TEXT_ATTR_DIRECTION,
676 atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION,
677 gtk_widget_get_direction (widget)));
678 attributes = _gtk_pango_get_default_attributes (attributes,
679 gtk_label_get_layout (GTK_LABEL (widget)));
680 attributes = _gtk_style_context_get_attributes (attributes,
681 gtk_widget_get_style_context (widget),
682 gtk_widget_get_state_flags (widget));
688 gtk_label_accessible_get_character_at_offset (AtkText *atk_text,
695 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_text));
699 text = gtk_label_get_text (GTK_LABEL (widget));
700 if (offset >= g_utf8_strlen (text, -1))
703 index = g_utf8_offset_to_pointer (text, offset);
705 return g_utf8_get_char (index);
709 atk_text_interface_init (AtkTextIface *iface)
711 iface->get_text = gtk_label_accessible_get_text;
712 iface->get_character_at_offset = gtk_label_accessible_get_character_at_offset;
713 iface->get_text_before_offset = gtk_label_accessible_get_text_before_offset;
714 iface->get_text_at_offset = gtk_label_accessible_get_text_at_offset;
715 iface->get_text_after_offset = gtk_label_accessible_get_text_after_offset;
716 iface->get_character_count = gtk_label_accessible_get_character_count;
717 iface->get_caret_offset = gtk_label_accessible_get_caret_offset;
718 iface->set_caret_offset = gtk_label_accessible_set_caret_offset;
719 iface->get_n_selections = gtk_label_accessible_get_n_selections;
720 iface->get_selection = gtk_label_accessible_get_selection;
721 iface->add_selection = gtk_label_accessible_add_selection;
722 iface->remove_selection = gtk_label_accessible_remove_selection;
723 iface->set_selection = gtk_label_accessible_set_selection;
724 iface->get_character_extents = gtk_label_accessible_get_character_extents;
725 iface->get_offset_at_point = gtk_label_accessible_get_offset_at_point;
726 iface->get_run_attributes = gtk_label_accessible_get_run_attributes;
727 iface->get_default_attributes = gtk_label_accessible_get_default_attributes;