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  *
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  */
  24
  25 #ifndef _ATSPI_TEXT_H_
  26 #define _ATSPI_TEXT_H_
  27
  28 #include "glib-object.h"
  29
  30 #include "atspi-constants.h"
  31
  32 #include "atspi-types.h"
  33
  34 typedef struct _AtspiRange AtspiRange;
  35 struct _AtspiRange
  36 {
  37   gint start_offset;
  38   gint end_offset;
  39 };
  40
  41 /**
  42  * ATSPI_TYPE_RANGE:
  43  *
  44  * The #GType for a boxed type holding a range within a text bock.
  45  */
  46 #define ATSPI_TYPE_RANGE atspi_range_get_type ()
  47
  48 GType atspi_range_get_type ();
  49
  50 AtspiRange *
  51 atspi_range_copy (AtspiRange *src);
  52
  53 typedef struct _AtspiRangedAttributeSet AtspiRangedAttributeSet;
  54 struct _AtspiRangedAttributeSet
  55 {
  56   GHashTable *attributes;
  57   gint start_offset;
  58   gint end_offset;
  59 };
  60
  61 /**
  62  * ATSPI_TYPE_RANGED_ATTRIBUTE_SET:
  63  *
  64  * The #GType for a boxed type holding an attribute set within a text block.
  65  */
  66 #define ATSPI_TYPE_RANGED_ATTRIBUTE_SET atspi_ranged_attribute_set_get_type ()
  67
  68 GType atspi_ranged_attribute_set_get_type ();
  69
  70 typedef struct _AtspiTextRange AtspiTextRange;
  71 struct _AtspiTextRange
  72 {
  73   gint start_offset;
  74   gint end_offset;
  75   gchar *content;
  76 };
  77
  78 /**
  79  * ATSPI_TYPE_TEXT_RANGE:
  80  *
  81  * The #GType for a boxed type holding a range within a text bock.
  82  */
  83 #define ATSPI_TYPE_TEXT_RANGE atspi_text_range_get_type ()
  84
  85 #define ATSPI_TYPE_TEXT                    (atspi_text_get_type ())
  86 #define ATSPI_IS_TEXT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_TEXT)
  87 #define ATSPI_TEXT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_TEXT, AtspiText)
  88 #define ATSPI_TEXT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATSPI_TYPE_TEXT, AtspiText))
  89
  90 GType atspi_text_get_type ();
  91
  92 struct _AtspiText
  93 {
  94   GTypeInterface parent;
  95 };
  96
  97
  98 GType atspi_text_range_get_type ();
  99
 100 gint atspi_text_get_character_count (AtspiText *obj, GError **error);
 101
 102 gchar * atspi_text_get_text (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
 103
 104 gint atspi_text_get_caret_offset (AtspiText *obj, GError **error);
 105
 106 AtspiRangedAttributeSet * atspi_text_get_attributes (AtspiText *obj, gint offset, GError **error);
 107
 108 AtspiRangedAttributeSet * atspi_text_get_attribute_run (AtspiText *obj, gint offset, gboolean include_defaults, GError **error);
 109
 110 gchar * atspi_text_get_attribute_value (AtspiText *obj, gint offset, gchar *attribute_name, GError **error);
 111
 112 GHashTable * atspi_text_get_default_attributes (AtspiText *obj, GError **error);
 113
 114 gboolean atspi_text_set_caret_offset (AtspiText *obj, gint new_offset, GError **error);
 115
 116 AtspiTextRange * atspi_text_get_text_before_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
 117
 118 AtspiTextRange * atspi_text_get_text_at_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
 119
 120 AtspiTextRange * atspi_text_get_text_after_offset (AtspiText *obj, gint offset, AtspiTextBoundaryType type, GError **error);
 121
 122 guint atspi_text_get_character_at_offset (AtspiText *obj, gint offset, GError **error);
 123
 124 AtspiRect * atspi_text_get_character_extents (AtspiText *obj, gint offset, AtspiCoordType type, GError **error);
 125
 126 gint atspi_text_get_offset_at_point (AtspiText *obj, gint x, gint y, AtspiCoordType type, GError **error);
 127
 128 AtspiRect * atspi_text_get_range_extents (AtspiText *obj, gint start_offset, gint end_offset, AtspiCoordType type, GError **error);
 129
 130 GArray * atspi_text_get_bounded_ranges (AtspiText *obj, gint x, gint y, gint width, gint height, AtspiCoordType type, AtspiTextClipType clipTypeX, AtspiTextClipType clipTypeY, GError **error);
 131
 132 gint atspi_text_get_n_selections (AtspiText *obj, GError **error);
 133
 134 AtspiRange * atspi_text_get_selection (AtspiText *obj, gint selection_num, GError **error);
 135
 136 gboolean atspi_text_add_selection (AtspiText *obj, gint start_offset, gint end_offset, GError **error);
 137
 138 gboolean atspi_text_remove_selection (AtspiText *obj, gint selection_num, GError **error);
 139
 140 gboolean atspi_text_set_selection (AtspiText *obj, gint selection_num, gint start_offset, gint end_offset, GError **error);
 141 #endif  /* _ATSPI_TEXT_H_ */