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 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  21 #error "Only <atk/atk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __ATK_TEXT_H__
  25 #define __ATK_TEXT_H__
  26
  27 #include <glib-object.h>
  28 #include <atk/atkobject.h>
  29 #include <atk/atkutil.h>
  30
  31 G_BEGIN_DECLS
  32
  33 /**
  34  *AtkTextAttribute:
  35  *@ATK_TEXT_ATTR_INVALID: Invalid attribute, like bad spelling or grammar.
  36  *@ATK_TEXT_ATTR_LEFT_MARGIN: The pixel width of the left margin
  37  *@ATK_TEXT_ATTR_RIGHT_MARGIN: The pixel width of the right margin
  38  *@ATK_TEXT_ATTR_INDENT: The number of pixels that the text is indented
  39  *@ATK_TEXT_ATTR_INVISIBLE: Either "true" or "false" indicating whether text is visible or not
  40  *@ATK_TEXT_ATTR_EDITABLE: Either "true" or "false" indicating whether text is editable or not
  41  *@ATK_TEXT_ATTR_PIXELS_ABOVE_LINES: Pixels of blank space to leave above each newline-terminated line.
  42  *@ATK_TEXT_ATTR_PIXELS_BELOW_LINES: Pixels of blank space to leave below each newline-terminated line.
  43  *@ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP: Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).
  44  *@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.
  45  *@ATK_TEXT_ATTR_RISE: Number of pixels that the characters are risen above the baseline
  46  *@ATK_TEXT_ATTR_UNDERLINE: "none", "single", "double", "low", or "error"
  47  *@ATK_TEXT_ATTR_STRIKETHROUGH: "true" or "false" whether the text is strikethrough
  48  *@ATK_TEXT_ATTR_SIZE: The size of the characters in points. eg: 10
  49  *@ATK_TEXT_ATTR_SCALE: The scale of the characters. The value is a string representation of a double
  50  *@ATK_TEXT_ATTR_WEIGHT: The weight of the characters.
  51  *@ATK_TEXT_ATTR_LANGUAGE: The language used
  52  *@ATK_TEXT_ATTR_FAMILY_NAME: The font family name
  53  *@ATK_TEXT_ATTR_BG_COLOR: The background color. The value is an RGB value of the format "%u,%u,%u"
  54  *@ATK_TEXT_ATTR_FG_COLOR:The foreground color. The value is an RGB value of the format "%u,%u,%u"
  55  *@ATK_TEXT_ATTR_BG_STIPPLE: "true" if a #GdkBitmap is set for stippling the background color.
  56  *@ATK_TEXT_ATTR_FG_STIPPLE: "true" if a #GdkBitmap is set for stippling the foreground color.
  57  *@ATK_TEXT_ATTR_WRAP_MODE: The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char".
  58  *@ATK_TEXT_ATTR_DIRECTION: The direction of the text, if set. Values are "none", "ltr" or "rtl"
  59  *@ATK_TEXT_ATTR_JUSTIFICATION: The justification of the text, if set. Values are "left", "right", "center" or "fill"
  60  *@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"
  61  *@ATK_TEXT_ATTR_VARIANT: The capitalization variant of the text, if set. Values are "normal" or "small_caps"
  62  *@ATK_TEXT_ATTR_STYLE: The slant style of the text, if set. Values are "normal", "oblique" or "italic"
  63  *@ATK_TEXT_ATTR_LAST_DEFINED: not a valid text attribute, used for finding end of enumeration
  64  *
  65  * Describes the text attributes supported
  66  **/
  67 typedef enum
  68 {
  69   ATK_TEXT_ATTR_INVALID = 0,
  70   ATK_TEXT_ATTR_LEFT_MARGIN,
  71   ATK_TEXT_ATTR_RIGHT_MARGIN,
  72   ATK_TEXT_ATTR_INDENT,
  73   ATK_TEXT_ATTR_INVISIBLE,
  74   ATK_TEXT_ATTR_EDITABLE,
  75   ATK_TEXT_ATTR_PIXELS_ABOVE_LINES,
  76   ATK_TEXT_ATTR_PIXELS_BELOW_LINES,
  77   ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP,
  78   ATK_TEXT_ATTR_BG_FULL_HEIGHT,
  79   ATK_TEXT_ATTR_RISE,
  80   ATK_TEXT_ATTR_UNDERLINE,
  81   ATK_TEXT_ATTR_STRIKETHROUGH,
  82   ATK_TEXT_ATTR_SIZE,
  83   ATK_TEXT_ATTR_SCALE,
  84   ATK_TEXT_ATTR_WEIGHT,
  85   ATK_TEXT_ATTR_LANGUAGE,
  86   ATK_TEXT_ATTR_FAMILY_NAME,
  87   ATK_TEXT_ATTR_BG_COLOR,
  88   ATK_TEXT_ATTR_FG_COLOR,
  89   ATK_TEXT_ATTR_BG_STIPPLE,
  90   ATK_TEXT_ATTR_FG_STIPPLE,
  91   ATK_TEXT_ATTR_WRAP_MODE,
  92   ATK_TEXT_ATTR_DIRECTION,
  93   ATK_TEXT_ATTR_JUSTIFICATION,
  94   ATK_TEXT_ATTR_STRETCH,
  95   ATK_TEXT_ATTR_VARIANT,
  96   ATK_TEXT_ATTR_STYLE,
  97   ATK_TEXT_ATTR_LAST_DEFINED
  98 } AtkTextAttribute;
  99
 100 AtkTextAttribute         atk_text_attribute_register   (const gchar *name);
 101
 102
 103 #define ATK_TYPE_TEXT                    (atk_text_get_type ())
 104 #define ATK_IS_TEXT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_TEXT)
 105 #define ATK_TEXT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_TEXT, AtkText)
 106 #define ATK_TEXT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_TEXT, AtkTextIface))
 107
 108 #ifndef _TYPEDEF_ATK_TEXT_
 109 #define _TYPEDEF_ATK_TEXT_
 110 typedef struct _AtkText AtkText;
 111 #endif
 112 typedef struct _AtkTextIface AtkTextIface;
 113
 114
 115 /**
 116  *AtkTextBoundary:
 117  *@ATK_TEXT_BOUNDARY_CHAR: Boundary is the boundary between characters
 118  * (including non-printing characters)
 119  *@ATK_TEXT_BOUNDARY_WORD_START: Boundary is the start (i.e. first character) of a word.
 120  *@ATK_TEXT_BOUNDARY_WORD_END: Boundary is the end (i.e. last
 121  * character) of a word.
 122  *@ATK_TEXT_BOUNDARY_SENTENCE_START: Boundary is the first character in a sentence.
 123  *@ATK_TEXT_BOUNDARY_SENTENCE_END: Boundary is the last (terminal)
 124  * character in a sentence; in languages which use "sentence stop"
 125  * punctuation such as English, the boundary is thus the '.', '?', or
 126  * similar terminal punctuation character.
 127  *@ATK_TEXT_BOUNDARY_LINE_START: Boundary is the initial character of the content or a
 128  * character immediately following a newline, linefeed, or return character.
 129  *@ATK_TEXT_BOUNDARY_LINE_END: Boundary is the linefeed, or return
 130  * character.
 131  *
 132  * Text boundary types used for specifying boundaries for regions of text.
 133  * This enumerationis deprecated since 2.9.4 and should not be used. Use
 134  * AtkTextGranularity with #atk_text_get_string_at_offset instead.
 135  **/
 136 typedef enum {
 137   ATK_TEXT_BOUNDARY_CHAR,
 138   ATK_TEXT_BOUNDARY_WORD_START,
 139   ATK_TEXT_BOUNDARY_WORD_END,
 140   ATK_TEXT_BOUNDARY_SENTENCE_START,
 141   ATK_TEXT_BOUNDARY_SENTENCE_END,
 142   ATK_TEXT_BOUNDARY_LINE_START,
 143   ATK_TEXT_BOUNDARY_LINE_END
 144 } AtkTextBoundary;
 145
 146 /**
 147  *AtkTextGranularity:
 148  *@ATK_TEXT_GRANULARITY_CHAR: Granularity is defined by the boundaries between characters
 149  * (including non-printing characters)
 150  *@ATK_TEXT_GRANULARITY_WORD: Granularity is defined by the boundaries of a word,
 151  * starting at the beginning of the current word and finishing at the beginning of
 152  * the following one, if present.
 153  *@ATK_TEXT_GRANULARITY_SENTENCE: Granularity is defined by the boundaries of a sentence,
 154  * starting at the beginning of the current sentence and finishing at the beginning of
 155  * the following one, if present.
 156  *@ATK_TEXT_GRANULARITY_LINE: Granularity is defined by the boundaries of a line,
 157  * starting at the beginning of the current line and finishing at the beginning of
 158  * the following one, if present.
 159  *@ATK_TEXT_GRANULARITY_PARAGRAPH: Granularity is defined by the boundaries of a paragraph,
 160  * starting at the beginning of the current paragraph and finishing at the beginning of
 161  * the following one, if present.
 162  *
 163  * Text granularity types used for specifying the granularity of the region of
 164  * text we are interested in.
 165  **/
 166 typedef enum {
 167   ATK_TEXT_GRANULARITY_CHAR,
 168   ATK_TEXT_GRANULARITY_WORD,
 169   ATK_TEXT_GRANULARITY_SENTENCE,
 170   ATK_TEXT_GRANULARITY_LINE,
 171   ATK_TEXT_GRANULARITY_PARAGRAPH
 172 } AtkTextGranularity;
 173
 174 /**
 175  * AtkTextRectangle:
 176  * @x: The horizontal coordinate of a rectangle
 177  * @y: The vertical coordinate of a rectangle
 178  * @width: The width of a rectangle
 179  * @height: The height of a rectangle
 180  *
 181  * A structure used to store a rectangle used by AtkText.
 182  **/
 183
 184 typedef struct _AtkTextRectangle AtkTextRectangle;
 185
 186 struct _AtkTextRectangle {
 187   gint x;
 188   gint y;
 189   gint width;
 190   gint height;
 191 };
 192
 193 /**
 194  * AtkTextRange:
 195  * @bounds: A rectangle giving the bounds of the text range
 196  * @start_offset: The start offset of a AtkTextRange
 197  * @end_offset: The end offset of a AtkTextRange
 198  * @content: The text in the text range
 199  *
 200  * A structure used to describe a text range.
 201  **/
 202 typedef struct _AtkTextRange AtkTextRange;
 203
 204 struct _AtkTextRange {
 205   AtkTextRectangle bounds;
 206   gint start_offset;
 207   gint end_offset;
 208   gchar* content;
 209 };
 210
 211 GType atk_text_range_get_type (void);
 212
 213 /**
 214  *AtkTextClipType:
 215  *@ATK_TEXT_CLIP_NONE: No clipping to be done
 216  *@ATK_TEXT_CLIP_MIN: Text clipped by min coordinate is omitted
 217  *@ATK_TEXT_CLIP_MAX: Text clipped by max coordinate is omitted
 218  *@ATK_TEXT_CLIP_BOTH: Only text fully within mix/max bound is retained
 219  *
 220  *Describes the type of clipping required.
 221  **/
 222 typedef enum {
 223     ATK_TEXT_CLIP_NONE,
 224     ATK_TEXT_CLIP_MIN,
 225     ATK_TEXT_CLIP_MAX,
 226     ATK_TEXT_CLIP_BOTH
 227 } AtkTextClipType;
 228
 229 /**
 230  * AtkTextIface:
 231  * @get_text_after_offset: Gets specified text. This virtual function
 232  *   is deprecated and it should not be overridden.
 233  * @get_text_at_offset: Gets specified text. This virtual function
 234  *   is deprecated and it should not be overridden.
 235  * @get_text_before_offset: Gets specified text. This virtual function
 236  *   is deprecated and it should not be overridden.
 237  * @get_string_at_offset: Gets a portion of the text exposed through
 238  *   an AtkText according to a given offset and a specific
 239  *   granularity, along with the start and end offsets defining the
 240  *   boundaries of such a portion of text.
 241  * @text_changed: the signal handler which is executed when there is a
 242  *   text change. This virtual function is deprecated sice 2.9.4 and
 243  *   it should not be overriden.
 244  */
 245 struct _AtkTextIface
 246 {
 247   GTypeInterface parent;
 248
 249   gchar*         (* get_text)                     (AtkText          *text,
 250                                                    gint             start_offset,
 251                                                    gint             end_offset);
 252   gchar*         (* get_text_after_offset)        (AtkText          *text,
 253                                                    gint             offset,
 254                                                    AtkTextBoundary  boundary_type,
 255                                                    gint             *start_offset,
 256                                                    gint             *end_offset);
 257   gchar*         (* get_text_at_offset)           (AtkText          *text,
 258                                                    gint             offset,
 259                                                    AtkTextBoundary  boundary_type,
 260                                                    gint             *start_offset,
 261                                                    gint             *end_offset);
 262   gunichar       (* get_character_at_offset)      (AtkText          *text,
 263                                                    gint             offset);
 264   gchar*         (* get_text_before_offset)       (AtkText          *text,
 265                                                    gint             offset,
 266                                                    AtkTextBoundary  boundary_type,
 267                                                    gint             *start_offset,
 268                                                    gint             *end_offset);
 269   gint           (* get_caret_offset)             (AtkText          *text);
 270   AtkAttributeSet* (* get_run_attributes)         (AtkText          *text,
 271                                                    gint             offset,
 272                                                    gint             *start_offset,
 273                                                    gint             *end_offset);
 274   AtkAttributeSet* (* get_default_attributes)     (AtkText          *text);
 275   void           (* get_character_extents)        (AtkText          *text,
 276                                                    gint             offset,
 277                                                    gint             *x,
 278                                                    gint             *y,
 279                                                    gint             *width,
 280                                                    gint             *height,
 281                                                    AtkCoordType     coords);
 282   gint           (* get_character_count)          (AtkText          *text);
 283   gint           (* get_offset_at_point)          (AtkText          *text,
 284                                                    gint             x,
 285                                                    gint             y,
 286                                                    AtkCoordType     coords);
 287   gint           (* get_n_selections)             (AtkText          *text);
 288   gchar*         (* get_selection)                (AtkText          *text,
 289                                                    gint             selection_num,
 290                                                    gint             *start_offset,
 291                                                    gint             *end_offset);
 292   gboolean       (* add_selection)                (AtkText          *text,
 293                                                    gint             start_offset,
 294                                                    gint             end_offset);
 295   gboolean       (* remove_selection)             (AtkText          *text,
 296                                                    gint             selection_num);
 297   gboolean       (* set_selection)                (AtkText          *text,
 298                                                    gint             selection_num,
 299                                                    gint             start_offset,
 300                                                    gint             end_offset);
 301   gboolean       (* set_caret_offset)             (AtkText          *text,
 302                                                    gint             offset);
 303
 304   /*
 305    * signal handlers
 306    */
 307   void           (* text_changed)                 (AtkText          *text,
 308                                                    gint             position,
 309                                                    gint             length);
 310   void           (* text_caret_moved)             (AtkText          *text,
 311                                                    gint             location);
 312   void           (* text_selection_changed)       (AtkText          *text);
 313
 314   void           (* text_attributes_changed)      (AtkText          *text);
 315
 316
 317   void           (* get_range_extents)            (AtkText          *text,
 318                                                    gint             start_offset,
 319                                                    gint             end_offset,
 320                                                    AtkCoordType     coord_type,
 321                                                    AtkTextRectangle *rect);
 322
 323   AtkTextRange** (* get_bounded_ranges)           (AtkText          *text,
 324                                                    AtkTextRectangle *rect,
 325                                                    AtkCoordType     coord_type,
 326                                                    AtkTextClipType  x_clip_type,
 327                                                    AtkTextClipType  y_clip_type);
 328
 329   gchar*         (* get_string_at_offset)         (AtkText            *text,
 330                                                    gint               offset,
 331                                                    AtkTextGranularity granularity,
 332                                                    gint               *start_offset,
 333                                                    gint               *end_offset);
 334 };
 335
 336 GType            atk_text_get_type (void);
 337
 338
 339 /*
 340  * Additional AtkObject properties used by AtkText:
 341  *    "accessible_text" (accessible text has changed)
 342  *    "accessible_caret" (accessible text cursor position changed:
 343  *                         editable text only)
 344  */
 345
 346 gchar*        atk_text_get_text                           (AtkText          *text,
 347                                                            gint             start_offset,
 348                                                            gint             end_offset);
 349 gunichar      atk_text_get_character_at_offset            (AtkText          *text,
 350                                                            gint             offset);
 351 G_DEPRECATED_FOR(atk_text_get_string_at_offset)
 352 gchar*        atk_text_get_text_after_offset              (AtkText          *text,
 353                                                            gint             offset,
 354                                                            AtkTextBoundary  boundary_type,
 355                                                            gint             *start_offset,
 356                                                            gint             *end_offset);
 357 G_DEPRECATED_FOR(atk_text_get_string_at_offset)
 358 gchar*        atk_text_get_text_at_offset                 (AtkText          *text,
 359                                                            gint             offset,
 360                                                            AtkTextBoundary  boundary_type,
 361                                                            gint             *start_offset,
 362                                                            gint             *end_offset);
 363 G_DEPRECATED_FOR(atk_text_get_string_at_offset)
 364 gchar*        atk_text_get_text_before_offset             (AtkText          *text,
 365                                                            gint             offset,
 366                                                            AtkTextBoundary  boundary_type,
 367                                                            gint             *start_offset,
 368                                                            gint             *end_offset);
 369 gchar*        atk_text_get_string_at_offset               (AtkText            *text,
 370                                                            gint               offset,
 371                                                            AtkTextGranularity granularity,
 372                                                            gint               *start_offset,
 373                                                            gint               *end_offset);
 374 gint          atk_text_get_caret_offset                   (AtkText          *text);
 375 void          atk_text_get_character_extents              (AtkText          *text,
 376                                                            gint             offset,
 377                                                            gint             *x,
 378                                                            gint             *y,
 379                                                            gint             *width,
 380                                                            gint             *height,
 381                                                            AtkCoordType     coords);
 382 AtkAttributeSet* atk_text_get_run_attributes              (AtkText          *text,
 383                                                            gint             offset,
 384                                                            gint             *start_offset,
 385                                                            gint             *end_offset);
 386 AtkAttributeSet* atk_text_get_default_attributes          (AtkText          *text);
 387 gint          atk_text_get_character_count                (AtkText          *text);
 388 gint          atk_text_get_offset_at_point                (AtkText          *text,
 389                                                            gint             x,
 390                                                            gint             y,
 391                                                            AtkCoordType     coords);
 392 gint          atk_text_get_n_selections                   (AtkText          *text);
 393 gchar*        atk_text_get_selection                      (AtkText          *text,
 394                                                            gint             selection_num,
 395                                                            gint             *start_offset,
 396                                                            gint             *end_offset);
 397 gboolean      atk_text_add_selection                      (AtkText          *text,
 398                                                            gint             start_offset,
 399                                                            gint             end_offset);
 400 gboolean      atk_text_remove_selection                   (AtkText          *text,
 401                                                            gint             selection_num);
 402 gboolean      atk_text_set_selection                      (AtkText          *text,
 403                                                            gint             selection_num,
 404                                                            gint             start_offset,
 405                                                            gint             end_offset);
 406 gboolean      atk_text_set_caret_offset                   (AtkText          *text,
 407                                                            gint             offset);
 408 void          atk_text_get_range_extents                  (AtkText          *text,
 409
 410                                                            gint             start_offset,
 411                                                            gint             end_offset,
 412                                                            AtkCoordType     coord_type,
 413                                                            AtkTextRectangle *rect);
 414 AtkTextRange**  atk_text_get_bounded_ranges               (AtkText          *text,
 415                                                            AtkTextRectangle *rect,
 416                                                            AtkCoordType     coord_type,
 417                                                            AtkTextClipType  x_clip_type,
 418                                                            AtkTextClipType  y_clip_type);
 419 void          atk_text_free_ranges                        (AtkTextRange     **ranges);
 420 void          atk_attribute_set_free                      (AtkAttributeSet  *attrib_set);
 421 const gchar*  atk_text_attribute_get_name                 (AtkTextAttribute attr);
 422 AtkTextAttribute       atk_text_attribute_for_name        (const gchar      *name);
 423 const gchar*  atk_text_attribute_get_value                (AtkTextAttribute attr,
 424                                                            gint             index_);
 425
 426 G_END_DECLS
 427
 428 #endif /* __ATK_TEXT_H__ */