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