atk/atktext.h

   1 /* ATK - The Accessibility Toolkit for GTK+
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20
  21 #ifndef __ATK_TEXT_H__
  22 #define __ATK_TEXT_H__
  23
  24 #include <pango/pango.h>
  25 #include <glib-object.h>
  26 #include <atk/atkobject.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32 #define ATK_TYPE_TEXT                    (atk_text_get_type ())
  33 #define ATK_IS_TEXT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_TEXT)
  34 #define ATK_TEXT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_TEXT, AtkText)
  35 #define ATK_TEXT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_TEXT, AtkTextIface))
  36
  37 #ifndef _TYPEDEF_ATK_TEXT_
  38 #define _TYPEDEF_ATK_TEXT_
  39 typedef struct _AtkText AtkText;
  40 #endif
  41 typedef struct _AtkTextIface AtkTextIface;
  42
  43 /**
  44  *AtkTextBoundary:
  45  *@ATK_TEXT_BOUNDARY_CHAR:
  46  *@ATK_TEXT_BOUNDARY_CURSOR_POS:
  47  *@ATK_TEXT_BOUNDARY_WORD_START:
  48  *@ATK_TEXT_BOUNDARY_WORD_END:
  49  *@ATK_TEXT_BOUNDARY_SENTENCE_START:
  50  *@ATK_TEXT_BOUNDARY_SENTENCE_END:
  51  *@ATK_TEXT_BOUNDARY_LINE_START:
  52  *@ATK_TEXT_BOUNDARY_LINE_END:
  53  *
  54  *Text boundary types used for specifying boundaries for regions of text
  55  **/
  56 typedef enum {
  57   ATK_TEXT_BOUNDARY_CHAR,
  58   ATK_TEXT_BOUNDARY_CURSOR_POS,
  59   ATK_TEXT_BOUNDARY_WORD_START,
  60   ATK_TEXT_BOUNDARY_WORD_END,
  61   ATK_TEXT_BOUNDARY_SENTENCE_START,
  62   ATK_TEXT_BOUNDARY_SENTENCE_END,
  63   ATK_TEXT_BOUNDARY_LINE_START,
  64   ATK_TEXT_BOUNDARY_LINE_END
  65 } AtkTextBoundary;
  66
  67 struct _AtkTextIface
  68 {
  69   GTypeInterface parent;
  70
  71   gchar*         (* get_text)                     (AtkText          *text,
  72                                                    gint             start_offset,
  73                                                    gint             end_offset);
  74   gchar*         (* get_text_after_offset)        (AtkText          *text,
  75                                                    gint             offset,
  76                                                    AtkTextBoundary  boundary_type);
  77   gchar*         (* get_text_at_offset)           (AtkText          *text,
  78                                                    gint             offset,
  79                                                    AtkTextBoundary  boundary_type);
  80   gunichar       (* get_character_at_offset)      (AtkText          *text,
  81                                                    gint             offset);
  82   gchar*         (* get_text_before_offset)       (AtkText          *text,
  83                                                    gint             offset,
  84                                                    AtkTextBoundary  boundary_type);
  85   gint           (* get_caret_offset)             (AtkText          *text);
  86   PangoAttrList* (* get_range_attributes)         (AtkText          *text,
  87                                                    gint             start_offset,
  88                                                    gint             end_offset);
  89   void           (* get_character_extents)        (AtkText          *text,
  90                                                    gint             offset,
  91                                                    gint             *x,
  92                                                    gint             *y,
  93                                                    gint             *length,
  94                                                    gint             *width);
  95   gint           (* get_character_count)          (AtkText          *text);
  96   gint           (* get_offset_at_point)          (AtkText          *text,
  97                                                    gint             x,
  98                                                    gint             y);
  99   gint           (* get_n_selections)             (AtkText          *text);
 100   gchar*         (* get_selection)                (AtkText          *text,
 101                                                    gint             selection_num,
 102                                                    gint             *start_offset,
 103                                                    gint             *end_offset);
 104   gboolean       (* add_selection)                (AtkText          *text,
 105                                                    gint             start_offset,
 106                                                    gint             end_offset);
 107   gboolean       (* remove_selection)             (AtkText          *text,
 108                                                    gint             selection_num);
 109   gboolean       (* set_selection)                (AtkText          *text,
 110                                                    gint             selection_num,
 111                                                    gint             start_offset,
 112                                                    gint             end_offset);
 113   gboolean       (* set_caret_offset)             (AtkText          *text,
 114                                                    gint             offset);
 115   void           (* text_changed)                 (AtkText          *text);
 116   void           (* caret_changed)                (AtkText          *text,
 117                                                    gint             location);
 118 };
 119 GType            atk_text_get_type (void);
 120
 121
 122 /*
 123  * Additional AtkObject properties used by AtkText:
 124  *    "accessible_text" (accessible text has changed)
 125  *    "accessible_caret" (accessible text cursor position changed:
 126  *                         editable text only)
 127  */
 128
 129 gchar*        atk_text_get_text                           (AtkText          *text,
 130                                                            gint             start_offset,
 131                                                            gint             end_offset);
 132 gunichar      atk_text_get_character_at_offset            (AtkText          *text,
 133                                                            gint             offset);
 134 gchar*        atk_text_get_text_after_offset              (AtkText          *text,
 135                                                            gint             offset,
 136                                                            AtkTextBoundary  boundary_type);
 137 gchar*        atk_text_get_text_at_offset                 (AtkText          *text,
 138                                                            gint             offset,
 139                                                            AtkTextBoundary  boundary_type);
 140 gchar*        atk_text_get_text_before_offset             (AtkText          *text,
 141                                                            gint             offset,
 142                                                            AtkTextBoundary  boundary_type);
 143 gint          atk_text_get_caret_offset                   (AtkText          *text);
 144 PangoAttrList* atk_text_get_range_attributes              (AtkText          *text,
 145                                                            gint             start_offset,
 146                                                            gint             end_offset);
 147 void          atk_text_get_character_extents              (AtkText          *text,
 148                                                            gint             offset,
 149                                                            gint             *x,
 150                                                            gint             *y,
 151                                                            gint             *length,
 152                                                            gint             *width);
 153 gint          atk_text_get_character_count                (AtkText          *text);
 154 gint          atk_text_get_offset_at_point                (AtkText          *text,
 155                                                            gint             x,
 156                                                            gint             y);
 157 gint          atk_text_get_n_selections                   (AtkText          *text);
 158 gchar*        atk_text_get_selection                      (AtkText          *text,
 159                                                            gint             selection_num,
 160                                                            gint             *start_offset,
 161                                                            gint             *end_offset);
 162 gboolean      atk_text_add_selection                      (AtkText          *text,
 163                                                            gint             start_offset,
 164                                                            gint             end_offset);
 165 gboolean      atk_text_remove_selection                   (AtkText          *text,
 166                                                            gint             selection_num);
 167 gboolean      atk_text_set_selection                      (AtkText          *text,
 168                                                            gint             selection_num,
 169                                                            gint             start_offset,
 170                                                            gint             end_offset);
 171 gboolean      atk_text_set_caret_offset                   (AtkText          *text,
 172                                                            gint             offset);
 173
 174 #ifdef __cplusplus
 175 }
 176 #endif /* __cplusplus */
 177
 178
 179 #endif /* __ATK_TEXT_H__ */