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  * @startOffset: the start offset of the returned string.
 159  * @endOffset: the end offset of the returned string.
 160  *
 161  * Gets the specified text.
 162  * If the boundary type is ATK_TEXT_BOUNDARY_WORD_START or
 163  * ATK_TEXT_BOUNDARY_WORD_END part of a word may be returned.
 164  * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the start point
 165  * will be the offset and will continue to the start of the next sentence.
 166  * The first word may not be a complete word. Similarly for
 167  * ATK_TEXT_BOUNDARY_SENTENCE_END, ATK_TEXT_BOUNDARY_LINE_START and
 168  * ATK_TEXT_BOUNDARY_LINE_END
 169  *
 170  * Returns: the text after @offset up to the specified @boundary_type.
 171  **/
 172 gchar*
 173 atk_text_get_text_after_offset (AtkText          *text,
 174                                 gint             offset,
 175                                 AtkTextBoundary  boundary_type,
 176                                 gint             *startOffset,
 177                                 gint             *endOffset)
 178 {
 179   AtkTextIface *iface;
 180
 181   g_return_val_if_fail (text != NULL, NULL);
 182   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 183
 184   iface = ATK_TEXT_GET_IFACE (text);
 185
 186   if (iface->get_text_after_offset)
 187     return (*(iface->get_text_after_offset)) (text, offset, boundary_type, startOffset, endOffset);
 188   else
 189     return NULL;
 190 }
 191
 192 /**
 193  * atk_text_get_text_at_offset:
 194  * @text: an #AtkText
 195  * @offset: position
 196  * @boundary_type: An #AtkTextBoundary
 197  * @startOffset: the start offset of the returned string.
 198  * @endOffset: the end offset of the returned string.
 199  *
 200  * Gets the specified text.
 201  * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START or
 202  * ATK_TEXT_BOUNDARY_WORD_END a complete word is returned;
 203  * if the boundary type is  ATK_TEXT_BOUNDARY_SENTENCE_START or
 204  * ATK_TEXT_BOUNDARY_SENTENCE_END a complete sentence
 205  * is returned; if the boundary type is ATK_TEXT_BOUNDARY_LINE_START or
 206  * ATK_TEXT_BOUNDARY_LINE_END a complete line is returned.
 207  *
 208  * Returns: the text at @offset up to the specified @boundary_type.
 209  **/
 210 gchar*
 211 atk_text_get_text_at_offset (AtkText          *text,
 212                              gint             offset,
 213                              AtkTextBoundary  boundary_type,
 214                              gint             *startOffset,
 215                              gint             *endOffset)
 216 {
 217   AtkTextIface *iface;
 218
 219   g_return_val_if_fail (text != NULL, NULL);
 220   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 221
 222   iface = ATK_TEXT_GET_IFACE (text);
 223
 224   if (iface->get_text_at_offset)
 225     return (*(iface->get_text_at_offset)) (text, offset, boundary_type, startOffset, endOffset);
 226   else
 227     return NULL;
 228 }
 229
 230 /**
 231  * atk_text_get_text_before_offset:
 232  * @text: an #AtkText
 233  * @offset: position
 234  * @boundary_type: An #AtkTextBoundary
 235  * @startOffset: the start offset of the returned string.
 236  * @endOffset: the end offset of the returned string.
 237  *
 238  * Gets the specified text.
 239  * If the boundary type is ATK_TEXT_BOUNDARY_WORD_START or
 240  * ATK_TEXT_BOUNDARY_WORD_END part of a word may be returned.
 241  * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the start point
 242  * will be at the start of the sentence, and will continue to the offset.
 243  * The last word may not be a complete word. Similarly for
 244  * ATK_TEXT_BOUNDARY_SENTENCE_END, ATK_TEXT_BOUNDARY_LINE_START and
 245  * ATK_TEXT_BOUNDARY_LINE_END
 246  *
 247  * Returns: the text before @offset starting from the specified @boundary_type.
 248  **/
 249 gchar*
 250 atk_text_get_text_before_offset (AtkText          *text,
 251                                  gint             offset,
 252                                  AtkTextBoundary  boundary_type,
 253                                  gint             *startOffset,
 254                                  gint             *endOffset)
 255 {
 256   AtkTextIface *iface;
 257
 258   g_return_val_if_fail (text != NULL, NULL);
 259   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 260
 261   iface = ATK_TEXT_GET_IFACE (text);
 262
 263   if (iface->get_text_before_offset)
 264     return (*(iface->get_text_before_offset)) (text, offset, boundary_type, startOffset, endOffset);
 265   else
 266     return NULL;
 267 }
 268
 269 /**
 270  * atk_text_get_caret_offset:
 271  * @text: an #AtkText
 272  *
 273  * Gets the offset position of the caret (cursor).
 274  *
 275  * Returns: the offset position of the caret (cursor), or -1 if
 276  *    one does not exist (or is not supported by the widget).
 277  **/
 278 gint
 279 atk_text_get_caret_offset (AtkText *text)
 280 {
 281   AtkTextIface *iface;
 282
 283   g_return_val_if_fail (text != NULL, -1);
 284   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 285
 286   iface = ATK_TEXT_GET_IFACE (text);
 287
 288   if (iface->get_caret_offset)
 289     return (*(iface->get_caret_offset)) (text);
 290   else
 291     return -1;
 292 }
 293
 294 /**
 295  * atk_text_get_character_extents:
 296  * @text: an #AtkText
 297  * @offset: position
 298  * @x: x-position of character
 299  * @y: y-position of character
 300  * @length: length of character
 301  * @width: width of character
 302  * @coords: specify whether coordinates are relative to the screen or widget window
 303  *
 304  * Given an @offset, the @x, @y, @length, and @width values are filled
 305  * appropriately.
 306  **/
 307 void
 308 atk_text_get_character_extents (AtkText *text,
 309                                 gint offset,
 310                                 gint *x,
 311                                 gint *y,
 312                                 gint *length,
 313                                 gint *width,
 314                                 AtkXYCoords coords)
 315 {
 316   AtkTextIface *iface;
 317
 318   g_return_if_fail (text != NULL);
 319   g_return_if_fail (ATK_IS_TEXT (text));
 320
 321   iface = ATK_TEXT_GET_IFACE (text);
 322
 323   if (iface->get_character_extents)
 324     (*(iface->get_character_extents)) (text, offset, x, y, length, width, coords);
 325   else
 326     {
 327       *x = 0;
 328       *x = 0;
 329       *length = 0;
 330       *width = 0;
 331     }
 332 }
 333
 334 /**
 335  *atk_text_ref_run_attributes:
 336  *@text: an #AtkText
 337  *@offset: the offset at which to get the attributes
 338  *@start_offset: the address to put the start offset of the range
 339  *@end_offset: the address to put the end offset of the range
 340  *
 341  *Creates an #AtkAttributeSet which consists of the attributes explicitly
 342  *set at the position @offset in the text. @start_offset and @end_offset are
 343  *set to the start and end of the range around @offset where the attributes are
 344  *invariant.
 345  *
 346  *Returns: an #AtkAttributeSet which contains the attributes explicitly set
 347  *at @offset
 348  **/
 349 AtkAttributeSet* atk_text_ref_run_attributes              (AtkText          *text,
 350                                                            gint             offset,
 351                                                            gint             *start_offset,
 352                                                            gint             *end_offset)
 353 {
 354   AtkTextIface *iface;
 355
 356   g_return_val_if_fail (text != NULL, NULL);
 357   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 358
 359   iface = ATK_TEXT_GET_IFACE (text);
 360
 361   if (iface->ref_run_attributes)
 362     return (*(iface->ref_run_attributes)) (text, offset, start_offset, end_offset);
 363   else
 364     return NULL;
 365 }
 366
 367 /**
 368  * atk_text_get_character_count:
 369  * @text: an #AtkText
 370  *
 371  * Gets the character count.
 372  *
 373  * Returns: the number of characters.
 374  **/
 375 gint
 376 atk_text_get_character_count (AtkText *text)
 377 {
 378   AtkTextIface *iface;
 379
 380   g_return_val_if_fail (text != NULL, -1);
 381   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 382
 383   iface = ATK_TEXT_GET_IFACE (text);
 384
 385   if (iface->get_character_count)
 386     return (*(iface->get_character_count)) (text);
 387   else
 388     return -1;
 389 }
 390
 391 /**
 392  * atk_text_get_offset_at_point:
 393  * @text: an #AtkText
 394  * @x: screen x-position of character
 395  * @y: screen y-position of character
 396  * @coords: specify whether coordinates are relative to the screen or widget window
 397  *
 398  * Gets the offset of the character located at coordinates @x and @y. @x and @y are
 399  * interpreted as being relative to the screen or this widget's window depending
 400  * on @coords.
 401  *
 402  * Returns: the offset to the character which is located at
 403  * the specified @x and @y coordinates.
 404  **/
 405 gint
 406 atk_text_get_offset_at_point (AtkText *text,
 407                               gint x,
 408                               gint y,
 409                               AtkXYCoords coords)
 410 {
 411   AtkTextIface *iface;
 412
 413   g_return_val_if_fail (text != NULL, -1);
 414   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 415
 416   iface = ATK_TEXT_GET_IFACE (text);
 417
 418   if (iface->get_offset_at_point)
 419     return (*(iface->get_offset_at_point)) (text, x, y, coords);
 420   else
 421     return -1;
 422 }
 423
 424 /**
 425  * atk_text_get_n_selections:
 426  * @text: an #AtkText
 427  *
 428  * Gets the number of selected regions.
 429  *
 430  * Returns: The number of selected regions, or -1 if a failure
 431  *   occurred.
 432  **/
 433 gint
 434 atk_text_get_n_selections (AtkText *text)
 435 {
 436   AtkTextIface *iface;
 437
 438   g_return_val_if_fail (text != NULL, -1);
 439   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 440
 441   iface = ATK_TEXT_GET_IFACE (text);
 442
 443   if (iface->get_n_selections)
 444     return (*(iface->get_n_selections)) (text);
 445   else
 446     return -1;
 447 }
 448
 449 /**
 450  * atk_text_get_selection:
 451  * @text: an #AtkText
 452  * @selection_num: The selection number.  The selected regions are
 453  * assigned numbers that corrispond to how far the region is from the
 454  * start of the text.  The selected region closest to the beginning
 455  * of the text region is assigned the number 0, etc.  Note that adding,
 456  * moving or deleting a selected region can change the numbering.
 457  * @start_offset: passes back the start position of the selected region
 458  * @end_offset: passes back the end position of the selected region
 459  *
 460  * Gets the text from the specified selection.
 461  *
 462  * Returns: the selected text.
 463  **/
 464 gchar*
 465 atk_text_get_selection (AtkText *text, gint selection_num,
 466    gint *start_offset, gint *end_offset)
 467 {
 468   AtkTextIface *iface;
 469
 470   g_return_val_if_fail (text != NULL, NULL);
 471   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 472
 473   iface = ATK_TEXT_GET_IFACE (text);
 474
 475   if (iface->get_selection)
 476   {
 477     return (*(iface->get_selection)) (text, selection_num,
 478        start_offset, end_offset);
 479   }
 480   else
 481     return NULL;
 482 }
 483
 484 /**
 485  * atk_text_add_selection:
 486  * @text: an #AtkText
 487  * @start_offset: the start position of the selected region
 488  * @end_offset: the end position of the selected region
 489  *
 490  * Adds a selection bounded by the specified offsets.
 491  *
 492  * Returns: %TRUE if success, %FALSE otherwise
 493  **/
 494 gboolean
 495 atk_text_add_selection (AtkText *text, gint start_offset,
 496    gint end_offset)
 497 {
 498   AtkTextIface *iface;
 499
 500   g_return_val_if_fail (text != NULL, FALSE);
 501   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 502
 503   iface = ATK_TEXT_GET_IFACE (text);
 504
 505   if (iface->add_selection)
 506     return (*(iface->add_selection)) (text, start_offset, end_offset);
 507   else
 508     return FALSE;
 509 }
 510
 511 /**
 512  * atk_text_remove_selection:
 513  * @text: an #AtkText
 514  * @selection_num: The selection number.  The selected regions are
 515  * assigned numbers that corrispond to how far the region is from the
 516  * start of the text.  The selected region closest to the beginning
 517  * of the text region is assigned the number 0, etc.  Note that adding,
 518  * moving or deleting a selected region can change the numbering.
 519  *
 520  * Removes the specified selection
 521  *
 522  * Returns: %TRUE if success, %FALSE otherwise
 523  **/
 524 gboolean
 525 atk_text_remove_selection (AtkText *text, gint selection_num)
 526 {
 527   AtkTextIface *iface;
 528
 529   g_return_val_if_fail (text != NULL, FALSE);
 530   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 531
 532   iface = ATK_TEXT_GET_IFACE (text);
 533
 534   if (iface->remove_selection)
 535     return (*(iface->remove_selection)) (text, selection_num);
 536   else
 537     return FALSE;
 538 }
 539
 540 /**
 541  * atk_text_set_selection:
 542  * @text: an #AtkText
 543  * @selection_num: The selection number.  The selected regions are
 544  * assigned numbers that corrispond to how far the region is from the
 545  * start of the text.  The selected region closest to the beginning
 546  * of the text region is assigned the number 0, etc.  Note that adding,
 547  * moving or deleting a selected region can change the numbering.
 548  * @start_offset: the new start position of the selection
 549  * @end_offset: the new end position of the selection
 550  *
 551  * Changes the start and end offset of the specified selection
 552  *
 553  * Returns: %TRUE if success, %FALSE otherwise
 554  **/
 555 gboolean
 556 atk_text_set_selection (AtkText *text, gint selection_num,
 557    gint start_offset, gint end_offset)
 558 {
 559   AtkTextIface *iface;
 560
 561   g_return_val_if_fail (text != NULL, FALSE);
 562   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 563
 564   iface = ATK_TEXT_GET_IFACE (text);
 565
 566   if (iface->set_selection)
 567   {
 568     return (*(iface->set_selection)) (text, selection_num,
 569        start_offset, end_offset);
 570   }
 571   else
 572     return FALSE;
 573 }
 574
 575 /**
 576  * atk_text_set_caret_offset:
 577  * @text: an #AtkText
 578  * @offset: position
 579  *
 580  * Sets the caret (cursor) position to the specified @offset.
 581  *
 582  * Returns: %TRUE if success, %FALSE otherwise.
 583  **/
 584 gboolean
 585 atk_text_set_caret_offset (AtkText *text,
 586                            gint    offset)
 587 {
 588   AtkTextIface *iface;
 589
 590   g_return_val_if_fail (text != NULL, FALSE);
 591   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 592
 593   iface = ATK_TEXT_GET_IFACE (text);
 594
 595   if (iface->set_caret_offset)
 596     {
 597       return (*(iface->set_caret_offset)) (text, offset);
 598     }
 599   else
 600     {
 601       return FALSE;
 602     }
 603 }