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).
 264  **/
 265 gint
 266 atk_text_get_caret_offset (AtkText *text)
 267 {
 268   AtkTextIface *iface;
 269
 270   g_return_val_if_fail (text != NULL, -1);
 271   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 272
 273   iface = ATK_TEXT_GET_IFACE (text);
 274
 275   if (iface->get_caret_offset)
 276     return (*(iface->get_caret_offset)) (text);
 277   else
 278     return -1;
 279 }
 280
 281 /**
 282  * atk_text_get_row_col_at_offset
 283  * @text: an #AtkText
 284  * @offset: position
 285  * @row: row number
 286  * @col: column number
 287  *
 288  * Given an @offset, the @row and @col arguments are filled appropriately.
 289  **/
 290 void
 291 atk_text_get_row_col_at_offset (AtkText *text,
 292                                 gint offset,
 293                                 gint *row,
 294                                 gint *col)
 295 {
 296   AtkTextIface *iface;
 297
 298   g_return_if_fail (text != NULL);
 299   g_return_if_fail (ATK_IS_TEXT (text));
 300
 301   iface = ATK_TEXT_GET_IFACE (text);
 302
 303   if (iface->get_row_col_at_offset)
 304     (*(iface->get_row_col_at_offset)) (text, offset, row, col);
 305   else
 306     {
 307       *row = 0;
 308       *col = 0;
 309     }
 310 }
 311
 312 /**
 313  * atk_text_get_range_attributes
 314  * @text: an #AtkText
 315  * @start_offset: start position
 316  * @end_offset: end position
 317  *
 318  * Gets attributes over the specified range.
 319  *
 320  * Returns: a #PangoAttrList with the text attributes between the
 321  * @start_offset and the @end_offset.
 322  **/
 323 PangoAttrList*
 324 atk_text_get_range_attributes (AtkText *text,
 325                                gint start_offset,
 326                                gint end_offset)
 327 {
 328   AtkTextIface *iface;
 329
 330   g_return_val_if_fail (text != NULL, NULL);
 331   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 332
 333   iface = ATK_TEXT_GET_IFACE (text);
 334
 335   if (iface->get_range_attributes)
 336     return (*(iface->get_range_attributes)) (text, start_offset, end_offset);
 337   else
 338     return NULL;
 339 }
 340
 341 /**
 342  * atk_text_get_character_extents
 343  * @text: an #AtkText
 344  * @offset: position
 345  * @x: x-position of character
 346  * @y: y-position of character
 347  * @length: length of character
 348  * @width: width of character
 349  *
 350  * Given an @offset, the @x, @y, @length, and @width values are filled
 351  * appropriately.
 352  **/
 353 void
 354 atk_text_get_character_extents (AtkText *text,
 355                                 gint offset,
 356                                 gint *x,
 357                                 gint *y,
 358                                 gint *length,
 359                                 gint *width)
 360 {
 361   AtkTextIface *iface;
 362
 363   g_return_if_fail (text != NULL);
 364   g_return_if_fail (ATK_IS_TEXT (text));
 365
 366   iface = ATK_TEXT_GET_IFACE (text);
 367
 368   if (iface->get_character_extents)
 369     (*(iface->get_character_extents)) (text, offset, x, y, length, width);
 370   else
 371     {
 372       *x = 0;
 373       *x = 0;
 374       *length = 0;
 375       *width = 0;
 376     }
 377 }
 378
 379 /**
 380  * atk_text_get_character_count
 381  * @text: an #AtkText
 382  *
 383  * Gets the character count.
 384  *
 385  * Returns: the number of characters.
 386  **/
 387 gint
 388 atk_text_get_character_count (AtkText *text)
 389 {
 390   AtkTextIface *iface;
 391
 392   g_return_val_if_fail (text != NULL, -1);
 393   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 394
 395   iface = ATK_TEXT_GET_IFACE (text);
 396
 397   if (iface->get_character_count)
 398     return (*(iface->get_character_count)) (text);
 399   else
 400     return -1;
 401 }
 402
 403 /**
 404  * atk_text_get_offset_at_point
 405  * @text: an #AtkText
 406  * @x: screen x-position of character
 407  * @y: screen y-position of character
 408  *
 409  * Gets the x,y screen coordinates of the specified character.
 410  *
 411  * Returns: the offset to the character which is located at
 412  * the specified @x and @y coordinates.
 413  **/
 414 gint
 415 atk_text_get_offset_at_point (AtkText *text,
 416                               gint x,
 417                               gint y)
 418 {
 419   AtkTextIface *iface;
 420
 421   g_return_val_if_fail (text != NULL, -1);
 422   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 423
 424   iface = ATK_TEXT_GET_IFACE (text);
 425
 426   if (iface->get_offset_at_point)
 427     return (*(iface->get_offset_at_point)) (text, x, y);
 428   else
 429     return -1;
 430 }
 431
 432 /**
 433  * atk_text_get_n_selections
 434  * @text: an #AtkText
 435  *
 436  * Gets the number of selected regions.
 437  *
 438  * Returns: The number of selected regions, or -1 if a failure
 439  *   occurred.
 440  **/
 441 gint
 442 atk_text_get_n_selections (AtkText *text)
 443 {
 444   AtkTextIface *iface;
 445
 446   g_return_val_if_fail (text != NULL, -1);
 447   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 448
 449   iface = ATK_TEXT_GET_IFACE (text);
 450
 451   if (iface->get_n_selections)
 452     return (*(iface->get_n_selections)) (text);
 453   else
 454     return -1;
 455 }
 456
 457 /**
 458  * atk_text_get_selection
 459  * @text: an #AtkText
 460  * @selection_num: The selection number.  The selected regions are
 461  * assigned numbers that corrispond to how far the region is from the
 462  * start of the text.  The selected region closest to the beginning
 463  * of the text region is assigned the number 0, etc.  Note that adding,
 464  * moving or deleting a selected region can change the numbering.
 465  * @start_offset: passes back the start position of the selected region
 466  * @end_offset: passes back the end position of the selected region
 467  *
 468  * Gets the text from the specified selection.
 469  *
 470  * Returns: the selected text.
 471  **/
 472 gchar*
 473 atk_text_get_selection (AtkText *text, gint selection_num,
 474    gint *start_offset, gint *end_offset)
 475 {
 476   AtkTextIface *iface;
 477
 478   g_return_val_if_fail (text != NULL, NULL);
 479   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 480
 481   iface = ATK_TEXT_GET_IFACE (text);
 482
 483   if (iface->get_selection)
 484   {
 485     return (*(iface->get_selection)) (text, selection_num,
 486        start_offset, end_offset);
 487   }
 488   else
 489     return NULL;
 490 }
 491
 492 /**
 493  * atk_text_add_selection
 494  * @text: an #AtkText
 495  * @start_offset: the start position of the selected region
 496  * @end_offset: the end position of the selected region
 497  *
 498  * Adds a selection bounded by the specified offsets.
 499  *
 500  * Returns: %TRUE if success, %FALSE otherwise
 501  **/
 502 gboolean
 503 atk_text_add_selection (AtkText *text, gint start_offset,
 504    gint end_offset)
 505 {
 506   AtkTextIface *iface;
 507
 508   g_return_val_if_fail (text != NULL, FALSE);
 509   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 510
 511   iface = ATK_TEXT_GET_IFACE (text);
 512
 513   if (iface->add_selection)
 514     return (*(iface->add_selection)) (text, start_offset, end_offset);
 515   else
 516     return FALSE;
 517 }
 518
 519 /**
 520  * atk_text_remove_selection
 521  * @text: an #AtkText
 522  * @selection_num: The selection number.  The selected regions are
 523  * assigned numbers that corrispond to how far the region is from the
 524  * start of the text.  The selected region closest to the beginning
 525  * of the text region is assigned the number 0, etc.  Note that adding,
 526  * moving or deleting a selected region can change the numbering.
 527  *
 528  * Removes the specified selection
 529  *
 530  * Returns: %TRUE if success, %FALSE otherwise
 531  **/
 532 gboolean
 533 atk_text_remove_selection (AtkText *text, gint selection_num)
 534 {
 535   AtkTextIface *iface;
 536
 537   g_return_val_if_fail (text != NULL, FALSE);
 538   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 539
 540   iface = ATK_TEXT_GET_IFACE (text);
 541
 542   if (iface->remove_selection)
 543     return (*(iface->remove_selection)) (text, selection_num);
 544   else
 545     return FALSE;
 546 }
 547
 548 /**
 549  * atk_text_set_selection
 550  * @text: an #AtkText
 551  * @selection_num: The selection number.  The selected regions are
 552  * assigned numbers that corrispond to how far the region is from the
 553  * start of the text.  The selected region closest to the beginning
 554  * of the text region is assigned the number 0, etc.  Note that adding,
 555  * moving or deleting a selected region can change the numbering.
 556  * @start_offset: the new start position of the selection
 557  * @end_offset: the new end position of the selection
 558  *
 559  * Changes the start and end offset of the specified selection
 560  *
 561  * Returns: %TRUE if success, %FALSE otherwise
 562  **/
 563 gboolean
 564 atk_text_set_selection (AtkText *text, gint selection_num,
 565    gint start_offset, gint end_offset)
 566 {
 567   AtkTextIface *iface;
 568
 569   g_return_val_if_fail (text != NULL, FALSE);
 570   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 571
 572   iface = ATK_TEXT_GET_IFACE (text);
 573
 574   if (iface->set_selection)
 575   {
 576     return (*(iface->set_selection)) (text, selection_num,
 577        start_offset, end_offset);
 578   }
 579   else
 580     return FALSE;
 581 }
 582
 583 /**
 584  * atk_text_set_caret_offset
 585  * @text: an #AtkText
 586  * @offset: position
 587  *
 588  * Sets the caret (cursor) position to the specified @offset.
 589  *
 590  * Returns: %TRUE if success, %FALSE otherwise.
 591  **/
 592 gboolean
 593 atk_text_set_caret_offset (AtkText *text,
 594                            gint    offset)
 595 {
 596   AtkTextIface *iface;
 597
 598   g_return_val_if_fail (text != NULL, FALSE);
 599   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 600
 601   iface = ATK_TEXT_GET_IFACE (text);
 602
 603   if (iface->set_caret_offset)
 604     {
 605       return (*(iface->set_caret_offset)) (text, offset);
 606     }
 607   else
 608     {
 609       return FALSE;
 610     }
 611 }