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 <glib-object.h>
  25 #include <atk/atkobject.h>
  26 #include <atk/atkutil.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32 /**
  33  * AtkAttributeSet:
  34  *
  35  * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
  36  * used by atk_text_get_run_attributes(), atk_text_get_default_attributes()
  37  * and atk_editable_text_set_run_attributes()
  38  **/
  39 typedef GSList AtkAttributeSet;
  40
  41 /**
  42  * AtkAttribute:
  43  * @name: The attribute name. Call atk_text_attr_get_name()
  44  * @value: the value of the attribute, represented as a string.
  45  * Call atk_text_attr_get_value() for those which are strings.
  46  * For values which are numbers, the string representation of the number
  47  * is in value.
  48  *
  49  * A string name/value pair representing a text attribute.
  50  **/
  51 typedef struct _AtkAttribute AtkAttribute;
  52
  53 struct _AtkAttribute {
  54   gchar* name;
  55   gchar* value;
  56 };
  57
  58 /**
  59  *AtkTextAttribute
  60  *@ATK_TEXT_ATTR_INVALID: Invalid attribute
  61  *@ATK_TEXT_ATTR_LEFT_MARGIN: The pixel width of the left margin
  62  *@ATK_TEXT_ATTR_RIGHT_MARGIN: The pixel width of the right margin
  63  *@ATK_TEXT_ATTR_INDENT: The number of pixels that the text is indented
  64  *@ATK_TEXT_ATTR_INVISIBLE: Either "true" or "false" indicating whether text is visible or not
  65  *@ATK_TEXT_ATTR_EDITABLE: Either "true" or "false" indicating whether text is editable or not
  66  *@ATK_TEXT_ATTR_PIXELS_ABOVE_LINES: Pixels of blank space to leave above each newline-terminated line.
  67  *@ATK_TEXT_ATTR_PIXELS_BELOW_LINES: Pixels of blank space to leave below each newline-terminated line.
  68  *@ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP: Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).
  69  *@ATK_TEXT_ATTR_BG_FULL_HEIGHT: "true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.
  70  *@ATK_TEXT_ATTR_RISE: Number of pixels that the characters are risen above the baseline
  71  *@ATK_TEXT_ATTR_UNDERLINE: "none", "single", "double" or "low"
  72  *@ATK_TEXT_ATTR_STRIKETHROUGH: "true" or "false" whether the text is strikethrough
  73  *@ATK_TEXT_ATTR_SIZE: The size of the characters.
  74  *@ATK_TEXT_ATTR_SCALE: The scale of the characters. The value is a string representation of a double
  75  *@ATK_TEXT_ATTR_WEIGHT: The weight of the characters.
  76  *@ATK_TEXT_ATTR_LANGUAGE: The language used
  77  *@ATK_TEXT_ATTR_FAMILY_NAME: The font family name
  78  *@ATK_TEXT_ATTR_BG_COLOR: The background color. The value is an RGB value of the format "%u,%u,%u"
  79  *@ATK_TEXT_ATTR_FG_COLOR:The foreground color. The value is an RGB value of the format "%u,%u,%u"
  80  *@ATK_TEXT_ATTR_BG_STIPPLE: "true" if a #GdkBitmap is set for stippling the background color.
  81  *@ATK_TEXT_ATTR_FG_STIPPLE: "true" if a #GdkBitmap is set for stippling the foreground color.
  82  *@ATK_TEXT_ATTR_WRAP_MODE: The wrap mode of the text, if any. Values are "none", "char" or "word"
  83  *@ATK_TEXT_ATTR_DIRECTION: The direction of the text, if set. Values are "none", "ltr" or "rtl"
  84  *@ATK_TEXT_ATTR_JUSTIFICATION: The justification of the text, if set. Values are "left", "right", "center" or "fill"
  85  *@ATK_TEXT_ATTR_STRETCH: The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded"
  86  *@ATK_TEXT_ATTR_VARIANT: The capitalization variant of the text, if set. Values are "normal" or "small_caps"
  87  *@ATK_TEXT_ATTR_STYLE: The slant style of the text, if set. Values are "normal", "oblique" or "italic"
  88  *@ATK_TEXT_ATTR_LAST_DEFINED: not a valid text attribute, used for finding end of enumeration
  89  *
  90  * Describes the text attributes supported
  91  **/
  92 typedef enum
  93 {
  94   ATK_TEXT_ATTR_INVALID = 0,
  95   ATK_TEXT_ATTR_LEFT_MARGIN,
  96   ATK_TEXT_ATTR_RIGHT_MARGIN,
  97   ATK_TEXT_ATTR_INDENT,
  98   ATK_TEXT_ATTR_INVISIBLE,
  99   ATK_TEXT_ATTR_EDITABLE,
 100   ATK_TEXT_ATTR_PIXELS_ABOVE_LINES,
 101   ATK_TEXT_ATTR_PIXELS_BELOW_LINES,
 102   ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP,
 103   ATK_TEXT_ATTR_BG_FULL_HEIGHT,
 104   ATK_TEXT_ATTR_RISE,
 105   ATK_TEXT_ATTR_UNDERLINE,
 106   ATK_TEXT_ATTR_STRIKETHROUGH,
 107   ATK_TEXT_ATTR_SIZE,
 108   ATK_TEXT_ATTR_SCALE,
 109   ATK_TEXT_ATTR_WEIGHT,
 110   ATK_TEXT_ATTR_LANGUAGE,
 111   ATK_TEXT_ATTR_FAMILY_NAME,
 112   ATK_TEXT_ATTR_BG_COLOR,
 113   ATK_TEXT_ATTR_FG_COLOR,
 114   ATK_TEXT_ATTR_BG_STIPPLE,
 115   ATK_TEXT_ATTR_FG_STIPPLE,
 116   ATK_TEXT_ATTR_WRAP_MODE,
 117   ATK_TEXT_ATTR_DIRECTION,
 118   ATK_TEXT_ATTR_JUSTIFICATION,
 119   ATK_TEXT_ATTR_STRETCH,
 120   ATK_TEXT_ATTR_VARIANT,
 121   ATK_TEXT_ATTR_STYLE,
 122   ATK_TEXT_ATTR_LAST_DEFINED
 123 } AtkTextAttribute;
 124
 125 AtkTextAttribute         atk_text_attribute_register   (const gchar *name);
 126
 127
 128 #define ATK_TYPE_TEXT                    (atk_text_get_type ())
 129 #define ATK_IS_TEXT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_TEXT)
 130 #define ATK_TEXT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_TEXT, AtkText)
 131 #define ATK_TEXT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_TEXT, AtkTextIface))
 132
 133 #ifndef _TYPEDEF_ATK_TEXT_
 134 #define _TYPEDEF_ATK_TEXT_
 135 typedef struct _AtkText AtkText;
 136 #endif
 137 typedef struct _AtkTextIface AtkTextIface;
 138
 139 /**
 140  *AtkTextBoundary:
 141  *@ATK_TEXT_BOUNDARY_CHAR:
 142  *@ATK_TEXT_BOUNDARY_WORD_START:
 143  *@ATK_TEXT_BOUNDARY_WORD_END:
 144  *@ATK_TEXT_BOUNDARY_SENTENCE_START:
 145  *@ATK_TEXT_BOUNDARY_SENTENCE_END:
 146  *@ATK_TEXT_BOUNDARY_LINE_START:
 147  *@ATK_TEXT_BOUNDARY_LINE_END:
 148  *
 149  *Text boundary types used for specifying boundaries for regions of text
 150  **/
 151 typedef enum {
 152   ATK_TEXT_BOUNDARY_CHAR,
 153   ATK_TEXT_BOUNDARY_WORD_START,
 154   ATK_TEXT_BOUNDARY_WORD_END,
 155   ATK_TEXT_BOUNDARY_SENTENCE_START,
 156   ATK_TEXT_BOUNDARY_SENTENCE_END,
 157   ATK_TEXT_BOUNDARY_LINE_START,
 158   ATK_TEXT_BOUNDARY_LINE_END
 159 } AtkTextBoundary;
 160
 161 struct _AtkTextIface
 162 {
 163   GTypeInterface parent;
 164
 165   gchar*         (* get_text)                     (AtkText          *text,
 166                                                    gint             start_offset,
 167                                                    gint             end_offset);
 168   gchar*         (* get_text_after_offset)        (AtkText          *text,
 169                                                    gint             offset,
 170                                                    AtkTextBoundary  boundary_type,
 171                                                    gint             *start_offset,
 172                                                    gint             *end_offset);
 173   gchar*         (* get_text_at_offset)           (AtkText          *text,
 174                                                    gint             offset,
 175                                                    AtkTextBoundary  boundary_type,
 176                                                    gint             *start_offset,
 177                                                    gint             *end_offset);
 178   gunichar       (* get_character_at_offset)      (AtkText          *text,
 179                                                    gint             offset);
 180   gchar*         (* get_text_before_offset)       (AtkText          *text,
 181                                                    gint             offset,
 182                                                    AtkTextBoundary  boundary_type,
 183                                                    gint             *start_offset,
 184                                                    gint             *end_offset);
 185   gint           (* get_caret_offset)             (AtkText          *text);
 186   AtkAttributeSet* (* get_run_attributes)         (AtkText          *text,
 187                                                    gint             offset,
 188                                                    gint             *start_offset,
 189                                                    gint             *end_offset);
 190   AtkAttributeSet* (* get_default_attributes)     (AtkText          *text);
 191   void           (* get_character_extents)        (AtkText          *text,
 192                                                    gint             offset,
 193                                                    gint             *x,
 194                                                    gint             *y,
 195                                                    gint             *width,
 196                                                    gint             *height,
 197                                                    AtkCoordType     coords);
 198   gint           (* get_character_count)          (AtkText          *text);
 199   gint           (* get_offset_at_point)          (AtkText          *text,
 200                                                    gint             x,
 201                                                    gint             y,
 202                                                    AtkCoordType     coords);
 203   gint           (* get_n_selections)             (AtkText          *text);
 204   gchar*         (* get_selection)                (AtkText          *text,
 205                                                    gint             selection_num,
 206                                                    gint             *start_offset,
 207                                                    gint             *end_offset);
 208   gboolean       (* add_selection)                (AtkText          *text,
 209                                                    gint             start_offset,
 210                                                    gint             end_offset);
 211   gboolean       (* remove_selection)             (AtkText          *text,
 212                                                    gint             selection_num);
 213   gboolean       (* set_selection)                (AtkText          *text,
 214                                                    gint             selection_num,
 215                                                    gint             start_offset,
 216                                                    gint             end_offset);
 217   gboolean       (* set_caret_offset)             (AtkText          *text,
 218                                                    gint             offset);
 219
 220   /*
 221    * signal handlers
 222    */
 223   void           (* text_changed)                 (AtkText          *text,
 224                                                    gint             position,
 225                                                    gint             length);
 226   void           (* text_caret_moved)             (AtkText          *text,
 227                                                    gint             location);
 228   void           (* text_selection_changed)       (AtkText          *text);
 229
 230   void           (* text_attributes_changed)      (AtkText          *text);
 231
 232   AtkFunction    pad2;
 233   AtkFunction    pad3;
 234   AtkFunction    pad4;
 235 };
 236
 237 GType            atk_text_get_type (void);
 238
 239
 240 /*
 241  * Additional AtkObject properties used by AtkText:
 242  *    "accessible_text" (accessible text has changed)
 243  *    "accessible_caret" (accessible text cursor position changed:
 244  *                         editable text only)
 245  */
 246
 247 gchar*        atk_text_get_text                           (AtkText          *text,
 248                                                            gint             start_offset,
 249                                                            gint             end_offset);
 250 gunichar      atk_text_get_character_at_offset            (AtkText          *text,
 251                                                            gint             offset);
 252 gchar*        atk_text_get_text_after_offset              (AtkText          *text,
 253                                                            gint             offset,
 254                                                            AtkTextBoundary  boundary_type,
 255                                                            gint             *start_offset,
 256                                                            gint             *end_offset);
 257 gchar*        atk_text_get_text_at_offset                 (AtkText          *text,
 258                                                            gint             offset,
 259                                                            AtkTextBoundary  boundary_type,
 260                                                            gint             *start_offset,
 261                                                            gint             *end_offset);
 262 gchar*        atk_text_get_text_before_offset             (AtkText          *text,
 263                                                            gint             offset,
 264                                                            AtkTextBoundary  boundary_type,
 265                                                            gint             *start_offset,
 266                                                            gint             *end_offset);
 267 gint          atk_text_get_caret_offset                   (AtkText          *text);
 268 void          atk_text_get_character_extents              (AtkText          *text,
 269                                                            gint             offset,
 270                                                            gint             *x,
 271                                                            gint             *y,
 272                                                            gint             *width,
 273                                                            gint             *height,
 274                                                            AtkCoordType     coords);
 275 AtkAttributeSet* atk_text_get_run_attributes              (AtkText          *text,
 276                                                            gint             offset,
 277                                                            gint             *start_offset,
 278                                                            gint             *end_offset);
 279 AtkAttributeSet* atk_text_get_default_attributes          (AtkText          *text);
 280 gint          atk_text_get_character_count                (AtkText          *text);
 281 gint          atk_text_get_offset_at_point                (AtkText          *text,
 282                                                            gint             x,
 283                                                            gint             y,
 284                                                            AtkCoordType     coords);
 285 gint          atk_text_get_n_selections                   (AtkText          *text);
 286 gchar*        atk_text_get_selection                      (AtkText          *text,
 287                                                            gint             selection_num,
 288                                                            gint             *start_offset,
 289                                                            gint             *end_offset);
 290 gboolean      atk_text_add_selection                      (AtkText          *text,
 291                                                            gint             start_offset,
 292                                                            gint             end_offset);
 293 gboolean      atk_text_remove_selection                   (AtkText          *text,
 294                                                            gint             selection_num);
 295 gboolean      atk_text_set_selection                      (AtkText          *text,
 296                                                            gint             selection_num,
 297                                                            gint             start_offset,
 298                                                            gint             end_offset);
 299 gboolean      atk_text_set_caret_offset                   (AtkText          *text,
 300                                                            gint             offset);
 301 void          atk_attribute_set_free                      (AtkAttributeSet  *attrib_set);
 302 G_CONST_RETURN gchar*  atk_text_attribute_get_name        (AtkTextAttribute attr);
 303 AtkTextAttribute       atk_text_attribute_for_name        (const gchar      *name);
 304 G_CONST_RETURN gchar*  atk_text_attribute_get_value       (AtkTextAttribute attr,
 305                                                            gint             index);
 306
 307 #ifdef __cplusplus
 308 }
 309 #endif /* __cplusplus */
 310
 311
 312 #endif /* __ATK_TEXT_H__ */