1/*
2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4 *
5 * Copyright 2002 Ximian, Inc.
6 * 2002 Sun Microsystems Inc.
7 * Copyright 2010, 2011 Novell, Inc.
8 *
9 *
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
14 *
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 * Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 * Boston, MA 02110-1301, USA.
24 */
25
26#ifndef _ATSPI_TEXT_H_
27#define _ATSPI_TEXT_H_
28
29#include "glib-object.h"
30
31#include "atspi-constants.h"
32
33#include "atspi-types.h"
34
35G_BEGIN_DECLS
36
37typedef struct _AtspiRange AtspiRange;
38struct _AtspiRange
39{
40 gint start_offset;
41 gint end_offset;
42};
43
44/**
45 * ATSPI_TYPE_RANGE:
46 *
47 * The #GType for a boxed type holding a range within a text bock.
48 */
49#define ATSPI_TYPE_RANGE atspi_range_get_type ()
50
51GType atspi_range_get_type ();
52
53AtspiRange *
54atspi_range_copy (AtspiRange *src);
55
56typedef struct _AtspiTextRange AtspiTextRange;
57struct _AtspiTextRange
58{
59 gint start_offset;
60 gint end_offset;
61 gchar *content;
62};
63
64/**
65 * ATSPI_TYPE_TEXT_RANGE:
66 *
67 * The #GType for a boxed type holding a range within a text bock.
68 */
69#define ATSPI_TYPE_TEXT_RANGE atspi_text_range_get_type ()
70
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))
75
76GType atspi_text_get_type ();
77
78struct _AtspiText
79{
80 GTypeInterface parent;
81};
82
83
84GType atspi_text_range_get_type ();
85
86gint atspi_text_get_character_count (AtspiText *obj, GError **error);
87
88gchar * atspi_text_get_text (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
89
90gint atspi_text_get_caret_offset (AtspiText *obj, GError **error);
91
92#ifndef ATSPI_DISABLE_DEPRECATED
93GHashTable *atspi_text_get_attributes (AtspiText *obj, gint offset, gint *start_offset, gint *end_offset, GError **error);
94#endif
95
96GHashTable *atspi_text_get_text_attributes (AtspiText *obj, gint offset, gint *start_offset, gint *end_offset, GError **error);
97
98GHashTable *atspi_text_get_attribute_run (AtspiText *obj, gint offset, gboolean include_defaults, gint *start_offset, gint *end_offset, GError **error);
99
100#ifndef ATSPI_DISABLE_DEPRECATED
101gchar * atspi_text_get_attribute_value (AtspiText *obj, gint offset, gchar *attribute_name, GError **error);
102#endif
103
104gchar * atspi_text_get_text_attribute_value (AtspiText *obj, gint offset, gchar *attribute_name, GError **error);
105
106GHashTable * atspi_text_get_default_attributes (AtspiText *obj, GError **error);
107
108gboolean atspi_text_set_caret_offset (AtspiText *obj, gint new_offset, GError **error);
109
110#ifndef ATSPI_DISABLE_DEPRECATED
111AtspiTextRange * atspi_text_get_text_before_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
112
113AtspiTextRange * atspi_text_get_text_at_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
114
115AtspiTextRange * atspi_text_get_text_after_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
116#endif
117
118AtspiTextRange * atspi_text_get_string_at_offset (AtspiText *obj, gint offset, AtspiTextGranularity granularity, GError **error);
119
120guint atspi_text_get_character_at_offset (AtspiText *obj, gint offset, GError **error);
121
122AtspiRect * atspi_text_get_character_extents (AtspiText *obj, gint offset, AtspiCoordType type, GError **error);
123
124gint atspi_text_get_offset_at_point (AtspiText *obj, gint x, gint y, AtspiCoordType type, GError **error);
125
126AtspiRect * atspi_text_get_range_extents (AtspiText *obj, gint start_offset, gint end_offset, AtspiCoordType type, GError **error);
127
128GArray * atspi_text_get_bounded_ranges (AtspiText *obj, gint x, gint y, gint width, gint height, AtspiCoordType type, AtspiTextClipType clipTypeX, AtspiTextClipType clipTypeY, GError **error);
129
130gint atspi_text_get_n_selections (AtspiText *obj, GError **error);
131
132AtspiRange * atspi_text_get_selection (AtspiText *obj, gint selection_num, GError **error);
133
134gboolean atspi_text_add_selection (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
135
136gboolean atspi_text_remove_selection (AtspiText *obj, gint selection_num, GError **error);
137
138gboolean atspi_text_set_selection (AtspiText *obj, gint selection_num, gint start_offset, gint end_offset, GError **error);
139
140gboolean atspi_text_scroll_substring_to (AtspiText *obj, gint start_offset, gint end_offset, AtspiScrollType type, GError **error);
141
142gboolean atspi_text_scroll_substring_to_point (AtspiText *obj, gint start_offset, gint end_offset, AtspiCoordType coords, gint x, gint y, GError **error);
143G_END_DECLS
144
145#endif /* _ATSPI_TEXT_H_ */
146

source code of include/at-spi-2.0/atspi/atspi-text.h