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.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
25 #ifndef _ATSPI_TEXT_H_
26 #define _ATSPI_TEXT_H_
28 #include "glib-object.h"
30 #include "atspi-constants.h"
32 #include "atspi-types.h"
34 typedef struct _AtspiRange AtspiRange;
44 * The #GType for a boxed type holding a range within a text bock.
46 #define ATSPI_TYPE_RANGE atspi_range_get_type ()
48 GType atspi_range_get_type ();
50 typedef struct _AtspiRangedAttributeSet AtspiRangedAttributeSet;
51 struct _AtspiRangedAttributeSet
53 GHashTable *attributes;
59 * ATSPI_TYPE_RANGED_ATTRIBUTE_SET:
61 * The #GType for a boxed type holding an attribute set within a text block.
63 #define ATSPI_TYPE_RANGED_ATTRIBUTE_SET atspi_ranged_attribute_set_get_type ()
65 GType atspi_ranged_attribute_set_get_type ();
67 typedef struct _AtspiTextRange AtspiTextRange;
68 struct _AtspiTextRange
76 * ATSPI_TYPE_TEXT_RANGE:
78 * The #GType for a boxed type holding a range within a text bock.
80 #define ATSPI_TYPE_TEXT_RANGE atspi_text_range_get_type ()
82 #define ATSPI_TYPE_TEXT (atspi_text_get_type ())
83 #define ATSPI_IS_TEXT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_TEXT)
84 #define ATSPI_TEXT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_TEXT, AtspiText)
85 #define ATSPI_TEXT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATSPI_TYPE_TEXT, AtspiText))
87 GType atspi_text_get_type ();
91 GTypeInterface parent;
95 GType atspi_text_range_get_type ();
97 gint atspi_text_get_character_count (AtspiText *obj, GError **error);
99 gchar * atspi_text_get_text (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
101 gint atspi_text_get_caret_offset (AtspiText *obj, GError **error);
103 AtspiRangedAttributeSet * atspi_text_get_attributes (AtspiText *obj, gint offset, GError **error);
105 AtspiRangedAttributeSet * atspi_text_get_attribute_run (AtspiText *obj, gint offset, gboolean include_defaults, GError **error);
107 gchar * atspi_text_get_attribute_value (AtspiText *obj, gint offset, gchar *attribute_name, GError **error);
109 GHashTable * atspi_text_get_default_attributes (AtspiAccessible *obj, GError **error);
111 gboolean atspi_text_set_caret_offset (AtspiText *obj, gint new_offset, GError **error);
113 AtspiTextRange * atspi_text_get_text_before_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
115 AtspiTextRange * atspi_text_get_text_at_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
117 AtspiTextRange * atspi_text_get_text_after_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
119 guint atspi_text_get_character_at_offset (AtspiText *obj, gint offset, GError **error);
121 AtspiRect * atspi_text_get_character_extents (AtspiText *obj, gint offset, AtspiCoordType type, GError **error);
123 gint atspi_text_get_offset_at_point (AtspiText *obj, gint x, gint y, AtspiCoordType type, GError **error);
125 AtspiRect * atspi_text_get_range_extents (AtspiText *obj, gint start_offset, gint end_offset, AtspiCoordType type, GError **error);
127 GArray * atspi_text_get_bounded_ranges (AtspiText *obj, gint x, gint y, gint width, gint height, AtspiCoordType type, AtspiTextClipType clipTypeX, AtspiTextClipType clipTypeY, GError **error);
129 gint atspi_text_get_n_selections (AtspiText *obj, GError **error);
131 AtspiRange * atspi_text_get_selection (AtspiText *obj, gint selection_num, GError **error);
133 gboolean atspi_text_add_selection (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
135 gboolean atspi_text_remove_selection (AtspiText *obj, gint selection_num, GError **error);
137 gboolean atspi_text_set_selection (AtspiText *obj, gint selection_num, gint start_offset, gint end_offset, GError **error);
138 #endif /* _ATSPI_TEXT_H_ */