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 /**
  45  *AtkXYCoords:
  46  *@ATK_XY_SCREEN: specifies xy coordinates relative to the screen
  47  *@ATK_XY_WIDGET: specifies xy coordinates relative to the widgets window
  48  *
  49  *Specifies what type of coordinates are to be returned for functions that
  50  *return position coordinates
  51  **/
  52 typedef enum {
  53   ATK_XY_SCREEN,
  54   ATK_XY_WIDGET
  55 }AtkXYCoords;
  56
  57 /**
  58  *AtkTextBoundary:
  59  *@ATK_TEXT_BOUNDARY_CHAR:
  60  *@ATK_TEXT_BOUNDARY_CURSOR_POS:
  61  *@ATK_TEXT_BOUNDARY_WORD_START:
  62  *@ATK_TEXT_BOUNDARY_WORD_END:
  63  *@ATK_TEXT_BOUNDARY_SENTENCE_START:
  64  *@ATK_TEXT_BOUNDARY_SENTENCE_END:
  65  *@ATK_TEXT_BOUNDARY_LINE_START:
  66  *@ATK_TEXT_BOUNDARY_LINE_END:
  67  *
  68  *Text boundary types used for specifying boundaries for regions of text
  69  **/
  70 typedef enum {
  71   ATK_TEXT_BOUNDARY_CHAR,
  72   ATK_TEXT_BOUNDARY_CURSOR_POS,
  73   ATK_TEXT_BOUNDARY_WORD_START,
  74   ATK_TEXT_BOUNDARY_WORD_END,
  75   ATK_TEXT_BOUNDARY_SENTENCE_START,
  76   ATK_TEXT_BOUNDARY_SENTENCE_END,
  77   ATK_TEXT_BOUNDARY_LINE_START,
  78   ATK_TEXT_BOUNDARY_LINE_END
  79 } AtkTextBoundary;
  80
  81 struct _AtkTextIface
  82 {
  83   GTypeInterface parent;
  84
  85   gchar*         (* get_text)                     (AtkText          *text,
  86                                                    gint             start_offset,
  87                                                    gint             end_offset);
  88   gchar*         (* get_text_after_offset)        (AtkText          *text,
  89                                                    gint             offset,
  90                                                    AtkTextBoundary  boundary_type,
  91                                                    gint             *startOffset,
  92                                                    gint             *endOffset);
  93   gchar*         (* get_text_at_offset)           (AtkText          *text,
  94                                                    gint             offset,
  95                                                    AtkTextBoundary  boundary_type,
  96                                                    gint             *startOffset,
  97                                                    gint             *endOffset);
  98   gunichar       (* get_character_at_offset)      (AtkText          *text,
  99                                                    gint             offset);
 100   gchar*         (* get_text_before_offset)       (AtkText          *text,
 101                                                    gint             offset,
 102                                                    AtkTextBoundary  boundary_type,
 103                                                    gint             *startOffset,
 104                                                    gint             *endOffset);
 105   gint           (* get_caret_offset)             (AtkText          *text);
 106   AtkAttributeSet* (* ref_run_attributes)         (AtkText          *text,
 107                                                    gint             offset,
 108                                                    gint             *start_offset,
 109                                                    gint             *end_offset);
 110   void           (* get_character_extents)        (AtkText          *text,
 111                                                    gint             offset,
 112                                                    gint             *x,
 113                                                    gint             *y,
 114                                                    gint             *length,
 115                                                    gint             *width,
 116                                                    AtkXYCoords      coords);
 117   gint           (* get_character_count)          (AtkText          *text);
 118   gint           (* get_offset_at_point)          (AtkText          *text,
 119                                                    gint             x,
 120                                                    gint             y,
 121                                                    AtkXYCoords      coords);
 122   gint           (* get_n_selections)             (AtkText          *text);
 123   gchar*         (* get_selection)                (AtkText          *text,
 124                                                    gint             selection_num,
 125                                                    gint             *start_offset,
 126                                                    gint             *end_offset);
 127   gboolean       (* add_selection)                (AtkText          *text,
 128                                                    gint             start_offset,
 129                                                    gint             end_offset);
 130   gboolean       (* remove_selection)             (AtkText          *text,
 131                                                    gint             selection_num);
 132   gboolean       (* set_selection)                (AtkText          *text,
 133                                                    gint             selection_num,
 134                                                    gint             start_offset,
 135                                                    gint             end_offset);
 136   gboolean       (* set_caret_offset)             (AtkText          *text,
 137                                                    gint             offset);
 138   void           (* text_changed)                 (AtkText          *text);
 139   void           (* caret_changed)                (AtkText          *text,
 140                                                    gint             location);
 141 };
 142 GType            atk_text_get_type (void);
 143
 144
 145 /*
 146  * Additional AtkObject properties used by AtkText:
 147  *    "accessible_text" (accessible text has changed)
 148  *    "accessible_caret" (accessible text cursor position changed:
 149  *                         editable text only)
 150  */
 151
 152 gchar*        atk_text_get_text                           (AtkText          *text,
 153                                                            gint             start_offset,
 154                                                            gint             end_offset);
 155 gunichar      atk_text_get_character_at_offset            (AtkText          *text,
 156                                                            gint             offset);
 157 gchar*        atk_text_get_text_after_offset              (AtkText          *text,
 158                                                            gint             offset,
 159                                                            AtkTextBoundary  boundary_type,
 160                                                            gint             *startOffset,
 161                                                            gint             *endOffset);
 162 gchar*        atk_text_get_text_at_offset                 (AtkText          *text,
 163                                                            gint             offset,
 164                                                            AtkTextBoundary  boundary_type,
 165                                                            gint             *startOffset,
 166                                                            gint             *endOffset);
 167 gchar*        atk_text_get_text_before_offset             (AtkText          *text,
 168                                                            gint             offset,
 169                                                            AtkTextBoundary  boundary_type,
 170                                                            gint             *startOffset,
 171                                                            gint             *endOffset);
 172 gint          atk_text_get_caret_offset                   (AtkText          *text);
 173 void          atk_text_get_character_extents              (AtkText          *text,
 174                                                            gint             offset,
 175                                                            gint             *x,
 176                                                            gint             *y,
 177                                                            gint             *length,
 178                                                            gint             *width,
 179                                                            AtkXYCoords      coords);
 180 AtkAttributeSet* atk_text_ref_run_attributes              (AtkText          *text,
 181                                                            gint             offset,
 182                                                            gint             *start_offset,
 183                                                            gint             *end_offset);
 184 gint          atk_text_get_character_count                (AtkText          *text);
 185 gint          atk_text_get_offset_at_point                (AtkText          *text,
 186                                                            gint             x,
 187                                                            gint             y,
 188                                                            AtkXYCoords      coords);
 189 gint          atk_text_get_n_selections                   (AtkText          *text);
 190 gchar*        atk_text_get_selection                      (AtkText          *text,
 191                                                            gint             selection_num,
 192                                                            gint             *start_offset,
 193                                                            gint             *end_offset);
 194 gboolean      atk_text_add_selection                      (AtkText          *text,
 195                                                            gint             start_offset,
 196                                                            gint             end_offset);
 197 gboolean      atk_text_remove_selection                   (AtkText          *text,
 198                                                            gint             selection_num);
 199 gboolean      atk_text_set_selection                      (AtkText          *text,
 200                                                            gint             selection_num,
 201                                                            gint             start_offset,
 202                                                            gint             end_offset);
 203 gboolean      atk_text_set_caret_offset                   (AtkText          *text,
 204                                                            gint             offset);
 205
 206 #ifdef __cplusplus
 207 }
 208 #endif /* __cplusplus */
 209
 210
 211 #endif /* __ATK_TEXT_H__ */