atspi/atspi-text.h

   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 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.
  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  * Library General Public License for more details.
  19  *
  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.
  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
  35 G_BEGIN_DECLS
  36
  37 typedef struct _AtspiRange AtspiRange;
  38 struct _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
  51 GType atspi_range_get_type ();
  52
  53 AtspiRange *
  54 atspi_range_copy (AtspiRange *src);
  55
  56 typedef struct _AtspiTextRange AtspiTextRange;
  57 struct _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
  76 GType atspi_text_get_type ();
  77
  78 struct _AtspiText
  79 {
  80   GTypeInterface parent;
  81 };
  82
  83
  84 GType atspi_text_range_get_type ();
  85
  86 gint atspi_text_get_character_count (AtspiText *obj, GError **error);
  87
  88 gchar * atspi_text_get_text (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
  89
  90 gint atspi_text_get_caret_offset (AtspiText *obj, GError **error);
  91
  92 #ifndef ATSPI_DISABLE_DEPRECATED
  93 GHashTable *atspi_text_get_attributes (AtspiText *obj, gint offset, gint *start_offset, gint *end_offset, GError **error);
  94 #endif
  95
  96 GHashTable *atspi_text_get_text_attributes (AtspiText *obj, gint offset, gint *start_offset, gint *end_offset, GError **error);
  97
  98 GHashTable *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
 101 gchar * atspi_text_get_attribute_value (AtspiText *obj, gint offset, gchar *attribute_name, GError **error);
 102 #endif
 103
 104 gchar * atspi_text_get_text_attribute_value (AtspiText *obj, gint offset, gchar *attribute_name, GError **error);
 105
 106 GHashTable * atspi_text_get_default_attributes (AtspiText *obj, GError **error);
 107
 108 gboolean atspi_text_set_caret_offset (AtspiText *obj, gint new_offset, GError **error);
 109
 110 AtspiTextRange * atspi_text_get_text_before_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
 111
 112 AtspiTextRange * atspi_text_get_string_at_offset (AtspiText *obj, gint offset, AtspiTextGranularity granularity, GError **error);
 113
 114 #ifndef ATSPI_DISABLE_DEPRECATED
 115 AtspiTextRange * atspi_text_get_text_at_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
 116 #endif
 117
 118 AtspiTextRange * atspi_text_get_text_after_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
 119
 120 guint atspi_text_get_character_at_offset (AtspiText *obj, gint offset, GError **error);
 121
 122 AtspiRect * atspi_text_get_character_extents (AtspiText *obj, gint offset, AtspiCoordType type, GError **error);
 123
 124 gint atspi_text_get_offset_at_point (AtspiText *obj, gint x, gint y, AtspiCoordType type, GError **error);
 125
 126 AtspiRect * atspi_text_get_range_extents (AtspiText *obj, gint start_offset, gint end_offset, AtspiCoordType type, GError **error);
 127
 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);
 129
 130 gint atspi_text_get_n_selections (AtspiText *obj, GError **error);
 131
 132 AtspiRange * atspi_text_get_selection (AtspiText *obj, gint selection_num, GError **error);
 133
 134 gboolean atspi_text_add_selection (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
 135
 136 gboolean atspi_text_remove_selection (AtspiText *obj, gint selection_num, GError **error);
 137
 138 gboolean atspi_text_set_selection (AtspiText *obj, gint selection_num, gint start_offset, gint end_offset, GError **error);
 139
 140 G_END_DECLS
 141
 142 #endif  /* _ATSPI_TEXT_H_ */