at-spi-2.0/atspi/atspi-text.h

0001 /*
0002  * AT-SPI - Assistive Technology Service Provider Interface
0003  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
0004  *
0005  * Copyright 2002 Ximian, Inc.
0006  *           2002 Sun Microsystems Inc.
0007  * Copyright 2010, 2011 Novell, Inc.
0008  *
0009  *
0010  * This library is free software; you can redistribute it and/or
0011  * modify it under the terms of the GNU Lesser General Public
0012  * License as published by the Free Software Foundation; either
0013  * version 2.1 of the License, or (at your option) any later version.
0014  *
0015  * This library is distributed in the hope that it will be useful,
0016  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0018  * Lesser General Public License for more details.
0019  *
0020  * You should have received a copy of the GNU Lesser General Public
0021  * License along with this library; if not, write to the
0022  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0023  * Boston, MA 02110-1301, USA.
0024  */
0025
0026 #ifndef _ATSPI_TEXT_H_
0027 #define _ATSPI_TEXT_H_
0028
0029 #include "glib-object.h"
0030
0031 #include "atspi-constants.h"
0032
0033 #include "atspi-types.h"
0034
0035 G_BEGIN_DECLS
0036
0037 typedef struct _AtspiRange AtspiRange;
0038 struct _AtspiRange
0039 {
0040   gint start_offset;
0041   gint end_offset;
0042 };
0043
0044 /**
0045  * ATSPI_TYPE_RANGE:
0046  *
0047  * The #GType for a boxed type holding a range within a text bock.
0048  */
0049 #define ATSPI_TYPE_RANGE atspi_range_get_type ()
0050
0051 GType atspi_range_get_type ();
0052
0053 AtspiRange *
0054 atspi_range_copy (AtspiRange *src);
0055
0056 typedef struct _AtspiTextRange AtspiTextRange;
0057 struct _AtspiTextRange
0058 {
0059   gint start_offset;
0060   gint end_offset;
0061   gchar *content;
0062 };
0063
0064 /**
0065  * ATSPI_TYPE_TEXT_RANGE:
0066  *
0067  * The #GType for a boxed type holding a range within a text bock.
0068  */
0069 #define ATSPI_TYPE_TEXT_RANGE atspi_text_range_get_type ()
0070
0071 #define ATSPI_TYPE_TEXT (atspi_text_get_type ())
0072 #define ATSPI_IS_TEXT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_TEXT)
0073 #define ATSPI_TEXT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_TEXT, AtspiText)
0074 #define ATSPI_TEXT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATSPI_TYPE_TEXT, AtspiText))
0075
0076 GType atspi_text_get_type ();
0077
0078 struct _AtspiText
0079 {
0080   GTypeInterface parent;
0081 };
0082
0083 GType atspi_text_range_get_type ();
0084
0085 gint atspi_text_get_character_count (AtspiText *obj, GError **error);
0086
0087 gchar *atspi_text_get_text (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
0088
0089 gint atspi_text_get_caret_offset (AtspiText *obj, GError **error);
0090
0091 #ifndef ATSPI_DISABLE_DEPRECATED
0092 GHashTable *atspi_text_get_attributes (AtspiText *obj, gint offset, gint *start_offset, gint *end_offset, GError **error);
0093 #endif
0094
0095 GHashTable *atspi_text_get_text_attributes (AtspiText *obj, gint offset, gint *start_offset, gint *end_offset, GError **error);
0096
0097 GHashTable *atspi_text_get_attribute_run (AtspiText *obj, gint offset, gboolean include_defaults, gint *start_offset, gint *end_offset, GError **error);
0098
0099 #ifndef ATSPI_DISABLE_DEPRECATED
0100 gchar *atspi_text_get_attribute_value (AtspiText *obj, gint offset, const gchar *attribute_name, GError **error);
0101 #endif
0102
0103 gchar *atspi_text_get_text_attribute_value (AtspiText *obj, gint offset, const gchar *attribute_name, GError **error);
0104
0105 GHashTable *atspi_text_get_default_attributes (AtspiText *obj, GError **error);
0106
0107 gboolean atspi_text_set_caret_offset (AtspiText *obj, gint new_offset, GError **error);
0108
0109 #ifndef ATSPI_DISABLE_DEPRECATED
0110 AtspiTextRange *atspi_text_get_text_before_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
0111
0112 AtspiTextRange *atspi_text_get_text_at_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
0113
0114 AtspiTextRange *atspi_text_get_text_after_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
0115 #endif
0116
0117 AtspiTextRange *atspi_text_get_string_at_offset (AtspiText *obj, gint offset, AtspiTextGranularity granularity, GError **error);
0118
0119 guint atspi_text_get_character_at_offset (AtspiText *obj, gint offset, GError **error);
0120
0121 AtspiRect *atspi_text_get_character_extents (AtspiText *obj, gint offset, AtspiCoordType type, GError **error);
0122
0123 gint atspi_text_get_offset_at_point (AtspiText *obj, gint x, gint y, AtspiCoordType type, GError **error);
0124
0125 AtspiRect *atspi_text_get_range_extents (AtspiText *obj, gint start_offset, gint end_offset, AtspiCoordType type, GError **error);
0126
0127 GArray *atspi_text_get_bounded_ranges (AtspiText *obj, gint x, gint y, gint width, gint height, AtspiCoordType type, AtspiTextClipType clipTypeX, AtspiTextClipType clipTypeY, GError **error);
0128
0129 gint atspi_text_get_n_selections (AtspiText *obj, GError **error);
0130
0131 AtspiRange *atspi_text_get_selection (AtspiText *obj, gint selection_num, GError **error);
0132
0133 gboolean atspi_text_add_selection (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
0134
0135 gboolean atspi_text_remove_selection (AtspiText *obj, gint selection_num, GError **error);
0136
0137 gboolean atspi_text_set_selection (AtspiText *obj, gint selection_num, gint start_offset, gint end_offset, GError **error);
0138
0139 gboolean atspi_text_scroll_substring_to (AtspiText *obj, gint start_offset, gint end_offset, AtspiScrollType type, GError **error);
0140
0141 gboolean atspi_text_scroll_substring_to_point (AtspiText *obj, gint start_offset, gint end_offset, AtspiCoordType coords, gint x, gint y, GError **error);
0142 G_END_DECLS
0143
0144 #endif /* _ATSPI_TEXT_H_ */