1 /* ATK - The Accessibility Toolkit for GTK+
2 * Copyright 2001 Sun Microsystems Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library 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 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library 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.
23 #include "atkmarshal.h"
29 * @Short_description: The ATK interface implemented by components
33 * #AtkText should be implemented by #AtkObjects on behalf of widgets
34 * that have text content which is either attributed or otherwise
35 * non-trivial. #AtkObjects whose text content is simple,
36 * unattributed, and very brief may expose that content via
37 * #atk_object_get_name instead; however if the text is editable,
38 * multi-line, typically longer than three or four words, attributed,
39 * selectable, or if the object already uses the 'name' ATK property
40 * for other information, the #AtkText interface should be used to
41 * expose the text content. In the case of editable text content,
42 * #AtkEditableText (a subtype of the #AtkText interface) should be
43 * implemented instead.
45 * #AtkText provides not only traversal facilities and change
46 * notification for text content, but also caret tracking and glyph
47 * bounding box calculations. Note that the text strings are exposed
48 * as UTF-8, and are therefore potentially multi-byte, and
49 * caret-to-byte offset mapping makes no assumptions about the
50 * character length; also bounding box glyph-to-offset mapping may be
51 * complex for languages which use ligatures.
54 static GPtrArray
*extra_attributes
= NULL
;
59 TEXT_SELECTION_CHANGED
,
60 TEXT_ATTRIBUTES_CHANGED
,
66 static const char boolean
[] =
69 static const guint8 boolean_offsets
[] = {
73 static const char style
[] =
77 static const guint8 style_offsets
[] = {
81 static const char variant
[] =
84 static const guint8 variant_offsets
[] = {
88 static const char stretch
[] =
98 static const guint8 stretch_offsets
[] = {
99 0, 16, 32, 42, 57, 64, 78, 87, 102
102 static const char justification
[] =
107 static const guint8 justification_offsets
[] = {
111 static const char direction
[] =
115 static const guint8 direction_offsets
[] = {
119 static const char wrap_mode
[] =
124 static const guint8 wrap_mode_offsets
[] = {
128 static const char underline
[] =
134 static const guint8 underline_offsets
[] = {
138 static void atk_text_base_init (AtkTextIface
*class);
140 static void atk_text_real_get_range_extents (AtkText
*text
,
143 AtkCoordType coord_type
,
144 AtkTextRectangle
*rect
);
146 static AtkTextRange
** atk_text_real_get_bounded_ranges (AtkText
*text
,
147 AtkTextRectangle
*rect
,
148 AtkCoordType coord_type
,
149 AtkTextClipType x_clip_type
,
150 AtkTextClipType y_clip_type
);
152 static guint atk_text_signals
[LAST_SIGNAL
] = { 0 };
155 atk_text_get_type (void)
157 static GType type
= 0;
161 static const GTypeInfo tinfo
=
163 sizeof (AtkTextIface
),
164 (GBaseInitFunc
) atk_text_base_init
,
165 (GBaseFinalizeFunc
) NULL
,
166 (GClassInitFunc
) NULL
/* atk_text_interface_init */ ,
167 (GClassFinalizeFunc
) NULL
,
171 type
= g_type_register_static (G_TYPE_INTERFACE
, "AtkText", &tinfo
, 0);
178 atk_text_base_init (AtkTextIface
*class)
180 static gboolean initialized
= FALSE
;
185 * Note that text_changed signal supports details "insert", "delete",
186 * possibly "replace".
189 class->get_range_extents
= atk_text_real_get_range_extents
;
190 class->get_bounded_ranges
= atk_text_real_get_bounded_ranges
;
193 * AtkText::text-changed:
194 * @atktext: the object which received the signal.
195 * @arg1: The position (character offset) of the insertion or deletion.
196 * @arg2: The length (in characters) of text inserted or deleted.
198 * The "text-changed" signal is emitted when the text of the
199 * object which implements the AtkText interface changes, This
200 * signal will have a detail which is either "insert" or
201 * "delete" which identifies whether the text change was an
202 * insertion or a deletion.
204 * Deprecated: 2.9.4: Use #AtkObject::text-insert or
205 * #AtkObject::text-remove instead.
207 atk_text_signals
[TEXT_CHANGED
] =
208 g_signal_new ("text_changed",
210 G_SIGNAL_RUN_LAST
| G_SIGNAL_DETAILED
,
211 G_STRUCT_OFFSET (AtkTextIface
, text_changed
),
212 (GSignalAccumulator
) NULL
, NULL
,
213 atk_marshal_VOID__INT_INT
,
215 2, G_TYPE_INT
, G_TYPE_INT
);
218 * AtkText::text-insert:
219 * @atktext: the object which received the signal.
220 * @arg1: The position (character offset) of the insertion.
221 * @arg2: The length (in characters) of text inserted.
222 * @arg3: The new text inserted
224 * The "text-insert" signal is emitted when a new text is
225 * inserted. If the signal was not triggered by the user
226 * (e.g. typing or pasting text), the "system" detail should be
229 atk_text_signals
[TEXT_INSERT
] =
230 g_signal_new ("text_insert",
232 G_SIGNAL_RUN_LAST
| G_SIGNAL_DETAILED
,
234 (GSignalAccumulator
) NULL
, NULL
,
235 atk_marshal_VOID__INT_INT_STRING
,
237 3, G_TYPE_INT
, G_TYPE_INT
, G_TYPE_STRING
);
240 * AtkText::text-remove:
241 * @atktext: the object which received the signal.
242 * @arg1: The position (character offset) of the removal.
243 * @arg2: The length (in characters) of text removed.
244 * @arg3: The old text removed
246 * The "text-remove" signal is emitted when a new text is
247 * removed. If the signal was not triggered by the user
248 * (e.g. typing or pasting text), the "system" detail should be
251 atk_text_signals
[TEXT_REMOVE
] =
252 g_signal_new ("text_remove",
254 G_SIGNAL_RUN_LAST
| G_SIGNAL_DETAILED
,
256 (GSignalAccumulator
) NULL
, NULL
,
257 atk_marshal_VOID__INT_INT_STRING
,
259 3, G_TYPE_INT
, G_TYPE_INT
, G_TYPE_STRING
);
262 * AtkText::text-caret-moved:
263 * @atktext: the object which received the signal.
264 * @arg1: The new position of the text caret.
266 * The "text-caret-moved" signal is emitted when the caret
267 * position of the text of an object which implements AtkText
270 atk_text_signals
[TEXT_CARET_MOVED
] =
271 g_signal_new ("text_caret_moved",
274 G_STRUCT_OFFSET (AtkTextIface
, text_caret_moved
),
275 (GSignalAccumulator
) NULL
, NULL
,
276 g_cclosure_marshal_VOID__INT
,
281 * AtkText::text-selection-changed:
282 * @atktext: the object which received the signal.
284 * The "text-selection-changed" signal is emitted when the
285 * selected text of an object which implements AtkText changes.
287 atk_text_signals
[TEXT_SELECTION_CHANGED
] =
288 g_signal_new ("text_selection_changed",
291 G_STRUCT_OFFSET (AtkTextIface
, text_selection_changed
),
292 (GSignalAccumulator
) NULL
, NULL
,
293 g_cclosure_marshal_VOID__VOID
,
296 * AtkText::text-attributes-changed:
297 * @atktext: the object which received the signal.
299 * The "text-attributes-changed" signal is emitted when the text
300 * attributes of the text of an object which implements AtkText
303 atk_text_signals
[TEXT_ATTRIBUTES_CHANGED
] =
304 g_signal_new ("text_attributes_changed",
307 G_STRUCT_OFFSET (AtkTextIface
, text_attributes_changed
),
308 (GSignalAccumulator
) NULL
, NULL
,
309 g_cclosure_marshal_VOID__VOID
,
320 * @start_offset: start position
321 * @end_offset: end position, or -1 for the end of the string.
323 * Gets the specified text.
325 * Returns: a newly allocated string containing the text from @start_offset up
326 * to, but not including @end_offset. Use g_free() to free the returned string.
329 atk_text_get_text (AtkText
*text
,
335 g_return_val_if_fail (ATK_IS_TEXT (text
), NULL
);
337 iface
= ATK_TEXT_GET_IFACE (text
);
339 if (start_offset
< 0 || end_offset
< -1 ||
340 (end_offset
!= -1 && end_offset
< start_offset
))
344 return (*(iface
->get_text
)) (text
, start_offset
, end_offset
);
350 * atk_text_get_character_at_offset:
354 * Gets the specified text.
356 * Returns: the character at @offset.
359 atk_text_get_character_at_offset (AtkText
*text
,
364 g_return_val_if_fail (ATK_IS_TEXT (text
), (gunichar
) 0);
366 iface
= ATK_TEXT_GET_IFACE (text
);
368 if (iface
->get_character_at_offset
)
369 return (*(iface
->get_character_at_offset
)) (text
, offset
);
375 * atk_text_get_text_after_offset:
378 * @boundary_type: An #AtkTextBoundary
379 * @start_offset: (out): the start offset of the returned string
380 * @end_offset: (out): the offset of the first character after the
383 * Gets the specified text.
385 * Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
387 * Returns: a newly allocated string containing the text after @offset bounded
388 * by the specified @boundary_type. Use g_free() to free the returned string.
391 atk_text_get_text_after_offset (AtkText
*text
,
393 AtkTextBoundary boundary_type
,
398 gint local_start_offset
, local_end_offset
;
399 gint
*real_start_offset
, *real_end_offset
;
401 g_return_val_if_fail (ATK_IS_TEXT (text
), NULL
);
404 real_start_offset
= start_offset
;
406 real_start_offset
= &local_start_offset
;
408 real_end_offset
= end_offset
;
410 real_end_offset
= &local_end_offset
;
415 iface
= ATK_TEXT_GET_IFACE (text
);
417 if (iface
->get_text_after_offset
)
418 return (*(iface
->get_text_after_offset
)) (text
, offset
, boundary_type
, real_start_offset
, real_end_offset
);
424 * atk_text_get_text_at_offset:
427 * @boundary_type: An #AtkTextBoundary
428 * @start_offset: (out): the start offset of the returned string
429 * @end_offset: (out): the offset of the first character after the
432 * Gets the specified text.
434 * If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
435 * offset is returned.
437 * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
438 * is from the word start at or before the offset to the word start after
441 * The returned string will contain the word at the offset if the offset
442 * is inside a word and will contain the word before the offset if the
443 * offset is not inside a word.
445 * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
446 * string is from the sentence start at or before the offset to the sentence
447 * start after the offset.
449 * The returned string will contain the sentence at the offset if the offset
450 * is inside a sentence and will contain the sentence before the offset
451 * if the offset is not inside a sentence.
453 * If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
454 * string is from the line start at or before the offset to the line
455 * start after the offset.
457 * Deprecated: This method is deprecated since ATK version
458 * 2.9.4. Please use atk_text_get_string_at_offset() instead.
460 * Returns: a newly allocated string containing the text at @offset bounded by
461 * the specified @boundary_type. Use g_free() to free the returned string.
464 atk_text_get_text_at_offset (AtkText
*text
,
466 AtkTextBoundary boundary_type
,
471 gint local_start_offset
, local_end_offset
;
472 gint
*real_start_offset
, *real_end_offset
;
474 g_return_val_if_fail (ATK_IS_TEXT (text
), NULL
);
477 real_start_offset
= start_offset
;
479 real_start_offset
= &local_start_offset
;
481 real_end_offset
= end_offset
;
483 real_end_offset
= &local_end_offset
;
485 iface
= ATK_TEXT_GET_IFACE (text
);
487 if (iface
->get_text_at_offset
)
488 return (*(iface
->get_text_at_offset
)) (text
, offset
, boundary_type
, real_start_offset
, real_end_offset
);
494 * atk_text_get_text_before_offset:
497 * @boundary_type: An #AtkTextBoundary
498 * @start_offset: (out): the start offset of the returned string
499 * @end_offset: (out): the offset of the first character after the
502 * Gets the specified text.
504 * Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
506 * Returns: a newly allocated string containing the text before @offset bounded
507 * by the specified @boundary_type. Use g_free() to free the returned string.
510 atk_text_get_text_before_offset (AtkText
*text
,
512 AtkTextBoundary boundary_type
,
517 gint local_start_offset
, local_end_offset
;
518 gint
*real_start_offset
, *real_end_offset
;
520 g_return_val_if_fail (ATK_IS_TEXT (text
), NULL
);
523 real_start_offset
= start_offset
;
525 real_start_offset
= &local_start_offset
;
527 real_end_offset
= end_offset
;
529 real_end_offset
= &local_end_offset
;
534 iface
= ATK_TEXT_GET_IFACE (text
);
536 if (iface
->get_text_before_offset
)
537 return (*(iface
->get_text_before_offset
)) (text
, offset
, boundary_type
, real_start_offset
, real_end_offset
);
543 * atk_text_get_string_at_offset:
546 * @granularity: An #AtkTextGranularity
547 * @start_offset: (out): the start offset of the returned string, or -1
548 * if an error has occurred (e.g. invalid offset, not implemented)
549 * @end_offset: (out): the offset of the first character after the returned string,
550 * or -1 if an error has occurred (e.g. invalid offset, not implemented)
552 * Gets a portion of the text exposed through an #AtkText according to a given @offset
553 * and a specific @granularity, along with the start and end offsets defining the
554 * boundaries of such a portion of text.
556 * If @granularity is ATK_TEXT_GRANULARITY_CHAR the character at the
557 * offset is returned.
559 * If @granularity is ATK_TEXT_GRANULARITY_WORD the returned string
560 * is from the word start at or before the offset to the word start after
563 * The returned string will contain the word at the offset if the offset
564 * is inside a word and will contain the word before the offset if the
565 * offset is not inside a word.
567 * If @granularity is ATK_TEXT_GRANULARITY_SENTENCE the returned string
568 * is from the sentence start at or before the offset to the sentence
569 * start after the offset.
571 * The returned string will contain the sentence at the offset if the offset
572 * is inside a sentence and will contain the sentence before the offset
573 * if the offset is not inside a sentence.
575 * If @granularity is ATK_TEXT_GRANULARITY_LINE the returned string
576 * is from the line start at or before the offset to the line
577 * start after the offset.
579 * If @granularity is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string
580 * is from the start of the paragraph at or before the offset to the start
581 * of the following paragraph after the offset.
585 * Returns: (nullable): a newly allocated string containing the text
586 * at the @offset bounded by the specified @granularity. Use
587 * g_free() to free the returned string. Returns %NULL if the
588 * offset is invalid or no implementation is available.
590 gchar
* atk_text_get_string_at_offset (AtkText
*text
,
592 AtkTextGranularity granularity
,
597 gint local_start_offset
, local_end_offset
;
598 gint
*real_start_offset
, *real_end_offset
;
600 g_return_val_if_fail (ATK_IS_TEXT (text
), NULL
);
605 real_start_offset
= start_offset
;
608 real_start_offset
= &local_start_offset
;
613 real_end_offset
= end_offset
;
616 real_end_offset
= &local_end_offset
;
621 iface
= ATK_TEXT_GET_IFACE (text
);
623 if (iface
->get_string_at_offset
)
624 return (*(iface
->get_string_at_offset
)) (text
, offset
, granularity
, real_start_offset
, real_end_offset
);
630 * atk_text_get_caret_offset:
633 * Gets the offset position of the caret (cursor).
635 * Returns: the offset position of the caret (cursor).
638 atk_text_get_caret_offset (AtkText
*text
)
642 g_return_val_if_fail (ATK_IS_TEXT (text
), 0);
644 iface
= ATK_TEXT_GET_IFACE (text
);
646 if (iface
->get_caret_offset
)
647 return (*(iface
->get_caret_offset
)) (text
);
653 * atk_text_get_character_extents:
655 * @offset: The offset of the text character for which bounding information is required.
656 * @x: (out) (optional): Pointer for the x cordinate of the bounding box
657 * @y: (out) (optional): Pointer for the y cordinate of the bounding box
658 * @width: (out) (optional): Pointer for the width of the bounding box
659 * @height: (out) (optional): Pointer for the height of the bounding box
660 * @coords: specify whether coordinates are relative to the screen or widget window
662 * Get the bounding box containing the glyph representing the character at
663 * a particular text offset.
666 atk_text_get_character_extents (AtkText
*text
,
675 gint local_x
, local_y
, local_width
, local_height
;
676 gint
*real_x
, *real_y
, *real_width
, *real_height
;
678 g_return_if_fail (ATK_IS_TEXT (text
));
691 real_width
= &local_width
;
693 real_height
= height
;
695 real_height
= &local_height
;
705 iface
= ATK_TEXT_GET_IFACE (text
);
707 if (iface
->get_character_extents
)
708 (*(iface
->get_character_extents
)) (text
, offset
, real_x
, real_y
, real_width
, real_height
, coords
);
712 *real_x
= *real_x
+ *real_width
;
718 * atk_text_get_run_attributes:
720 *@offset: the offset at which to get the attributes, -1 means the offset of
721 *the character to be inserted at the caret location.
722 *@start_offset: (out): the address to put the start offset of the range
723 *@end_offset: (out): the address to put the end offset of the range
725 *Creates an #AtkAttributeSet which consists of the attributes explicitly
726 *set at the position @offset in the text. @start_offset and @end_offset are
727 *set to the start and end of the range around @offset where the attributes are
728 *invariant. Note that @end_offset is the offset of the first character
729 *after the range. See the enum AtkTextAttribute for types of text
730 *attributes that can be returned. Note that other attributes may also be
733 *Returns: (transfer full): an #AtkAttributeSet which contains the attributes
734 * explicitly set at @offset. This #AtkAttributeSet should be freed by a call
735 * to atk_attribute_set_free().
738 atk_text_get_run_attributes (AtkText
*text
,
744 gint local_start_offset
, local_end_offset
;
745 gint
*real_start_offset
, *real_end_offset
;
747 g_return_val_if_fail (ATK_IS_TEXT (text
), NULL
);
750 real_start_offset
= start_offset
;
752 real_start_offset
= &local_start_offset
;
754 real_end_offset
= end_offset
;
756 real_end_offset
= &local_end_offset
;
761 iface
= ATK_TEXT_GET_IFACE (text
);
763 if (iface
->get_run_attributes
)
764 return (*(iface
->get_run_attributes
)) (text
, offset
, real_start_offset
, real_end_offset
);
770 * atk_text_get_default_attributes:
773 *Creates an #AtkAttributeSet which consists of the default values of
774 *attributes for the text. See the enum AtkTextAttribute for types of text
775 *attributes that can be returned. Note that other attributes may also be
778 *Returns: (transfer full): an #AtkAttributeSet which contains the default
779 * values of attributes. at @offset. this #atkattributeset should be freed by
780 * a call to atk_attribute_set_free().
783 atk_text_get_default_attributes (AtkText
*text
)
787 g_return_val_if_fail (ATK_IS_TEXT (text
), NULL
);
789 iface
= ATK_TEXT_GET_IFACE (text
);
791 if (iface
->get_default_attributes
)
792 return (*(iface
->get_default_attributes
)) (text
);
798 * atk_text_get_character_count:
801 * Gets the character count.
803 * Returns: the number of characters.
806 atk_text_get_character_count (AtkText
*text
)
810 g_return_val_if_fail (ATK_IS_TEXT (text
), -1);
812 iface
= ATK_TEXT_GET_IFACE (text
);
814 if (iface
->get_character_count
)
815 return (*(iface
->get_character_count
)) (text
);
821 * atk_text_get_offset_at_point:
823 * @x: screen x-position of character
824 * @y: screen y-position of character
825 * @coords: specify whether coordinates are relative to the screen or
828 * Gets the offset of the character located at coordinates @x and @y. @x and @y
829 * are interpreted as being relative to the screen or this widget's window
830 * depending on @coords.
832 * Returns: the offset to the character which is located at
833 * the specified @x and @y coordinates.
836 atk_text_get_offset_at_point (AtkText
*text
,
843 g_return_val_if_fail (ATK_IS_TEXT (text
), -1);
845 iface
= ATK_TEXT_GET_IFACE (text
);
847 if (iface
->get_offset_at_point
)
848 return (*(iface
->get_offset_at_point
)) (text
, x
, y
, coords
);
854 * atk_text_get_n_selections:
857 * Gets the number of selected regions.
859 * Returns: The number of selected regions, or -1 if a failure
863 atk_text_get_n_selections (AtkText
*text
)
867 g_return_val_if_fail (ATK_IS_TEXT (text
), -1);
869 iface
= ATK_TEXT_GET_IFACE (text
);
871 if (iface
->get_n_selections
)
872 return (*(iface
->get_n_selections
)) (text
);
878 * atk_text_get_selection:
880 * @selection_num: The selection number. The selected regions are
881 * assigned numbers that correspond to how far the region is from the
882 * start of the text. The selected region closest to the beginning
883 * of the text region is assigned the number 0, etc. Note that adding,
884 * moving or deleting a selected region can change the numbering.
885 * @start_offset: (out): passes back the start position of the selected region
886 * @end_offset: (out): passes back the end position of (e.g. offset immediately past)
887 * the selected region
889 * Gets the text from the specified selection.
891 * Returns: a newly allocated string containing the selected text. Use g_free()
892 * to free the returned string.
895 atk_text_get_selection (AtkText
*text
,
901 gint local_start_offset
, local_end_offset
;
902 gint
*real_start_offset
, *real_end_offset
;
904 g_return_val_if_fail (ATK_IS_TEXT (text
), NULL
);
907 real_start_offset
= start_offset
;
909 real_start_offset
= &local_start_offset
;
911 real_end_offset
= end_offset
;
913 real_end_offset
= &local_end_offset
;
915 iface
= ATK_TEXT_GET_IFACE (text
);
917 if (iface
->get_selection
)
919 return (*(iface
->get_selection
)) (text
, selection_num
,
920 real_start_offset
, real_end_offset
);
927 * atk_text_add_selection:
929 * @start_offset: the start position of the selected region
930 * @end_offset: the offset of the first character after the selected region.
932 * Adds a selection bounded by the specified offsets.
934 * Returns: %TRUE if success, %FALSE otherwise
937 atk_text_add_selection (AtkText
*text
,
943 g_return_val_if_fail (ATK_IS_TEXT (text
), FALSE
);
945 iface
= ATK_TEXT_GET_IFACE (text
);
947 if (iface
->add_selection
)
948 return (*(iface
->add_selection
)) (text
, start_offset
, end_offset
);
954 * atk_text_remove_selection:
956 * @selection_num: The selection number. The selected regions are
957 * assigned numbers that correspond to how far the region is from the
958 * start of the text. The selected region closest to the beginning
959 * of the text region is assigned the number 0, etc. Note that adding,
960 * moving or deleting a selected region can change the numbering.
962 * Removes the specified selection.
964 * Returns: %TRUE if success, %FALSE otherwise
967 atk_text_remove_selection (AtkText
*text
,
972 g_return_val_if_fail (ATK_IS_TEXT (text
), FALSE
);
974 iface
= ATK_TEXT_GET_IFACE (text
);
976 if (iface
->remove_selection
)
977 return (*(iface
->remove_selection
)) (text
, selection_num
);
983 * atk_text_set_selection:
985 * @selection_num: The selection number. The selected regions are
986 * assigned numbers that correspond to how far the region is from the
987 * start of the text. The selected region closest to the beginning
988 * of the text region is assigned the number 0, etc. Note that adding,
989 * moving or deleting a selected region can change the numbering.
990 * @start_offset: the new start position of the selection
991 * @end_offset: the new end position of (e.g. offset immediately past)
994 * Changes the start and end offset of the specified selection.
996 * Returns: %TRUE if success, %FALSE otherwise
999 atk_text_set_selection (AtkText
*text
,
1004 AtkTextIface
*iface
;
1006 g_return_val_if_fail (ATK_IS_TEXT (text
), FALSE
);
1008 iface
= ATK_TEXT_GET_IFACE (text
);
1010 if (iface
->set_selection
)
1012 return (*(iface
->set_selection
)) (text
, selection_num
,
1013 start_offset
, end_offset
);
1020 * atk_text_set_caret_offset:
1021 * @text: an #AtkText
1024 * Sets the caret (cursor) position to the specified @offset.
1026 * Returns: %TRUE if success, %FALSE otherwise.
1029 atk_text_set_caret_offset (AtkText
*text
,
1032 AtkTextIface
*iface
;
1034 g_return_val_if_fail (ATK_IS_TEXT (text
), FALSE
);
1036 iface
= ATK_TEXT_GET_IFACE (text
);
1038 if (iface
->set_caret_offset
)
1040 return (*(iface
->set_caret_offset
)) (text
, offset
);
1049 * atk_text_get_range_extents:
1050 * @text: an #AtkText
1051 * @start_offset: The offset of the first text character for which boundary
1052 * information is required.
1053 * @end_offset: The offset of the text character after the last character
1054 * for which boundary information is required.
1055 * @coord_type: Specify whether coordinates are relative to the screen or widget window.
1056 * @rect: (out): A pointer to a AtkTextRectangle which is filled in by this function.
1058 * Get the bounding box for text within the specified range.
1063 atk_text_get_range_extents (AtkText
*text
,
1066 AtkCoordType coord_type
,
1067 AtkTextRectangle
*rect
)
1069 AtkTextIface
*iface
;
1071 g_return_if_fail (ATK_IS_TEXT (text
));
1072 g_return_if_fail (rect
);
1073 g_return_if_fail (start_offset
>= 0 && start_offset
< end_offset
);
1075 iface
= ATK_TEXT_GET_IFACE (text
);
1077 if (iface
->get_range_extents
)
1078 (*(iface
->get_range_extents
)) (text
, start_offset
, end_offset
, coord_type
, rect
);
1082 * atk_text_get_bounded_ranges:
1083 * @text: an #AtkText
1084 * @rect: An AtkTextRectangle giving the dimensions of the bounding box.
1085 * @coord_type: Specify whether coordinates are relative to the screen or widget window.
1086 * @x_clip_type: Specify the horizontal clip type.
1087 * @y_clip_type: Specify the vertical clip type.
1089 * Get the ranges of text in the specified bounding box.
1093 * Returns: (array zero-terminated=1): Array of AtkTextRange. The last
1094 * element of the array returned by this function will be NULL.
1097 atk_text_get_bounded_ranges (AtkText
*text
,
1098 AtkTextRectangle
*rect
,
1099 AtkCoordType coord_type
,
1100 AtkTextClipType x_clip_type
,
1101 AtkTextClipType y_clip_type
)
1103 AtkTextIface
*iface
;
1105 g_return_val_if_fail (ATK_IS_TEXT (text
), NULL
);
1106 g_return_val_if_fail (rect
, NULL
);
1108 iface
= ATK_TEXT_GET_IFACE (text
);
1110 if (iface
->get_bounded_ranges
)
1111 return (*(iface
->get_bounded_ranges
)) (text
, rect
, coord_type
, x_clip_type
, y_clip_type
);
1117 * atk_attribute_set_free:
1118 * @attrib_set: The #AtkAttributeSet to free
1120 * Frees the memory used by an #AtkAttributeSet, including all its
1124 atk_attribute_set_free (AtkAttributeSet
*attrib_set
)
1130 while (temp
!= NULL
)
1137 g_free (att
->value
);
1141 g_slist_free (attrib_set
);
1145 * atk_text_attribute_register:
1146 * @name: a name string
1148 * Associate @name with a new #AtkTextAttribute
1150 * Returns: an #AtkTextAttribute associated with @name
1153 atk_text_attribute_register (const gchar
*name
)
1155 g_return_val_if_fail (name
, ATK_TEXT_ATTR_INVALID
);
1157 if (!extra_attributes
)
1158 extra_attributes
= g_ptr_array_new ();
1160 g_ptr_array_add (extra_attributes
, g_strdup (name
));
1161 return extra_attributes
->len
+ ATK_TEXT_ATTR_LAST_DEFINED
;
1165 * atk_text_attribute_get_name:
1166 * @attr: The #AtkTextAttribute whose name is required
1168 * Gets the name corresponding to the #AtkTextAttribute
1170 * Returns: a string containing the name; this string should not be freed
1173 atk_text_attribute_get_name (AtkTextAttribute attr
)
1175 GTypeClass
*type_class
;
1177 const gchar
*name
= NULL
;
1179 type_class
= g_type_class_ref (ATK_TYPE_TEXT_ATTRIBUTE
);
1180 g_return_val_if_fail (G_IS_ENUM_CLASS (type_class
), NULL
);
1182 value
= g_enum_get_value (G_ENUM_CLASS (type_class
), attr
);
1186 name
= value
->value_nick
;
1190 if (extra_attributes
)
1194 n
-= ATK_TEXT_ATTR_LAST_DEFINED
+ 1;
1196 if (n
< extra_attributes
->len
)
1198 name
= g_ptr_array_index (extra_attributes
, n
);
1201 g_type_class_unref (type_class
);
1206 * atk_text_attribute_for_name:
1207 * @name: a string which is the (non-localized) name of an ATK text attribute.
1209 * Get the #AtkTextAttribute type corresponding to a text attribute name.
1211 * Returns: the #AtkTextAttribute enumerated type corresponding to the specified
1213 * or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found.
1216 atk_text_attribute_for_name (const gchar
*name
)
1218 GTypeClass
*type_class
;
1220 AtkTextAttribute type
= ATK_TEXT_ATTR_INVALID
;
1222 g_return_val_if_fail (name
, ATK_TEXT_ATTR_INVALID
);
1224 type_class
= g_type_class_ref (ATK_TYPE_TEXT_ATTRIBUTE
);
1225 g_return_val_if_fail (G_IS_ENUM_CLASS (type_class
), ATK_TEXT_ATTR_INVALID
);
1227 value
= g_enum_get_value_by_nick (G_ENUM_CLASS (type_class
), name
);
1231 type
= value
->value
;
1237 if (extra_attributes
)
1239 for (i
= 0; i
< extra_attributes
->len
; i
++)
1241 gchar
*extra_attribute
= (gchar
*)g_ptr_array_index (extra_attributes
, i
);
1243 g_return_val_if_fail (extra_attribute
, ATK_TEXT_ATTR_INVALID
);
1245 if (strcmp (name
, extra_attribute
) == 0)
1247 type
= i
+ 1 + ATK_TEXT_ATTR_LAST_DEFINED
;
1253 g_type_class_unref (type_class
);
1259 * atk_text_attribute_get_value:
1260 * @attr: The #AtkTextAttribute for which a value is required
1261 * @index_: The index of the required value
1263 * Gets the value for the index of the #AtkTextAttribute
1265 * Returns: (nullable): a string containing the value; this string
1266 * should not be freed; %NULL is returned if there are no values
1267 * maintained for the attr value.
1270 atk_text_attribute_get_value (AtkTextAttribute attr
,
1275 case ATK_TEXT_ATTR_INVISIBLE
:
1276 case ATK_TEXT_ATTR_EDITABLE
:
1277 case ATK_TEXT_ATTR_BG_FULL_HEIGHT
:
1278 case ATK_TEXT_ATTR_STRIKETHROUGH
:
1279 case ATK_TEXT_ATTR_BG_STIPPLE
:
1280 case ATK_TEXT_ATTR_FG_STIPPLE
:
1281 g_assert (index
>= 0 && index
< G_N_ELEMENTS (boolean_offsets
));
1282 return boolean
+ boolean_offsets
[index
];
1283 case ATK_TEXT_ATTR_UNDERLINE
:
1284 g_assert (index
>= 0 && index
< G_N_ELEMENTS (underline_offsets
));
1285 return underline
+ underline_offsets
[index
];
1286 case ATK_TEXT_ATTR_WRAP_MODE
:
1287 g_assert (index
>= 0 && index
< G_N_ELEMENTS (wrap_mode_offsets
));
1288 return wrap_mode
+ wrap_mode_offsets
[index
];
1289 case ATK_TEXT_ATTR_DIRECTION
:
1290 g_assert (index
>= 0 && index
< G_N_ELEMENTS (direction_offsets
));
1291 return direction
+ direction_offsets
[index
];
1292 case ATK_TEXT_ATTR_JUSTIFICATION
:
1293 g_assert (index
>= 0 && index
< G_N_ELEMENTS (justification_offsets
));
1294 return justification
+ justification_offsets
[index
];
1295 case ATK_TEXT_ATTR_STRETCH
:
1296 g_assert (index
>= 0 && index
< G_N_ELEMENTS (stretch_offsets
));
1297 return stretch
+ stretch_offsets
[index
];
1298 case ATK_TEXT_ATTR_VARIANT
:
1299 g_assert (index
>= 0 && index
< G_N_ELEMENTS (variant_offsets
));
1300 return variant
+ variant_offsets
[index
];
1301 case ATK_TEXT_ATTR_STYLE
:
1302 g_assert (index
>= 0 && index
< G_N_ELEMENTS (style_offsets
));
1303 return style
+ style_offsets
[index
];
1310 atk_text_rectangle_union (AtkTextRectangle
*src1
,
1311 AtkTextRectangle
*src2
,
1312 AtkTextRectangle
*dest
)
1314 gint dest_x
, dest_y
;
1316 dest_x
= MIN (src1
->x
, src2
->x
);
1317 dest_y
= MIN (src1
->y
, src2
->y
);
1318 dest
->width
= MAX (src1
->x
+ src1
->width
, src2
->x
+ src2
->width
) - dest_x
;
1319 dest
->height
= MAX (src1
->y
+ src1
->height
, src2
->y
+ src2
->height
) - dest_y
;
1325 atk_text_rectangle_contain (AtkTextRectangle
*clip
,
1326 AtkTextRectangle
*bounds
,
1327 AtkTextClipType x_clip_type
,
1328 AtkTextClipType y_clip_type
)
1330 gboolean x_min_ok
, x_max_ok
, y_min_ok
, y_max_ok
;
1332 x_min_ok
= (bounds
->x
>= clip
->x
) ||
1333 ((bounds
->x
+ bounds
->width
>= clip
->x
) &&
1334 ((x_clip_type
== ATK_TEXT_CLIP_NONE
) ||
1335 (x_clip_type
== ATK_TEXT_CLIP_MAX
)));
1337 x_max_ok
= (bounds
->x
+ bounds
->width
<= clip
->x
+ clip
->width
) ||
1338 ((bounds
->x
<= clip
->x
+ clip
->width
) &&
1339 ((x_clip_type
== ATK_TEXT_CLIP_NONE
) ||
1340 (x_clip_type
== ATK_TEXT_CLIP_MIN
)));
1342 y_min_ok
= (bounds
->y
>= clip
->y
) ||
1343 ((bounds
->y
+ bounds
->height
>= clip
->y
) &&
1344 ((y_clip_type
== ATK_TEXT_CLIP_NONE
) ||
1345 (y_clip_type
== ATK_TEXT_CLIP_MAX
)));
1347 y_max_ok
= (bounds
->y
+ bounds
->height
<= clip
->y
+ clip
->height
) ||
1348 ((bounds
->y
<= clip
->y
+ clip
->height
) &&
1349 ((y_clip_type
== ATK_TEXT_CLIP_NONE
) ||
1350 (y_clip_type
== ATK_TEXT_CLIP_MIN
)));
1352 return (x_min_ok
&& x_max_ok
&& y_min_ok
&& y_max_ok
);
1357 atk_text_real_get_range_extents (AtkText
*text
,
1360 AtkCoordType coord_type
,
1361 AtkTextRectangle
*rect
)
1364 AtkTextRectangle cbounds
, bounds
;
1366 atk_text_get_character_extents (text
, start_offset
,
1367 &bounds
.x
, &bounds
.y
,
1368 &bounds
.width
, &bounds
.height
,
1371 for (i
= start_offset
+ 1; i
< end_offset
; i
++)
1373 atk_text_get_character_extents (text
, i
,
1374 &cbounds
.x
, &cbounds
.y
,
1375 &cbounds
.width
, &cbounds
.height
,
1377 atk_text_rectangle_union (&bounds
, &cbounds
, &bounds
);
1382 rect
->width
= bounds
.width
;
1383 rect
->height
= bounds
.height
;
1386 static AtkTextRange
**
1387 atk_text_real_get_bounded_ranges (AtkText
*text
,
1388 AtkTextRectangle
*rect
,
1389 AtkCoordType coord_type
,
1390 AtkTextClipType x_clip_type
,
1391 AtkTextClipType y_clip_type
)
1393 gint bounds_min_offset
, bounds_max_offset
;
1394 gint min_line_start
, min_line_end
;
1395 gint max_line_start
, max_line_end
;
1399 gint num_ranges
= 0;
1400 gint range_size
= 1;
1401 AtkTextRectangle cbounds
;
1402 AtkTextRange
**range
;
1405 bounds_min_offset
= atk_text_get_offset_at_point (text
, rect
->x
, rect
->y
, coord_type
);
1406 bounds_max_offset
= atk_text_get_offset_at_point (text
, rect
->x
+ rect
->width
, rect
->y
+ rect
->height
, coord_type
);
1408 if (bounds_min_offset
== 0 &&
1409 bounds_min_offset
== bounds_max_offset
)
1412 line
= atk_text_get_text_at_offset (text
, bounds_min_offset
,
1413 ATK_TEXT_BOUNDARY_LINE_START
,
1414 &min_line_start
, &min_line_end
);
1416 line
= atk_text_get_text_at_offset (text
, bounds_max_offset
,
1417 ATK_TEXT_BOUNDARY_LINE_START
,
1418 &max_line_start
, &max_line_end
);
1420 bounds_min_offset
= MIN (min_line_start
, max_line_start
);
1421 bounds_max_offset
= MAX (min_line_end
, max_line_end
);
1423 curr_offset
= bounds_min_offset
;
1424 while (curr_offset
< bounds_max_offset
)
1426 offset
= curr_offset
;
1428 while (curr_offset
< bounds_max_offset
)
1430 atk_text_get_character_extents (text
, curr_offset
,
1431 &cbounds
.x
, &cbounds
.y
,
1432 &cbounds
.width
, &cbounds
.height
,
1434 if (!atk_text_rectangle_contain (rect
, &cbounds
, x_clip_type
, y_clip_type
))
1438 if (curr_offset
> offset
)
1440 AtkTextRange
*one_range
= g_new (AtkTextRange
, 1);
1442 one_range
->start_offset
= offset
;
1443 one_range
->end_offset
= curr_offset
;
1444 one_range
->content
= atk_text_get_text (text
, offset
, curr_offset
);
1445 atk_text_get_range_extents (text
, offset
, curr_offset
, coord_type
, &one_range
->bounds
);
1447 if (num_ranges
>= range_size
- 1)
1450 range
= g_realloc (range
, range_size
* sizeof (gpointer
));
1452 range
[num_ranges
] = one_range
;
1457 range
[num_ranges
] = NULL
;
1463 * atk_text_free_ranges:
1464 * @ranges: (array): A pointer to an array of #AtkTextRange which is
1467 * Frees the memory associated with an array of AtkTextRange. It is assumed
1468 * that the array was returned by the function atk_text_get_bounded_ranges
1469 * and is NULL terminated.
1474 atk_text_free_ranges (AtkTextRange
**ranges
)
1476 AtkTextRange
**first
= ranges
;
1482 AtkTextRange
*range
;
1486 g_free (range
->content
);
1493 static AtkTextRange
*
1494 atk_text_range_copy (AtkTextRange
*src
)
1496 AtkTextRange
*dst
= g_new0 (AtkTextRange
, 1);
1497 dst
->bounds
= src
->bounds
;
1498 dst
->start_offset
= src
->start_offset
;
1499 dst
->end_offset
= src
->end_offset
;
1501 dst
->content
= g_strdup (src
->content
);
1506 atk_text_range_free (AtkTextRange
*range
)
1508 g_free (range
->content
);
1512 G_DEFINE_BOXED_TYPE (AtkTextRange
, atk_text_range
, atk_text_range_copy
,
1513 atk_text_range_free
)