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 #ifndef __ATK_TEXT_H__
22 #define __ATK_TEXT_H__
24 #include <pango/pango.h>
25 #include <glib-object.h>
26 #include <atk/atkobject.h>
30 #endif /* __cplusplus */
32 #define ATK_TYPE_TEXT (atk_text_get_type ())
33 #define ATK_IS_TEXT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_TEXT)
34 #define ATK_TEXT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_TEXT, AtkText)
35 #define ATK_TEXT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_TEXT, AtkTextIface))
37 #ifndef _TYPEDEF_ATK_TEXT_
38 #define _TYPEDEF_ATK_TEXT_
39 typedef struct _AtkText AtkText;
41 typedef struct _AtkTextIface AtkTextIface;
46 *@ATK_XY_SCREEN: specifies xy coordinates relative to the screen
47 *@ATK_XY_WIDGET: specifies xy coordinates relative to the widgets window
49 *Specifies what type of coordinates are to be returned for functions that
50 *return position coordinates
59 *@ATK_TEXT_BOUNDARY_CHAR:
60 *@ATK_TEXT_BOUNDARY_CURSOR_POS:
61 *@ATK_TEXT_BOUNDARY_WORD_START:
62 *@ATK_TEXT_BOUNDARY_WORD_END:
63 *@ATK_TEXT_BOUNDARY_SENTENCE_START:
64 *@ATK_TEXT_BOUNDARY_SENTENCE_END:
65 *@ATK_TEXT_BOUNDARY_LINE_START:
66 *@ATK_TEXT_BOUNDARY_LINE_END:
68 *Text boundary types used for specifying boundaries for regions of text
71 ATK_TEXT_BOUNDARY_CHAR,
72 ATK_TEXT_BOUNDARY_CURSOR_POS,
73 ATK_TEXT_BOUNDARY_WORD_START,
74 ATK_TEXT_BOUNDARY_WORD_END,
75 ATK_TEXT_BOUNDARY_SENTENCE_START,
76 ATK_TEXT_BOUNDARY_SENTENCE_END,
77 ATK_TEXT_BOUNDARY_LINE_START,
78 ATK_TEXT_BOUNDARY_LINE_END
83 GTypeInterface parent;
85 gchar* (* get_text) (AtkText *text,
88 gchar* (* get_text_after_offset) (AtkText *text,
90 AtkTextBoundary boundary_type);
91 gchar* (* get_text_at_offset) (AtkText *text,
93 AtkTextBoundary boundary_type);
94 gunichar (* get_character_at_offset) (AtkText *text,
96 gchar* (* get_text_before_offset) (AtkText *text,
98 AtkTextBoundary boundary_type);
99 gint (* get_caret_offset) (AtkText *text);
100 AtkAttributeSet* (* ref_run_attributes) (AtkText *text,
104 void (* get_character_extents) (AtkText *text,
111 gint (* get_character_count) (AtkText *text);
112 gint (* get_offset_at_point) (AtkText *text,
116 gint (* get_n_selections) (AtkText *text);
117 gchar* (* get_selection) (AtkText *text,
121 gboolean (* add_selection) (AtkText *text,
124 gboolean (* remove_selection) (AtkText *text,
126 gboolean (* set_selection) (AtkText *text,
130 gboolean (* set_caret_offset) (AtkText *text,
132 void (* text_changed) (AtkText *text);
133 void (* caret_changed) (AtkText *text,
136 GType atk_text_get_type (void);
140 * Additional AtkObject properties used by AtkText:
141 * "accessible_text" (accessible text has changed)
142 * "accessible_caret" (accessible text cursor position changed:
143 * editable text only)
146 gchar* atk_text_get_text (AtkText *text,
149 gunichar atk_text_get_character_at_offset (AtkText *text,
151 gchar* atk_text_get_text_after_offset (AtkText *text,
153 AtkTextBoundary boundary_type);
154 gchar* atk_text_get_text_at_offset (AtkText *text,
156 AtkTextBoundary boundary_type);
157 gchar* atk_text_get_text_before_offset (AtkText *text,
159 AtkTextBoundary boundary_type);
160 gint atk_text_get_caret_offset (AtkText *text);
161 void atk_text_get_character_extents (AtkText *text,
168 AtkAttributeSet* atk_text_ref_run_attributes (AtkText *text,
172 gint atk_text_get_character_count (AtkText *text);
173 gint atk_text_get_offset_at_point (AtkText *text,
177 gint atk_text_get_n_selections (AtkText *text);
178 gchar* atk_text_get_selection (AtkText *text,
182 gboolean atk_text_add_selection (AtkText *text,
185 gboolean atk_text_remove_selection (AtkText *text,
187 gboolean atk_text_set_selection (AtkText *text,
191 gboolean atk_text_set_caret_offset (AtkText *text,
196 #endif /* __cplusplus */
199 #endif /* __ATK_TEXT_H__ */