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 "gtklabelaccessible.h"
26 #include <libgail-util/gailmisc.h>
28 static void gtk_label_accessible_class_init (GtkLabelAccessibleClass *klass);
29 static void gtk_label_accessible_init (GtkLabelAccessible *label);
30 static void gtk_label_accessible_real_initialize (AtkObject *obj,
32 static void gtk_label_accessible_real_notify_gtk (GObject *obj,
34 static void gtk_label_accessible_init_text_util (GtkLabelAccessible *gail_label,
36 static void gtk_label_accessible_finalize (GObject *object);
38 static void atk_text_interface_init (AtkTextIface *iface);
42 static const gchar* gtk_label_accessible_get_name (AtkObject *accessible);
43 static AtkStateSet* gtk_label_accessible_ref_state_set (AtkObject *accessible);
44 static AtkRelationSet* gtk_label_accessible_ref_relation_set (AtkObject *accessible);
48 static gchar* gtk_label_accessible_get_text (AtkText *text,
51 static gunichar gtk_label_accessible_get_character_at_offset(AtkText *text,
53 static gchar* gtk_label_accessible_get_text_before_offset(AtkText *text,
55 AtkTextBoundary boundary_type,
58 static gchar* gtk_label_accessible_get_text_at_offset (AtkText *text,
60 AtkTextBoundary boundary_type,
63 static gchar* gtk_label_accessible_get_text_after_offset (AtkText *text,
65 AtkTextBoundary boundary_type,
68 static gint gtk_label_accessible_get_character_count (AtkText *text);
69 static gint gtk_label_accessible_get_caret_offset (AtkText *text);
70 static gboolean gtk_label_accessible_set_caret_offset (AtkText *text,
72 static gint gtk_label_accessible_get_n_selections (AtkText *text);
73 static gchar* gtk_label_accessible_get_selection (AtkText *text,
77 static gboolean gtk_label_accessible_add_selection (AtkText *text,
80 static gboolean gtk_label_accessible_remove_selection (AtkText *text,
82 static gboolean gtk_label_accessible_set_selection (AtkText *text,
86 static void gtk_label_accessible_get_character_extents (AtkText *text,
93 static gint gtk_label_accessible_get_offset_at_point (AtkText *text,
97 static AtkAttributeSet* gtk_label_accessible_get_run_attributes
102 static AtkAttributeSet* gtk_label_accessible_get_default_attributes
105 G_DEFINE_TYPE_WITH_CODE (GtkLabelAccessible, gtk_label_accessible, GAIL_TYPE_WIDGET,
106 G_IMPLEMENT_INTERFACE (ATK_TYPE_TEXT, atk_text_interface_init))
109 gtk_label_accessible_class_init (GtkLabelAccessibleClass *klass)
111 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
112 AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
113 GailWidgetClass *widget_class;
115 gobject_class->finalize = gtk_label_accessible_finalize;
117 widget_class = (GailWidgetClass*)klass;
118 widget_class->notify_gtk = gtk_label_accessible_real_notify_gtk;
120 class->get_name = gtk_label_accessible_get_name;
121 class->ref_state_set = gtk_label_accessible_ref_state_set;
122 class->ref_relation_set = gtk_label_accessible_ref_relation_set;
123 class->initialize = gtk_label_accessible_real_initialize;
127 gtk_label_accessible_init (GtkLabelAccessible *label)
132 gtk_label_accessible_real_initialize (AtkObject *obj,
136 GtkLabelAccessible *accessible;
138 ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->initialize (obj, data);
140 accessible = GTK_LABEL_ACCESSIBLE (obj);
142 accessible->cursor_position = 0;
143 accessible->selection_bound = 0;
144 accessible->textutil = NULL;
145 accessible->label_length = 0;
147 widget = GTK_WIDGET (data);
149 gtk_label_accessible_init_text_util (accessible, widget);
152 * Check whether ancestor of GtkLabel is a GtkButton and if so
153 * set accessible parent for GtkLabelAccessible
155 while (widget != NULL)
157 widget = gtk_widget_get_parent (widget);
158 if (GTK_IS_BUTTON (widget))
160 atk_object_set_parent (obj, gtk_widget_get_accessible (widget));
165 if (GTK_IS_ACCEL_LABEL (widget))
166 obj->role = ATK_ROLE_ACCEL_LABEL;
168 obj->role = ATK_ROLE_LABEL;
172 gtk_label_accessible_init_text_util (GtkLabelAccessible *accessible,
176 const gchar *label_text;
178 if (accessible->textutil == NULL)
179 accessible->textutil = gail_text_util_new ();
181 label = GTK_LABEL (widget);
182 label_text = gtk_label_get_text (label);
183 gail_text_util_text_setup (accessible->textutil, label_text);
185 if (label_text == NULL)
186 accessible->label_length = 0;
188 accessible->label_length = g_utf8_strlen (label_text, -1);
192 notify_name_change (AtkObject *atk_obj)
195 GtkLabelAccessible *accessible;
199 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_obj));
206 gail_obj = G_OBJECT (atk_obj);
207 label = GTK_LABEL (widget);
208 accessible = GTK_LABEL_ACCESSIBLE (atk_obj);
210 if (accessible->textutil == NULL)
214 * Check whether the label has actually changed before emitting
217 if (accessible->textutil->buffer)
219 GtkTextIter start, end;
220 const char *new_label;
224 gtk_text_buffer_get_start_iter (accessible->textutil->buffer, &start);
225 gtk_text_buffer_get_end_iter (accessible->textutil->buffer, &end);
226 old_label = gtk_text_buffer_get_text (accessible->textutil->buffer, &start, &end, FALSE);
227 new_label = gtk_label_get_text (label);
228 same = strcmp (new_label, old_label);
234 /* Create a delete text and an insert text signal */
236 g_signal_emit_by_name (gail_obj, "text_changed::delete", 0,
237 accessible->label_length);
239 gtk_label_accessible_init_text_util (accessible, widget);
241 g_signal_emit_by_name (gail_obj, "text_changed::insert", 0,
242 accessible->label_length);
244 if (atk_obj->name == NULL)
246 * The label has changed so notify a change in accessible-name
248 g_object_notify (gail_obj, "accessible-name");
250 g_signal_emit_by_name (gail_obj, "visible_data_changed");
254 gtk_label_accessible_real_notify_gtk (GObject *obj,
257 GtkWidget *widget = GTK_WIDGET (obj);
258 AtkObject* atk_obj = gtk_widget_get_accessible (widget);
260 GtkLabelAccessible *accessible;
263 accessible = GTK_LABEL_ACCESSIBLE (atk_obj);
265 if (strcmp (pspec->name, "label") == 0 ||
266 strcmp (pspec->name, "use-underline") == 0 ||
267 strcmp (pspec->name, "use-markup") == 0)
269 notify_name_change (atk_obj);
271 else if (strcmp (pspec->name, "cursor-position") == 0)
273 gint start, end, tmp;
274 gboolean text_caret_moved = FALSE;
275 gboolean selection_changed = FALSE;
277 gail_obj = G_OBJECT (atk_obj);
278 label = GTK_LABEL (widget);
280 if (accessible->selection_bound != -1 && accessible->selection_bound < accessible->cursor_position)
282 tmp = accessible->selection_bound;
283 accessible->selection_bound = accessible->cursor_position;
284 accessible->cursor_position = tmp;
287 if (gtk_label_get_selection_bounds (label, &start, &end))
289 if (start != accessible->cursor_position ||
290 end != accessible->selection_bound)
292 if (end != accessible->selection_bound)
294 accessible->selection_bound = start;
295 accessible->cursor_position = end;
299 accessible->selection_bound = end;
300 accessible->cursor_position = start;
302 text_caret_moved = TRUE;
304 selection_changed = TRUE;
309 if (accessible->cursor_position != accessible->selection_bound)
310 selection_changed = TRUE;
311 if (gtk_label_get_selectable (label))
313 if (accessible->cursor_position != -1 && start != accessible->cursor_position)
314 text_caret_moved = TRUE;
315 if (accessible->selection_bound != -1 && end != accessible
318 text_caret_moved = TRUE;
319 accessible->cursor_position = end;
320 accessible->selection_bound = start;
324 accessible->cursor_position = start;
325 accessible->selection_bound = end;
330 /* GtkLabel has become non selectable */
332 accessible->cursor_position = 0;
333 accessible->selection_bound = 0;
334 text_caret_moved = TRUE;
338 if (text_caret_moved)
339 g_signal_emit_by_name (gail_obj, "text_caret_moved",
340 accessible->cursor_position);
341 if (selection_changed)
342 g_signal_emit_by_name (gail_obj, "text_selection_changed");
346 GAIL_WIDGET_CLASS (gtk_label_accessible_parent_class)->notify_gtk (obj, pspec);
350 gtk_label_accessible_finalize (GObject *object)
352 GtkLabelAccessible *accessible = GTK_LABEL_ACCESSIBLE (object);
354 if (accessible->textutil)
355 g_object_unref (accessible->textutil);
356 G_OBJECT_CLASS (gtk_label_accessible_parent_class)->finalize (object);
363 gtk_label_accessible_ref_state_set (AtkObject *accessible)
365 AtkStateSet *state_set;
368 state_set = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->ref_state_set (accessible);
369 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
374 atk_state_set_add_state (state_set, ATK_STATE_MULTI_LINE);
380 gtk_label_accessible_ref_relation_set (AtkObject *obj)
383 AtkRelationSet *relation_set;
385 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (obj), NULL);
387 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
394 relation_set = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->ref_relation_set (obj);
396 if (!atk_relation_set_contains (relation_set, ATK_RELATION_LABEL_FOR))
399 * Get the mnemonic widget
401 * The relation set is not updated if the mnemonic widget is changed
403 GtkWidget *mnemonic_widget = gtk_label_get_mnemonic_widget (GTK_LABEL (widget));
407 AtkObject *accessible_array[1];
408 AtkRelation* relation;
410 if (!gtk_widget_get_can_focus (mnemonic_widget))
413 * Handle the case where a GtkFileChooserButton is specified as the
414 * mnemonic widget. use the combobox which is a child of the
415 * GtkFileChooserButton as the mnemonic widget. See bug #359843.
417 if (GTK_IS_BOX (mnemonic_widget))
421 list = gtk_container_get_children (GTK_CONTAINER (mnemonic_widget));
422 if (g_list_length (list) == 2)
424 tmpl = g_list_last (list);
425 if (GTK_IS_COMBO_BOX(tmpl->data))
427 mnemonic_widget = GTK_WIDGET(tmpl->data);
433 accessible_array[0] = gtk_widget_get_accessible (mnemonic_widget);
434 relation = atk_relation_new (accessible_array, 1,
435 ATK_RELATION_LABEL_FOR);
436 atk_relation_set_add (relation_set, relation);
438 * Unref the relation so that it is not leaked.
440 g_object_unref (relation);
447 gtk_label_accessible_get_name (AtkObject *accessible)
451 g_return_val_if_fail (GTK_IS_LABEL_ACCESSIBLE (accessible), NULL);
453 name = ATK_OBJECT_CLASS (gtk_label_accessible_parent_class)->get_name (accessible);
459 * Get the text on the label
463 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
470 g_return_val_if_fail (GTK_IS_LABEL (widget), NULL);
472 return gtk_label_get_text (GTK_LABEL (widget));
479 atk_text_interface_init (AtkTextIface *iface)
481 iface->get_text = gtk_label_accessible_get_text;
482 iface->get_character_at_offset = gtk_label_accessible_get_character_at_offset;
483 iface->get_text_before_offset = gtk_label_accessible_get_text_before_offset;
484 iface->get_text_at_offset = gtk_label_accessible_get_text_at_offset;
485 iface->get_text_after_offset = gtk_label_accessible_get_text_after_offset;
486 iface->get_character_count = gtk_label_accessible_get_character_count;
487 iface->get_caret_offset = gtk_label_accessible_get_caret_offset;
488 iface->set_caret_offset = gtk_label_accessible_set_caret_offset;
489 iface->get_n_selections = gtk_label_accessible_get_n_selections;
490 iface->get_selection = gtk_label_accessible_get_selection;
491 iface->add_selection = gtk_label_accessible_add_selection;
492 iface->remove_selection = gtk_label_accessible_remove_selection;
493 iface->set_selection = gtk_label_accessible_set_selection;
494 iface->get_character_extents = gtk_label_accessible_get_character_extents;
495 iface->get_offset_at_point = gtk_label_accessible_get_offset_at_point;
496 iface->get_run_attributes = gtk_label_accessible_get_run_attributes;
497 iface->get_default_attributes = gtk_label_accessible_get_default_attributes;
501 gtk_label_accessible_get_text (AtkText *text,
508 const gchar *label_text;
510 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
512 /* State is defunct */
515 label = GTK_LABEL (widget);
517 label_text = gtk_label_get_text (label);
519 if (label_text == NULL)
523 if (GTK_LABEL_ACCESSIBLE (text)->textutil == NULL)
524 gtk_label_accessible_init_text_util (GTK_LABEL_ACCESSIBLE (text), widget);
525 return gail_text_util_get_substring (GTK_LABEL_ACCESSIBLE (text)->textutil,
531 gtk_label_accessible_get_text_before_offset (AtkText *text,
533 AtkTextBoundary boundary_type,
540 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
543 /* State is defunct */
547 label = GTK_LABEL (widget);
549 return gail_text_util_get_text (GTK_LABEL_ACCESSIBLE (text)->textutil,
550 gtk_label_get_layout (label), GAIL_BEFORE_OFFSET,
551 boundary_type, offset, start_offset, end_offset);
555 gtk_label_accessible_get_text_at_offset (AtkText *text,
557 AtkTextBoundary boundary_type,
564 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
567 /* State is defunct */
571 label = GTK_LABEL (widget);
573 return gail_text_util_get_text (GTK_LABEL_ACCESSIBLE (text)->textutil,
574 gtk_label_get_layout (label), GAIL_AT_OFFSET,
575 boundary_type, offset, start_offset, end_offset);
579 gtk_label_accessible_get_text_after_offset (AtkText *text,
581 AtkTextBoundary boundary_type,
588 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
592 /* State is defunct */
597 label = GTK_LABEL (widget);
599 return gail_text_util_get_text (GTK_LABEL_ACCESSIBLE (text)->textutil,
600 gtk_label_get_layout (label), GAIL_AFTER_OFFSET,
601 boundary_type, offset, start_offset, end_offset);
605 gtk_label_accessible_get_character_count (AtkText *text)
610 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
612 /* State is defunct */
615 label = GTK_LABEL (widget);
616 return g_utf8_strlen (gtk_label_get_text (label), -1);
620 gtk_label_accessible_get_caret_offset (AtkText *text)
622 return GTK_LABEL_ACCESSIBLE (text)->cursor_position;
626 gtk_label_accessible_set_caret_offset (AtkText *text,
632 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
634 /* State is defunct */
637 label = GTK_LABEL (widget);
639 if (gtk_label_get_selectable (label) &&
641 offset <= g_utf8_strlen (gtk_label_get_text (label), -1))
643 gtk_label_select_region (label, offset, offset);
651 gtk_label_accessible_get_n_selections (AtkText *text)
657 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
659 /* State is defunct */
662 label = GTK_LABEL (widget);
664 if (!gtk_label_get_selectable (label))
667 if (gtk_label_get_selection_bounds (label, &start, &end))
674 gtk_label_accessible_get_selection (AtkText *text,
682 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
684 /* State is defunct */
687 label = GTK_LABEL (widget);
689 /* Only let the user get the selection if one is set, and if the
690 * selection_num is 0.
692 if (!gtk_label_get_selectable( label) || selection_num != 0)
695 if (gtk_label_get_selection_bounds (label, start_pos, end_pos))
697 const gchar* label_text = gtk_label_get_text (label);
699 if (label_text == NULL)
702 return gail_text_util_get_substring (GTK_LABEL_ACCESSIBLE (text)->textutil,
703 *start_pos, *end_pos);
710 gtk_label_accessible_add_selection (AtkText *text,
718 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
720 /* State is defunct */
723 label = GTK_LABEL (widget);
725 if (!gtk_label_get_selectable (label))
728 if (! gtk_label_get_selection_bounds (label, &start, &end))
730 gtk_label_select_region (label, start_pos, end_pos);
738 gtk_label_accessible_remove_selection (AtkText *text,
745 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
747 /* State is defunct */
750 if (selection_num != 0)
753 label = GTK_LABEL (widget);
755 if (!gtk_label_get_selectable (label))
758 if (gtk_label_get_selection_bounds (label, &start, &end))
760 gtk_label_select_region (label, 0, 0);
768 gtk_label_accessible_set_selection (AtkText *text,
777 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
779 /* State is defunct */
782 if (selection_num != 0)
785 label = GTK_LABEL (widget);
787 if (!gtk_label_get_selectable (label))
790 if (gtk_label_get_selection_bounds (label, &start, &end))
792 gtk_label_select_region (label, start_pos, end_pos);
800 gtk_label_accessible_get_character_extents (AtkText *text,
810 PangoRectangle char_rect;
811 const gchar *label_text;
812 gint index, x_layout, y_layout;
814 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
817 /* State is defunct */
820 label = GTK_LABEL (widget);
822 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
823 label_text = gtk_label_get_text (label);
824 index = g_utf8_offset_to_pointer (label_text, offset) - label_text;
825 pango_layout_index_to_pos (gtk_label_get_layout (label), index, &char_rect);
827 gail_misc_get_extents_from_pango_rectangle (widget, &char_rect,
828 x_layout, y_layout, x, y, width, height, coords);
832 gtk_label_accessible_get_offset_at_point (AtkText *text,
839 const gchar *label_text;
840 gint index, x_layout, y_layout;
842 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
844 /* State is defunct */
846 label = GTK_LABEL (widget);
848 gtk_label_get_layout_offsets (label, &x_layout, &y_layout);
850 index = gail_misc_get_index_at_point_in_layout (widget,
851 gtk_label_get_layout (label),
852 x_layout, y_layout, x, y, coords);
853 label_text = gtk_label_get_text (label);
856 if (coords == ATK_XY_WINDOW || coords == ATK_XY_SCREEN)
857 return g_utf8_strlen (label_text, -1);
862 return g_utf8_pointer_to_offset (label_text, label_text + index);
865 static AtkAttributeSet*
866 gtk_label_accessible_get_run_attributes (AtkText *text,
873 AtkAttributeSet *at_set = NULL;
874 GtkJustification justify;
875 GtkTextDirection dir;
877 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
879 /* State is defunct */
882 label = GTK_LABEL (widget);
884 /* Get values set for entire label, if any */
885 justify = gtk_label_get_justify (label);
886 if (justify != GTK_JUSTIFY_CENTER)
888 at_set = gail_misc_add_attribute (at_set,
889 ATK_TEXT_ATTR_JUSTIFICATION,
890 g_strdup (atk_text_attribute_get_value (ATK_TEXT_ATTR_JUSTIFICATION, justify)));
892 dir = gtk_widget_get_direction (widget);
893 if (dir == GTK_TEXT_DIR_RTL)
895 at_set = gail_misc_add_attribute (at_set,
896 ATK_TEXT_ATTR_DIRECTION,
897 g_strdup (atk_text_attribute_get_value (ATK_TEXT_ATTR_DIRECTION, dir)));
900 at_set = gail_misc_layout_get_run_attributes (at_set,
901 gtk_label_get_layout (label),
902 gtk_label_get_text (label),
909 static AtkAttributeSet*
910 gtk_label_accessible_get_default_attributes (AtkText *text)
914 AtkAttributeSet *at_set = NULL;
916 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
918 /* State is defunct */
921 label = GTK_LABEL (widget);
923 at_set = gail_misc_get_default_attributes (at_set,
924 gtk_label_get_layout (label),
930 gtk_label_accessible_get_character_at_offset (AtkText *text,
938 widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (text));
940 /* State is defunct */
943 label = GTK_LABEL (widget);
944 string = gtk_label_get_text (label);
945 if (offset >= g_utf8_strlen (string, -1))
947 index = g_utf8_offset_to_pointer (string, offset);
949 return g_utf8_get_char (index);