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.
21 #include "atkmarshal.h"
29 struct _AtkTextIfaceClass
34 typedef struct _AtkTextIfaceClass AtkTextIfaceClass;
36 static void atk_text_base_init (gpointer *g_class);
38 static guint atk_text_signals[LAST_SIGNAL] = { 0 };
43 static GType type = 0;
47 static const GTypeInfo tinfo =
49 sizeof (AtkTextIface),
50 (GBaseInitFunc) atk_text_base_init,
51 (GBaseFinalizeFunc) NULL,
52 (GClassInitFunc) NULL /* atk_text_interface_init */ ,
53 (GClassFinalizeFunc) NULL,
57 type = g_type_register_static (G_TYPE_INTERFACE, "AtkText", &tinfo, 0);
64 atk_text_base_init (gpointer *g_class)
66 static gboolean initialized = FALSE;
71 * Note that text_changed signal supports details "insert", "delete",
75 atk_text_signals[TEXT_CHANGED] =
76 g_signal_newc ("text_changed",
78 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
79 G_STRUCT_OFFSET (AtkTextIface, text_changed),
80 (GSignalAccumulator) NULL, NULL,
81 atk_marshal_VOID__INT_INT,
83 2, G_TYPE_INT, G_TYPE_INT);
85 atk_text_signals[CARET_MOVED] =
86 g_signal_newc ("text_caret_moved",
89 G_STRUCT_OFFSET (AtkTextIface, caret_changed),
90 (GSignalAccumulator) NULL, NULL,
91 g_cclosure_marshal_VOID__INT,
102 * @start_offset: start position
103 * @end_offset: end position
105 * Gets the specified text.
107 * Returns: the text from @start_offset up to, but not including @end_offset.
110 atk_text_get_text (AtkText *text,
116 g_return_val_if_fail (text != NULL, NULL);
117 g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
119 iface = ATK_TEXT_GET_IFACE (text);
122 return (*(iface->get_text)) (text, start_offset, end_offset);
128 * atk_text_get_character_at_offset
132 * Gets the specified text.
134 * Returns: the character at @offset.
137 atk_text_get_character_at_offset (AtkText *text,
142 g_return_val_if_fail (text != NULL, (gunichar) 0);
143 g_return_val_if_fail (ATK_IS_TEXT (text), (gunichar) 0);
145 iface = ATK_TEXT_GET_IFACE (text);
147 if (iface->get_character_at_offset)
148 return (*(iface->get_character_at_offset)) (text, offset);
154 * atk_text_get_text_after_offset
157 * @boundary_type: An #AtkTextBoundary
159 * Gets the specified text.
160 * If the boundary type is ATK_TEXT_BOUNDARY_WORD_START or
161 * ATK_TEXT_BOUNDARY_WORD_END part of a word may be returned.
162 * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the start point
163 * will be the offset and will continue to the start of the next sentence.
164 * The first word may not be a complete word. Similarly for
165 * ATK_TEXT_BOUNDARY_SENTENCE_END, ATK_TEXT_BOUNDARY_LINE_START and
166 * ATK_TEXT_BOUNDARY_LINE_END
168 * Returns: the text after @offset up to the specified @boundary_type.
171 atk_text_get_text_after_offset (AtkText *text,
173 AtkTextBoundary boundary_type,
179 g_return_val_if_fail (text != NULL, NULL);
180 g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
182 iface = ATK_TEXT_GET_IFACE (text);
184 if (iface->get_text_after_offset)
185 return (*(iface->get_text_after_offset)) (text, offset, boundary_type, startOffset, endOffset);
191 * atk_text_get_text_at_offset
194 * @boundary_type: An #AtkTextBoundary
196 * Gets the specified text.
197 * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START or
198 * ATK_TEXT_BOUNDARY_WORD_END a complete word is returned;
199 * if the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START or
200 * ATK_TEXT_BOUNDARY_SENTENCE_END a complete sentence
201 * is returned; if the boundary type is ATK_TEXT_BOUNDARY_LINE_START or
202 * ATK_TEXT_BOUNDARY_LINE_END a complete line is returned.
204 * Returns: the text at @offset up to the specified @boundary_type.
207 atk_text_get_text_at_offset (AtkText *text,
209 AtkTextBoundary boundary_type,
215 g_return_val_if_fail (text != NULL, NULL);
216 g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
218 iface = ATK_TEXT_GET_IFACE (text);
220 if (iface->get_text_at_offset)
221 return (*(iface->get_text_at_offset)) (text, offset, boundary_type, startOffset, endOffset);
227 * atk_text_get_text_before_offset
230 * @boundary_type: An #AtkTextBoundary
232 * Gets the specified text.
233 * If the boundary type is ATK_TEXT_BOUNDARY_WORD_START or
234 * ATK_TEXT_BOUNDARY_WORD_END part of a word may be returned.
235 * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the start point
236 * will be at the start of the sentence, and will continue to the offset.
237 * The last word may not be a complete word. Similarly for
238 * ATK_TEXT_BOUNDARY_SENTENCE_END, ATK_TEXT_BOUNDARY_LINE_START and
239 * ATK_TEXT_BOUNDARY_LINE_END
241 * Returns: the text before @offset starting from the specified @boundary_type.
244 atk_text_get_text_before_offset (AtkText *text,
246 AtkTextBoundary boundary_type,
252 g_return_val_if_fail (text != NULL, NULL);
253 g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
255 iface = ATK_TEXT_GET_IFACE (text);
257 if (iface->get_text_before_offset)
258 return (*(iface->get_text_before_offset)) (text, offset, boundary_type, startOffset, endOffset);
264 * atk_text_get_caret_offset
267 * Gets the offset position of the caret (cursor).
269 * Returns: the offset position of the caret (cursor), or -1 if
270 * one does not exist (or is not supported by the widget).
273 atk_text_get_caret_offset (AtkText *text)
277 g_return_val_if_fail (text != NULL, -1);
278 g_return_val_if_fail (ATK_IS_TEXT (text), -1);
280 iface = ATK_TEXT_GET_IFACE (text);
282 if (iface->get_caret_offset)
283 return (*(iface->get_caret_offset)) (text);
289 * atk_text_get_character_extents:
292 * @x: x-position of character
293 * @y: y-position of character
294 * @length: length of character
295 * @width: width of character
296 * @coords: specify whether coordinates are relative to the screen or widget window
298 * Given an @offset, the @x, @y, @length, and @width values are filled
302 atk_text_get_character_extents (AtkText *text,
312 g_return_if_fail (text != NULL);
313 g_return_if_fail (ATK_IS_TEXT (text));
315 iface = ATK_TEXT_GET_IFACE (text);
317 if (iface->get_character_extents)
318 (*(iface->get_character_extents)) (text, offset, x, y, length, width, coords);
329 *atk_text_ref_run_attributes:
331 *@offset: the offset at which to get the attributes
332 *@start_offset: the address to put the start offset of the range
333 *@end_offset: the address to put the end offset of the range
335 *Creates an #AtkAttributeSet which consists of the attributes explicitly
336 *set at the position @offset in the text. @start_offset and @end_offset are
337 *set to the start and end of the range around @offset where the attributes are
340 *Returns: an #AtkAttributeSet which contains the attributes explicitly set
343 AtkAttributeSet* atk_text_ref_run_attributes (AtkText *text,
350 g_return_val_if_fail (text != NULL, NULL);
351 g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
353 iface = ATK_TEXT_GET_IFACE (text);
355 if (iface->ref_run_attributes)
356 return (*(iface->ref_run_attributes)) (text, offset, start_offset, end_offset);
362 * atk_text_get_character_count
365 * Gets the character count.
367 * Returns: the number of characters.
370 atk_text_get_character_count (AtkText *text)
374 g_return_val_if_fail (text != NULL, -1);
375 g_return_val_if_fail (ATK_IS_TEXT (text), -1);
377 iface = ATK_TEXT_GET_IFACE (text);
379 if (iface->get_character_count)
380 return (*(iface->get_character_count)) (text);
386 * atk_text_get_offset_at_point:
388 * @x: screen x-position of character
389 * @y: screen y-position of character
390 * @coords: specify whether coordinates are relative to the screen or widget window
392 * Gets the offset of the character located at coordinates @x and @y. @x and @y are
393 * interpreted as being relative to the screen or this widget's window depending
396 * Returns: the offset to the character which is located at
397 * the specified @x and @y coordinates.
400 atk_text_get_offset_at_point (AtkText *text,
407 g_return_val_if_fail (text != NULL, -1);
408 g_return_val_if_fail (ATK_IS_TEXT (text), -1);
410 iface = ATK_TEXT_GET_IFACE (text);
412 if (iface->get_offset_at_point)
413 return (*(iface->get_offset_at_point)) (text, x, y, coords);
419 * atk_text_get_n_selections
422 * Gets the number of selected regions.
424 * Returns: The number of selected regions, or -1 if a failure
428 atk_text_get_n_selections (AtkText *text)
432 g_return_val_if_fail (text != NULL, -1);
433 g_return_val_if_fail (ATK_IS_TEXT (text), -1);
435 iface = ATK_TEXT_GET_IFACE (text);
437 if (iface->get_n_selections)
438 return (*(iface->get_n_selections)) (text);
444 * atk_text_get_selection
446 * @selection_num: The selection number. The selected regions are
447 * assigned numbers that corrispond to how far the region is from the
448 * start of the text. The selected region closest to the beginning
449 * of the text region is assigned the number 0, etc. Note that adding,
450 * moving or deleting a selected region can change the numbering.
451 * @start_offset: passes back the start position of the selected region
452 * @end_offset: passes back the end position of the selected region
454 * Gets the text from the specified selection.
456 * Returns: the selected text.
459 atk_text_get_selection (AtkText *text, gint selection_num,
460 gint *start_offset, gint *end_offset)
464 g_return_val_if_fail (text != NULL, NULL);
465 g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
467 iface = ATK_TEXT_GET_IFACE (text);
469 if (iface->get_selection)
471 return (*(iface->get_selection)) (text, selection_num,
472 start_offset, end_offset);
479 * atk_text_add_selection
481 * @start_offset: the start position of the selected region
482 * @end_offset: the end position of the selected region
484 * Adds a selection bounded by the specified offsets.
486 * Returns: %TRUE if success, %FALSE otherwise
489 atk_text_add_selection (AtkText *text, gint start_offset,
494 g_return_val_if_fail (text != NULL, FALSE);
495 g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
497 iface = ATK_TEXT_GET_IFACE (text);
499 if (iface->add_selection)
500 return (*(iface->add_selection)) (text, start_offset, end_offset);
506 * atk_text_remove_selection
508 * @selection_num: The selection number. The selected regions are
509 * assigned numbers that corrispond to how far the region is from the
510 * start of the text. The selected region closest to the beginning
511 * of the text region is assigned the number 0, etc. Note that adding,
512 * moving or deleting a selected region can change the numbering.
514 * Removes the specified selection
516 * Returns: %TRUE if success, %FALSE otherwise
519 atk_text_remove_selection (AtkText *text, gint selection_num)
523 g_return_val_if_fail (text != NULL, FALSE);
524 g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
526 iface = ATK_TEXT_GET_IFACE (text);
528 if (iface->remove_selection)
529 return (*(iface->remove_selection)) (text, selection_num);
535 * atk_text_set_selection
537 * @selection_num: The selection number. The selected regions are
538 * assigned numbers that corrispond to how far the region is from the
539 * start of the text. The selected region closest to the beginning
540 * of the text region is assigned the number 0, etc. Note that adding,
541 * moving or deleting a selected region can change the numbering.
542 * @start_offset: the new start position of the selection
543 * @end_offset: the new end position of the selection
545 * Changes the start and end offset of the specified selection
547 * Returns: %TRUE if success, %FALSE otherwise
550 atk_text_set_selection (AtkText *text, gint selection_num,
551 gint start_offset, gint end_offset)
555 g_return_val_if_fail (text != NULL, FALSE);
556 g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
558 iface = ATK_TEXT_GET_IFACE (text);
560 if (iface->set_selection)
562 return (*(iface->set_selection)) (text, selection_num,
563 start_offset, end_offset);
570 * atk_text_set_caret_offset
574 * Sets the caret (cursor) position to the specified @offset.
576 * Returns: %TRUE if success, %FALSE otherwise.
579 atk_text_set_caret_offset (AtkText *text,
584 g_return_val_if_fail (text != NULL, FALSE);
585 g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
587 iface = ATK_TEXT_GET_IFACE (text);
589 if (iface->set_caret_offset)
591 return (*(iface->set_caret_offset)) (text, offset);