atk/atktext.c

   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 #include "atktext.h"
  21 #include "atkmarshal.h"
  22
  23 enum {
  24   TEXT_CHANGED,
  25   CARET_MOVED,
  26   LAST_SIGNAL
  27 };
  28
  29 struct _AtkTextIfaceClass
  30 {
  31   GObjectClass parent;
  32 };
  33
  34 typedef struct _AtkTextIfaceClass AtkTextIfaceClass;
  35
  36 static void atk_text_base_init (gpointer *g_class);
  37
  38 static guint atk_text_signals[LAST_SIGNAL] = { 0 };
  39
  40 GType
  41 atk_text_get_type ()
  42 {
  43   static GType type = 0;
  44
  45   if (!type)
  46     {
  47       static const GTypeInfo tinfo =
  48       {
  49         sizeof (AtkTextIface),
  50         (GBaseInitFunc) atk_text_base_init,
  51         (GBaseFinalizeFunc) NULL,
  52         (GClassInitFunc) NULL /* atk_text_interface_init */ ,
  53         (GClassFinalizeFunc) NULL,
  54
  55       };
  56
  57       type = g_type_register_static (G_TYPE_INTERFACE, "AtkText", &tinfo, 0);
  58     }
  59
  60   return type;
  61 }
  62
  63 static void
  64 atk_text_base_init (gpointer *g_class)
  65 {
  66   static gboolean initialized = FALSE;
  67
  68   if (! initialized)
  69     {
  70    /*
  71     * Note that text_changed signal supports details "insert", "delete",
  72     * possibly "replace".
  73     */
  74
  75     atk_text_signals[TEXT_CHANGED] =
  76       g_signal_newc ("text_changed",
  77                      ATK_TYPE_TEXT,
  78                      G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
  79                      G_STRUCT_OFFSET (AtkTextIface, text_changed),
  80                      (GSignalAccumulator) NULL, NULL,
  81                      atk_marshal_VOID__INT_INT,
  82                      G_TYPE_NONE,
  83                      2, G_TYPE_INT, G_TYPE_INT);
  84
  85     atk_text_signals[CARET_MOVED] =
  86       g_signal_newc ("text_caret_moved",
  87                      ATK_TYPE_TEXT,
  88                      G_SIGNAL_RUN_LAST,
  89                      G_STRUCT_OFFSET (AtkTextIface, caret_changed),
  90                      (GSignalAccumulator) NULL, NULL,
  91                      g_cclosure_marshal_VOID__INT,
  92                      G_TYPE_NONE,
  93                      1, G_TYPE_INT);
  94
  95   initialized = TRUE;
  96   }
  97 }
  98
  99 /**
 100  * atk_text_get_text:
 101  * @text: an #AtkText
 102  * @start_offset: start position
 103  * @end_offset: end position
 104  *
 105  * Gets the specified text.
 106  *
 107  * Returns: the text from @start_offset up to, but not including @end_offset.
 108  **/
 109 gchar*
 110 atk_text_get_text (AtkText      *text,
 111                    gint         start_offset,
 112                    gint         end_offset)
 113 {
 114   AtkTextIface *iface;
 115
 116   g_return_val_if_fail (text != NULL, NULL);
 117   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 118
 119   iface = ATK_TEXT_GET_IFACE (text);
 120
 121   if (iface->get_text)
 122     return (*(iface->get_text)) (text, start_offset, end_offset);
 123   else
 124     return NULL;
 125 }
 126
 127 /**
 128  * atk_text_get_character_at_offset
 129  * @text: an #AtkText
 130  * @offset: position
 131  *
 132  * Gets the specified text.
 133  *
 134  * Returns: the character at @offset.
 135  **/
 136 gunichar
 137 atk_text_get_character_at_offset (AtkText      *text,
 138                                   gint         offset)
 139 {
 140   AtkTextIface *iface;
 141
 142   g_return_val_if_fail (text != NULL, (gunichar) 0);
 143   g_return_val_if_fail (ATK_IS_TEXT (text), (gunichar) 0);
 144
 145   iface = ATK_TEXT_GET_IFACE (text);
 146
 147   if (iface->get_character_at_offset)
 148     return (*(iface->get_character_at_offset)) (text, offset);
 149   else
 150     return (gunichar) 0;
 151 }
 152
 153 /**
 154  * atk_text_get_text_after_offset
 155  * @text: an #AtkText
 156  * @offset: position
 157  * @boundary_type: An #AtkTextBoundary
 158  *
 159  * Gets the specified text.
 160  * If the boundary type is ATK_TEXT_BOUNDARY_WORD_START or
 161  * ATK_TEXT_BOUNDARY_WORD_END part of a word may be returned.
 162  * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the start point
 163  * will be the offset and will continue to the start of the next sentence.
 164  * The first word may not be a complete word. Similarly for
 165  * ATK_TEXT_BOUNDARY_SENTENCE_END, ATK_TEXT_BOUNDARY_LINE_START and
 166  * ATK_TEXT_BOUNDARY_LINE_END
 167  *
 168  * Returns: the text after @offset up to the specified @boundary_type.
 169  **/
 170 gchar*
 171 atk_text_get_text_after_offset (AtkText          *text,
 172                                 gint             offset,
 173                                 AtkTextBoundary  boundary_type)
 174 {
 175   AtkTextIface *iface;
 176
 177   g_return_val_if_fail (text != NULL, NULL);
 178   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 179
 180   iface = ATK_TEXT_GET_IFACE (text);
 181
 182   if (iface->get_text_after_offset)
 183     return (*(iface->get_text_after_offset)) (text, offset, boundary_type);
 184   else
 185     return NULL;
 186 }
 187
 188 /**
 189  * atk_text_get_text_at_offset
 190  * @text: an #AtkText
 191  * @offset: position
 192  * @boundary_type: An #AtkTextBoundary
 193  *
 194  * Gets the specified text.
 195  * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START or
 196  * ATK_TEXT_BOUNDARY_WORD_END a complete word is returned;
 197  * if the boundary type is  ATK_TEXT_BOUNDARY_SENTENCE_START or
 198  * ATK_TEXT_BOUNDARY_SENTENCE_END a complete sentence
 199  * is returned; if the boundary type is ATK_TEXT_BOUNDARY_LINE_START or
 200  * ATK_TEXT_BOUNDARY_LINE_END a complete line is returned.
 201  *
 202  * Returns: the text at @offset up to the specified @boundary_type.
 203  **/
 204 gchar*
 205 atk_text_get_text_at_offset (AtkText          *text,
 206                              gint             offset,
 207                              AtkTextBoundary  boundary_type)
 208 {
 209   AtkTextIface *iface;
 210
 211   g_return_val_if_fail (text != NULL, NULL);
 212   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 213
 214   iface = ATK_TEXT_GET_IFACE (text);
 215
 216   if (iface->get_text_at_offset)
 217     return (*(iface->get_text_at_offset)) (text, offset, boundary_type);
 218   else
 219     return NULL;
 220 }
 221
 222 /**
 223  * atk_text_get_text_before_offset
 224  * @text: an #AtkText
 225  * @offset: position
 226  * @boundary_type: An #AtkTextBoundary
 227  *
 228  * Gets the specified text.
 229  * If the boundary type is ATK_TEXT_BOUNDARY_WORD_START or
 230  * ATK_TEXT_BOUNDARY_WORD_END part of a word may be returned.
 231  * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the start point
 232  * will be at the start of the sentence, and will continue to the offset.
 233  * The last word may not be a complete word. Similarly for
 234  * ATK_TEXT_BOUNDARY_SENTENCE_END, ATK_TEXT_BOUNDARY_LINE_START and
 235  * ATK_TEXT_BOUNDARY_LINE_END
 236  *
 237  * Returns: the text before @offset starting from the specified @boundary_type.
 238  **/
 239 gchar*
 240 atk_text_get_text_before_offset (AtkText          *text,
 241                                  gint             offset,
 242                                  AtkTextBoundary  boundary_type)
 243 {
 244   AtkTextIface *iface;
 245
 246   g_return_val_if_fail (text != NULL, NULL);
 247   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 248
 249   iface = ATK_TEXT_GET_IFACE (text);
 250
 251   if (iface->get_text_before_offset)
 252     return (*(iface->get_text_before_offset)) (text, offset, boundary_type);
 253   else
 254     return NULL;
 255 }
 256
 257 /**
 258  * atk_text_get_caret_offset
 259  * @text: an #AtkText
 260  *
 261  * Gets the offset position of the caret (cursor).
 262  *
 263  * Returns: the offset position of the caret (cursor), or -1 if
 264  *    one does not exist (or is not supported by the widget).
 265  **/
 266 gint
 267 atk_text_get_caret_offset (AtkText *text)
 268 {
 269   AtkTextIface *iface;
 270
 271   g_return_val_if_fail (text != NULL, -1);
 272   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 273
 274   iface = ATK_TEXT_GET_IFACE (text);
 275
 276   if (iface->get_caret_offset)
 277     return (*(iface->get_caret_offset)) (text);
 278   else
 279     return -1;
 280 }
 281
 282 /**
 283  * atk_text_get_character_extents:
 284  * @text: an #AtkText
 285  * @offset: position
 286  * @x: x-position of character
 287  * @y: y-position of character
 288  * @length: length of character
 289  * @width: width of character
 290  * @coords: specify whether coordinates are relative to the screen or widget window
 291  *
 292  * Given an @offset, the @x, @y, @length, and @width values are filled
 293  * appropriately.
 294  **/
 295 void
 296 atk_text_get_character_extents (AtkText *text,
 297                                 gint offset,
 298                                 gint *x,
 299                                 gint *y,
 300                                 gint *length,
 301                                 gint *width,
 302                                 AtkXYCoords coords)
 303 {
 304   AtkTextIface *iface;
 305
 306   g_return_if_fail (text != NULL);
 307   g_return_if_fail (ATK_IS_TEXT (text));
 308
 309   iface = ATK_TEXT_GET_IFACE (text);
 310
 311   if (iface->get_character_extents)
 312     (*(iface->get_character_extents)) (text, offset, x, y, length, width, coords);
 313   else
 314     {
 315       *x = 0;
 316       *x = 0;
 317       *length = 0;
 318       *width = 0;
 319     }
 320 }
 321
 322 /**
 323  *atk_text_ref_run_attributes:
 324  *@text: an #AtkText
 325  *@offset: the offset at which to get the attributes
 326  *@start_offset: the address to put the start offset of the range
 327  *@end_offset: the address to put the end offset of the range
 328  *
 329  *Creates an #AtkAttributeSet which consists of the attributes explicitly
 330  *set at the position @offset in the text. @start_offset and @end_offset are
 331  *set to the start and end of the range around @offset where the attributes are
 332  *invariant.
 333  *
 334  *Returns: an #AtkAttributeSet which contains the attributes explicitly set
 335  *at @offset
 336  **/
 337 AtkAttributeSet* atk_text_ref_run_attributes              (AtkText          *text,
 338                                                            gint             offset,
 339                                                            gint             *start_offset,
 340                                                            gint             *end_offset)
 341 {
 342   AtkTextIface *iface;
 343
 344   g_return_val_if_fail (text != NULL, NULL);
 345   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 346
 347   iface = ATK_TEXT_GET_IFACE (text);
 348
 349   if (iface->ref_run_attributes)
 350     return (*(iface->ref_run_attributes)) (text, offset, start_offset, end_offset);
 351   else
 352     return NULL;
 353 }
 354
 355 /**
 356  * atk_text_get_character_count
 357  * @text: an #AtkText
 358  *
 359  * Gets the character count.
 360  *
 361  * Returns: the number of characters.
 362  **/
 363 gint
 364 atk_text_get_character_count (AtkText *text)
 365 {
 366   AtkTextIface *iface;
 367
 368   g_return_val_if_fail (text != NULL, -1);
 369   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 370
 371   iface = ATK_TEXT_GET_IFACE (text);
 372
 373   if (iface->get_character_count)
 374     return (*(iface->get_character_count)) (text);
 375   else
 376     return -1;
 377 }
 378
 379 /**
 380  * atk_text_get_offset_at_point:
 381  * @text: an #AtkText
 382  * @x: screen x-position of character
 383  * @y: screen y-position of character
 384  * @coords: specify whether coordinates are relative to the screen or widget window
 385  *
 386  * Gets the offset of the character located at coordinates @x and @y. @x and @y are
 387  * interpreted as being relative to the screen or this widget's window depending
 388  * on @coords.
 389  *
 390  * Returns: the offset to the character which is located at
 391  * the specified @x and @y coordinates.
 392  **/
 393 gint
 394 atk_text_get_offset_at_point (AtkText *text,
 395                               gint x,
 396                               gint y,
 397                               AtkXYCoords coords)
 398 {
 399   AtkTextIface *iface;
 400
 401   g_return_val_if_fail (text != NULL, -1);
 402   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 403
 404   iface = ATK_TEXT_GET_IFACE (text);
 405
 406   if (iface->get_offset_at_point)
 407     return (*(iface->get_offset_at_point)) (text, x, y, coords);
 408   else
 409     return -1;
 410 }
 411
 412 /**
 413  * atk_text_get_n_selections
 414  * @text: an #AtkText
 415  *
 416  * Gets the number of selected regions.
 417  *
 418  * Returns: The number of selected regions, or -1 if a failure
 419  *   occurred.
 420  **/
 421 gint
 422 atk_text_get_n_selections (AtkText *text)
 423 {
 424   AtkTextIface *iface;
 425
 426   g_return_val_if_fail (text != NULL, -1);
 427   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 428
 429   iface = ATK_TEXT_GET_IFACE (text);
 430
 431   if (iface->get_n_selections)
 432     return (*(iface->get_n_selections)) (text);
 433   else
 434     return -1;
 435 }
 436
 437 /**
 438  * atk_text_get_selection
 439  * @text: an #AtkText
 440  * @selection_num: The selection number.  The selected regions are
 441  * assigned numbers that corrispond to how far the region is from the
 442  * start of the text.  The selected region closest to the beginning
 443  * of the text region is assigned the number 0, etc.  Note that adding,
 444  * moving or deleting a selected region can change the numbering.
 445  * @start_offset: passes back the start position of the selected region
 446  * @end_offset: passes back the end position of the selected region
 447  *
 448  * Gets the text from the specified selection.
 449  *
 450  * Returns: the selected text.
 451  **/
 452 gchar*
 453 atk_text_get_selection (AtkText *text, gint selection_num,
 454    gint *start_offset, gint *end_offset)
 455 {
 456   AtkTextIface *iface;
 457
 458   g_return_val_if_fail (text != NULL, NULL);
 459   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 460
 461   iface = ATK_TEXT_GET_IFACE (text);
 462
 463   if (iface->get_selection)
 464   {
 465     return (*(iface->get_selection)) (text, selection_num,
 466        start_offset, end_offset);
 467   }
 468   else
 469     return NULL;
 470 }
 471
 472 /**
 473  * atk_text_add_selection
 474  * @text: an #AtkText
 475  * @start_offset: the start position of the selected region
 476  * @end_offset: the end position of the selected region
 477  *
 478  * Adds a selection bounded by the specified offsets.
 479  *
 480  * Returns: %TRUE if success, %FALSE otherwise
 481  **/
 482 gboolean
 483 atk_text_add_selection (AtkText *text, gint start_offset,
 484    gint end_offset)
 485 {
 486   AtkTextIface *iface;
 487
 488   g_return_val_if_fail (text != NULL, FALSE);
 489   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 490
 491   iface = ATK_TEXT_GET_IFACE (text);
 492
 493   if (iface->add_selection)
 494     return (*(iface->add_selection)) (text, start_offset, end_offset);
 495   else
 496     return FALSE;
 497 }
 498
 499 /**
 500  * atk_text_remove_selection
 501  * @text: an #AtkText
 502  * @selection_num: The selection number.  The selected regions are
 503  * assigned numbers that corrispond to how far the region is from the
 504  * start of the text.  The selected region closest to the beginning
 505  * of the text region is assigned the number 0, etc.  Note that adding,
 506  * moving or deleting a selected region can change the numbering.
 507  *
 508  * Removes the specified selection
 509  *
 510  * Returns: %TRUE if success, %FALSE otherwise
 511  **/
 512 gboolean
 513 atk_text_remove_selection (AtkText *text, gint selection_num)
 514 {
 515   AtkTextIface *iface;
 516
 517   g_return_val_if_fail (text != NULL, FALSE);
 518   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 519
 520   iface = ATK_TEXT_GET_IFACE (text);
 521
 522   if (iface->remove_selection)
 523     return (*(iface->remove_selection)) (text, selection_num);
 524   else
 525     return FALSE;
 526 }
 527
 528 /**
 529  * atk_text_set_selection
 530  * @text: an #AtkText
 531  * @selection_num: The selection number.  The selected regions are
 532  * assigned numbers that corrispond to how far the region is from the
 533  * start of the text.  The selected region closest to the beginning
 534  * of the text region is assigned the number 0, etc.  Note that adding,
 535  * moving or deleting a selected region can change the numbering.
 536  * @start_offset: the new start position of the selection
 537  * @end_offset: the new end position of the selection
 538  *
 539  * Changes the start and end offset of the specified selection
 540  *
 541  * Returns: %TRUE if success, %FALSE otherwise
 542  **/
 543 gboolean
 544 atk_text_set_selection (AtkText *text, gint selection_num,
 545    gint start_offset, gint end_offset)
 546 {
 547   AtkTextIface *iface;
 548
 549   g_return_val_if_fail (text != NULL, FALSE);
 550   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 551
 552   iface = ATK_TEXT_GET_IFACE (text);
 553
 554   if (iface->set_selection)
 555   {
 556     return (*(iface->set_selection)) (text, selection_num,
 557        start_offset, end_offset);
 558   }
 559   else
 560     return FALSE;
 561 }
 562
 563 /**
 564  * atk_text_set_caret_offset
 565  * @text: an #AtkText
 566  * @offset: position
 567  *
 568  * Sets the caret (cursor) position to the specified @offset.
 569  *
 570  * Returns: %TRUE if success, %FALSE otherwise.
 571  **/
 572 gboolean
 573 atk_text_set_caret_offset (AtkText *text,
 574                            gint    offset)
 575 {
 576   AtkTextIface *iface;
 577
 578   g_return_val_if_fail (text != NULL, FALSE);
 579   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 580
 581   iface = ATK_TEXT_GET_IFACE (text);
 582
 583   if (iface->set_caret_offset)
 584     {
 585       return (*(iface->set_caret_offset)) (text, offset);
 586     }
 587   else
 588     {
 589       return FALSE;
 590     }
 591 }