2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2002 Ximian, Inc.
6 * 2002 Sun Microsystems Inc.
7 * Copyright 2010, 2011 Novell, Inc.
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Library General Public License for more details.
20 * You should have received a copy of the GNU Library General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 02111-1307, USA.
26 #ifndef _ATSPI_TEXT_H_
27 #define _ATSPI_TEXT_H_
29 #include "glib-object.h"
31 #include "atspi-constants.h"
33 #include "atspi-types.h"
37 typedef struct _AtspiRange AtspiRange;
47 * The #GType for a boxed type holding a range within a text bock.
49 #define ATSPI_TYPE_RANGE atspi_range_get_type ()
51 GType atspi_range_get_type ();
54 atspi_range_copy (AtspiRange *src);
56 typedef struct _AtspiTextRange AtspiTextRange;
57 struct _AtspiTextRange
65 * ATSPI_TYPE_TEXT_RANGE:
67 * The #GType for a boxed type holding a range within a text bock.
69 #define ATSPI_TYPE_TEXT_RANGE atspi_text_range_get_type ()
71 #define ATSPI_TYPE_TEXT (atspi_text_get_type ())
72 #define ATSPI_IS_TEXT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_TEXT)
73 #define ATSPI_TEXT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_TEXT, AtspiText)
74 #define ATSPI_TEXT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATSPI_TYPE_TEXT, AtspiText))
76 GType atspi_text_get_type ();
80 GTypeInterface parent;
84 GType atspi_text_range_get_type ();
86 gint atspi_text_get_character_count (AtspiText *obj, GError **error);
88 gchar * atspi_text_get_text (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
90 gint atspi_text_get_caret_offset (AtspiText *obj, GError **error);
92 #ifndef ATSPI_DISABLE_DEPRECATED
93 GHashTable *atspi_text_get_attributes (AtspiText *obj, gint offset, gint *start_offset, gint *end_offset, GError **error);
96 GHashTable *atspi_text_get_text_attributes (AtspiText *obj, gint offset, gint *start_offset, gint *end_offset, GError **error);
98 GHashTable *atspi_text_get_attribute_run (AtspiText *obj, gint offset, gboolean include_defaults, gint *start_offset, gint *end_offset, GError **error);
100 #ifndef ATSPI_DISABLE_DEPRECATED
101 gchar * atspi_text_get_attribute_value (AtspiText *obj, gint offset, gchar *attribute_name, GError **error);
104 gchar * atspi_text_get_text_attribute_value (AtspiText *obj, gint offset, gchar *attribute_name, GError **error);
106 GHashTable * atspi_text_get_default_attributes (AtspiText *obj, GError **error);
108 gboolean atspi_text_set_caret_offset (AtspiText *obj, gint new_offset, GError **error);
110 #ifndef ATSPI_DISABLE_DEPRECATED
111 AtspiTextRange * atspi_text_get_text_before_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
113 AtspiTextRange * atspi_text_get_text_at_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
115 AtspiTextRange * atspi_text_get_text_after_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
118 AtspiTextRange * atspi_text_get_string_at_offset (AtspiText *obj, gint offset, AtspiTextGranularity granularity, GError **error);
120 guint atspi_text_get_character_at_offset (AtspiText *obj, gint offset, GError **error);
122 AtspiRect * atspi_text_get_character_extents (AtspiText *obj, gint offset, AtspiCoordType type, GError **error);
124 gint atspi_text_get_offset_at_point (AtspiText *obj, gint x, gint y, AtspiCoordType type, GError **error);
126 AtspiRect * atspi_text_get_range_extents (AtspiText *obj, gint start_offset, gint end_offset, AtspiCoordType type, GError **error);
128 GArray * atspi_text_get_bounded_ranges (AtspiText *obj, gint x, gint y, gint width, gint height, AtspiCoordType type, AtspiTextClipType clipTypeX, AtspiTextClipType clipTypeY, GError **error);
130 gint atspi_text_get_n_selections (AtspiText *obj, GError **error);
132 AtspiRange * atspi_text_get_selection (AtspiText *obj, gint selection_num, GError **error);
134 gboolean atspi_text_add_selection (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
136 gboolean atspi_text_remove_selection (AtspiText *obj, gint selection_num, GError **error);
138 gboolean atspi_text_set_selection (AtspiText *obj, gint selection_num, gint start_offset, gint end_offset, GError **error);
142 #endif /* _ATSPI_TEXT_H_ */