cspi/spi.h

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2002 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef _SPI_H
  25 #define _SPI_H
  26
  27 #include <cspi/spi-impl.h>
  28 /*
  29  * Definitions for AccessibleRole, AccessibleState,
  30  * and event listeners.
  31  */
  32 #include <cspi/spi-roletypes.h>
  33 #include <cspi/spi-statetypes.h>
  34 #include <cspi/spi-listener.h>
  35
  36 /*
  37  * Auxiliary typedefs and mask definitions
  38  */
  39 #include <libspi/keymasks.h>
  40
  41 #ifdef  __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  *AccessibleTextBoundaryType:
  47  *@SPI_TEXT_BOUNDARY_CHAR:
  48  *@SPI_TEXT_BOUNDARY_CURSOR_POS:
  49  *@SPI_TEXT_BOUNDARY_WORD_START:
  50  *@SPI_TEXT_BOUNDARY_WORD_END:
  51  *@SPI_TEXT_BOUNDARY_SENTENCE_START:
  52  *@SPI_TEXT_BOUNDARY_SENTENCE_END:
  53  *@SPI_TEXT_BOUNDARY_LINE_START:
  54  *@SPI_TEXT_BOUNDARY_LINE_END:
  55  *@SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE:
  56  *
  57  *Text boundary types used for specifying boundaries for regions of text
  58  **/
  59 typedef enum
  60 {
  61   SPI_TEXT_BOUNDARY_CHAR,
  62   SPI_TEXT_BOUNDARY_CURSOR_POS,
  63   SPI_TEXT_BOUNDARY_WORD_START,
  64   SPI_TEXT_BOUNDARY_WORD_END,
  65   SPI_TEXT_BOUNDARY_SENTENCE_START,
  66   SPI_TEXT_BOUNDARY_SENTENCE_END,
  67   SPI_TEXT_BOUNDARY_LINE_START,
  68   SPI_TEXT_BOUNDARY_LINE_END,
  69   SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE
  70 } AccessibleTextBoundaryType;
  71
  72 /**
  73  *AccessibleTextClipType
  74  *@SPI_TEXT_CLIP_NONE: No clipping to be done
  75  *@SPI_TEXT_CLIP_MIN: Text clipped by min coordinate is omitted
  76  *@SPI_TEXT_CLIP_MAX: Text clipped by max coordinate is omitted
  77  *@SPI_TEXT_CLIP_BOTH: Only text fully within mix/max bound is retained
  78  *
  79  *Describes the type of clipping required.
  80  **/
  81 typedef enum
  82 {
  83   SPI_TEXT_CLIP_NONE,
  84   SPI_TEXT_CLIP_MIN,
  85   SPI_TEXT_CLIP_MAX,
  86   SPI_TEXT_CLIP_BOTH
  87 } AccessibleTextClipType;
  88
  89 /**
  90  *AccessibleRelationType:
  91  *@SPI_RELATION_NULL:
  92  *@SPI_RELATION_LABEL_FOR: Indicates an object is a label for one or more target objects.
  93  *@SPI_RELATION_LABELED_BY: Indicates an object is labelled by one or more target objects.
  94  *@SPI_RELATION_CONTROLLED_BY: Indicates an object controlled by one or more target objects.
  95  *@SPI_RELATION_CONTROLLER_FOR: Indicates an object is an controller for one or more target objects.
  96  *@SPI_RELATION_MEMBER_OF: Indicates an object is a member of a group of one or
  97 more target objects.
  98  *@SPI_RELATION_NODE_CHILD_OF: Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell.
  99  *@SPI_RELATION_EXTENDED:
 100  *@SPI_RELATION_FLOWS_TO: Indicates that the object has content that flows logically to another
 101  *  AtkObject in a sequential way, (for instance text-flow).
 102  *@SPI_RELATION_FLOWS_FROM: Indicates that the object has content that flows logically from
 103  *  another AtkObject in a sequential way, (for instance text-flow).
 104  *@SPI_RELATION_SUBWINDOW_OF:
 105  *@SPI_RELATION_EMBEDS: Indicates that the object visually embeds
 106  *  another object's content, i.e. this object's content flows around
 107  *  another's content.
 108  *@SPI_RELATION_EMBEDDED_BY: Inverse of %SPI_RELATION_EMBEDS, indicates that
 109  *  this object's content is visualy embedded in another object.
 110  *@SPI_RELATION_POPUP_FOR: Indicates that an object is a popup for another objec
 111 t.
 112  *@SPI_RELATION_LAST_DEFINED:
 113  *
 114  *Describes the type of the relation
 115  **/
 116 typedef enum
 117 {
 118   SPI_RELATION_NULL,
 119   SPI_RELATION_LABEL_FOR,
 120   SPI_RELATION_LABELED_BY,
 121   SPI_RELATION_CONTROLLER_FOR,
 122   SPI_RELATION_CONTROLLED_BY,
 123   SPI_RELATION_MEMBER_OF,
 124   SPI_RELATION_NODE_CHILD_OF,
 125   SPI_RELATION_EXTENDED,
 126   SPI_RELATION_FLOWS_TO,
 127   SPI_RELATION_FLOWS_FROM,
 128   SPI_RELATION_SUBWINDOW_OF,
 129   SPI_RELATION_EMBEDS,
 130   SPI_RELATION_EMBEDDED_BY,
 131   SPI_RELATION_POPUP_FOR,
 132   SPI_RELATION_LAST_DEFINED
 133 } AccessibleRelationType;
 134
 135
 136 /* don't change the order of these ! */
 137 /**
 138  *AccessibleCoordType:
 139  *@SPI_COORD_TYPE_SCREEN: specifies xy coordinates relative to the screen
 140  *@SPI_COORD_TYPE_WINDOW: specifies xy coordinates relative to an object's
 141  * top-level window
 142  *
 143  *Specifies how xy coordinates are to be interpreted. Used by functions such
 144  *as AccessibleComponent_getPosition() and AccessibleText_getCharacterExtents()
 145  **/
 146 typedef enum {
 147   SPI_COORD_TYPE_SCREEN,
 148   SPI_COORD_TYPE_WINDOW
 149 } AccessibleCoordType;
 150
 151 /**
 152  *AccessibleKeySynthType:
 153  *@SPI_KEY_PRESS:
 154  *@SPI_KEY_RELEASE:
 155  *@SPI_KEY_PRESSRELEASE:
 156  *@SPI_KEY_SYM:
 157  *@SPI_KEY_STRING:
 158  *
 159  *Specified the type of a generated event.
 160  **/
 161 typedef enum {
 162   SPI_KEY_PRESS,
 163   SPI_KEY_RELEASE,
 164   SPI_KEY_PRESSRELEASE,
 165   SPI_KEY_SYM,
 166   SPI_KEY_STRING
 167 } AccessibleKeySynthType;
 168
 169 /**
 170  *AccessibleKeyListenerSyncType:
 171  *@SPI_KEYLISTENER_NOSYNC:
 172  *@SPI_KEYLISTENER_SYNCHRONOUS:
 173  *@SPI_KEYLISTENER_CANCONSUME:
 174  *@SPI_KEYLISTENER_ALL_WINDOWS:
 175  *
 176  *Specified the tyupe of a key listener event.
 177  **/
 178 typedef enum {
 179   SPI_KEYLISTENER_NOSYNC = 0,
 180   SPI_KEYLISTENER_SYNCHRONOUS = 1,
 181   SPI_KEYLISTENER_CANCONSUME = 2,
 182   SPI_KEYLISTENER_ALL_WINDOWS = 4
 183 } AccessibleKeyListenerSyncType;
 184
 185
 186 /**
 187  *AccessibleStreamableContentSeekType
 188  *@SPI_STREAM_SEEK_SET: seek from the 'top' of the streamable
 189  *@SPI_STREAM_SEEK_CUR: seek from the current position in the stream
 190  *@SPI_STREAM_SEEK_END: seek from the end of the stream (if known)
 191  *
 192  *The seek type for a specified offset in AccessibleStreamableContent_seek.
 193  **/
 194 typedef enum
 195 {
 196   SPI_STREAM_SEEK_SET,
 197   SPI_STREAM_SEEK_CUR,
 198   SPI_STREAM_SEEK_END
 199 } AccessibleStreamableContentSeekType;
 200
 201 typedef struct _SPIException SPIException;
 202
 203 typedef SPIBoolean
 204 (* SPIExceptionHandler) (SPIException *err, SPIBoolean is_fatal);
 205
 206 typedef enum {
 207         SPI_EXCEPTION_UNSPECIFIED,
 208         SPI_EXCEPTION_DISCONNECT,
 209         SPI_EXCEPTION_NO_IMPL,
 210         SPI_EXCEPTION_IO,
 211         SPI_EXCEPTION_BAD_DATA
 212 } SPIExceptionCode;
 213
 214 typedef enum {
 215         SPI_EXCEPTION_SOURCE_UNSPECIFIED,
 216         SPI_EXCEPTION_SOURCE_ACCESSIBLE,
 217         SPI_EXCEPTION_SOURCE_REGISTRY,
 218         SPI_EXCEPTION_SOURCE_DEVICE
 219 } SPIExceptionType;
 220
 221 typedef unsigned long AccessibleKeyEventMask;
 222 typedef unsigned long AccessibleDeviceEventMask;
 223
 224 /**
 225  *AccessibleComponentLayer:
 226  *@SPI_LAYER_INVALID: The layer cannot be determined or is somehow undefined.
 227  *@SPI_LAYER_BACKGROUND: Component belongs to the destop background.
 228  *@SPI_LAYER_CANVAS: Component is a canvas backdrop or drawing area.
 229  *@SPI_LAYER_WIDGET: Component is a 'normal' widget.
 230  *@SPI_LAYER_MDI: Component is drawn in the MDI layer and may have valid
 231  *                         Z-information relative to other MDI-layer components.
 232  *@SPI_LAYER_POPUP: Component is in the popup layer, above other widgets and
 233  *                         MDI components.
 234  *@SPI_LAYER_OVERLAY: Component is in the overlay plane - this value is reserved
 235  *                         for future use.
 236  *@SPI_LAYER_WINDOW: Component is in the window layer and have valid Z-information
 237  *                   relative to other window-layer components.
 238  *@SPI_LAYER_LAST_DEFINED: Used to determine the last valid value in the enum,
 239  *                         should not be encountered.
 240  *
 241  * Describes the layer of a component.
 242  *
 243  * These enumerated "layer values" are used when determining which UI
 244  * rendering layer a component is drawn into, which can help in making
 245  * determinations of when components occlude one another.
 246  **/
 247 typedef enum {
 248     SPI_LAYER_INVALID,
 249     SPI_LAYER_BACKGROUND,
 250     SPI_LAYER_CANVAS,
 251     SPI_LAYER_WIDGET,
 252     SPI_LAYER_MDI,
 253     SPI_LAYER_POPUP,
 254     SPI_LAYER_OVERLAY,
 255     SPI_LAYER_WINDOW,
 256     SPI_LAYER_LAST_DEFINED
 257 } AccessibleComponentLayer;
 258
 259
 260 /**
 261  * AccessibleTextRange:
 262  * @start: the first nominal character position within the range.
 263  * @end: the first nominal character position following the range.
 264  * @content: The actual text content between @start and @end, as a UTF-8 string.
 265  *
 266  * Structure which encapsulates a text range - must be associated with an
 267  *          AccessibleText-implementing object.
 268  **/
 269 typedef struct _AccessibleTextRange
 270 {
 271   long int        start;
 272   long int        end;
 273   char           *contents;
 274 } AccessibleTextRange;
 275
 276 /**
 277  * AccessibleKeySet:
 278  * @keysyms:
 279  * @keycodes:
 280  * @len:
 281  *
 282  * Structure containing identifying information about a set of keycode or
 283  *        keysyms.
 284  **/
 285 typedef struct _AccessibleKeySet
 286 {
 287   unsigned long  *keysyms;
 288   unsigned short *keycodes;
 289   char          **keystrings;
 290   short           len;
 291 } AccessibleKeySet;
 292
 293 /*
 294  * A special value for an AccessibleKeySet type, which tacitly
 295  * includes all keycodes and keyvals for the specified modifier set.
 296  */
 297 #define SPI_KEYSET_ALL_KEYS NULL
 298
 299 typedef unsigned long AccessibleModifierMaskType;
 300 /**
 301  *AccessibleKeyMaskType:
 302  *
 303  *AccessibleKeyMaskType is a mask which is a set of key event modifiers
 304  *which is specified in SPI_registerAccessibleKeystrokeListener.
 305  **/
 306
 307 typedef AccessibleModifierMaskType AccessibleKeyMaskType;
 308
 309 /* Basic SPI initialization and event loop function prototypes */
 310
 311 int              SPI_init         (void);
 312 void             SPI_event_main   (void);
 313 void             SPI_event_quit   (void);
 314 SPIBoolean       SPI_eventIsReady (void);
 315 AccessibleEvent *SPI_nextEvent    (SPIBoolean waitForEvent);
 316 int              SPI_exit         (void);
 317
 318 /* Event Listener creation and support.  */
 319
 320 void                      SPI_freeAccessibleKeySet (
 321                                                    AccessibleKeySet         *keyset);
 322 AccessibleKeySet        * SPI_createAccessibleKeySet (
 323                                                    int                       len,
 324                                                    const char               *keysyms,
 325                                                    short                    *keycodes,
 326                                                    const char              **keystrings);
 327 AccessibleEventListener * SPI_createAccessibleEventListener (
 328                                                    AccessibleEventListenerCB callback,
 329                                                    void                     *user_data);
 330 SPIBoolean                AccessibleEventListener_addCallback (
 331                                                    AccessibleEventListener  *listener,
 332                                                    AccessibleEventListenerCB callback,
 333                                                    void                     *user_data);
 334 SPIBoolean                AccessibleEventListener_removeCallback (
 335                                                    AccessibleEventListener  *listener,
 336                                                    AccessibleEventListenerCB callback);
 337 void                      AccessibleEventListener_unref (
 338                                                    AccessibleEventListener  *listener);
 339
 340 /* Device Event Listener creation and support.  */
 341
 342 /* First four are deprecated in favor of the last four; really just a re-name */
 343
 344 AccessibleKeystrokeListener * SPI_createAccessibleKeystrokeListener (
 345                                         AccessibleKeystrokeListenerCB callback,
 346                                         void                         *user_data);
 347 SPIBoolean                    AccessibleKeystrokeListener_addCallback (
 348                                         AccessibleKeystrokeListener  *listener,
 349                                         AccessibleKeystrokeListenerCB callback,
 350                                         void                         *user_data);
 351 SPIBoolean                    AccessibleKeystrokeListener_removeCallback (
 352                                         AccessibleKeystrokeListener *listener,
 353                                         AccessibleKeystrokeListenerCB callback);
 354 void                          AccessibleKeystrokeListener_unref (
 355                                         AccessibleKeystrokeListener *listener);
 356
 357 AccessibleDeviceListener   * SPI_createAccessibleDeviceListener (
 358                                         AccessibleDeviceListenerCB callback,
 359                                         void                      *user_data);
 360 SPIBoolean                    AccessibleDeviceListener_addCallback (
 361                                         AccessibleDeviceListener  *listener,
 362                                         AccessibleDeviceListenerCB callback,
 363                                         void                      *user_data);
 364 SPIBoolean                    AccessibleDeviceListener_removeCallback (
 365                                         AccessibleDeviceListener  *listener,
 366                                         AccessibleDeviceListenerCB callback);
 367 void                          AccessibleDeviceListener_unref (
 368                                         AccessibleDeviceListener *listener);
 369
 370 /* Global functions serviced by the registry */
 371
 372 SPIBoolean SPI_registerGlobalEventListener           (
 373                                        AccessibleEventListener *listener,
 374                                        const char              *eventType);
 375 SPIBoolean SPI_deregisterGlobalEventListener         (
 376                                        AccessibleEventListener *listener,
 377                                        const char              *eventType);
 378 SPIBoolean SPI_deregisterGlobalEventListenerAll      (
 379                                        AccessibleEventListener *listener);
 380 SPIBoolean SPI_registerAccessibleKeystrokeListener   (
 381                                        AccessibleKeystrokeListener *listener,
 382                                        AccessibleKeySet             *keys,
 383                                        AccessibleKeyMaskType         modmask,
 384                                        AccessibleKeyEventMask        eventmask,
 385                                        AccessibleKeyListenerSyncType sync_type);
 386 SPIBoolean SPI_deregisterAccessibleKeystrokeListener (
 387                                        AccessibleKeystrokeListener *listener,
 388                                        AccessibleKeyMaskType        modmask);
 389
 390 SPIBoolean SPI_registerDeviceEventListener   (
 391                                        AccessibleDeviceListener   *listener,
 392                                        AccessibleDeviceEventMask   eventmask,
 393                                        void                       *filter);
 394 SPIBoolean SPI_deregisterDeviceEventListener (
 395                                        AccessibleDeviceListener   *listener,
 396                                        void                       *filter);
 397
 398 int         SPI_getDesktopCount                  (void);
 399 Accessible *SPI_getDesktop                       (int i);
 400 int         SPI_getDesktopList                   (Accessible ***desktop_list);
 401 void        SPI_freeDesktopList                  (Accessible  **desktop_list);
 402
 403 SPIBoolean  SPI_generateKeyboardEvent            (long int                    keyval,
 404                                                   char                       *keystring,
 405                                                   AccessibleKeySynthType      synth_type);
 406
 407 SPIBoolean  SPI_generateMouseEvent               (long int x, long int y, char *name);
 408
 409 /* Accessible function prototypes  */
 410
 411 void                 Accessible_ref              (Accessible *obj);
 412 void                 Accessible_unref            (Accessible *obj);
 413 char *               Accessible_getName          (Accessible *obj);
 414 char *               Accessible_getDescription   (Accessible *obj);
 415 Accessible *         Accessible_getParent        (Accessible *obj);
 416 long                 Accessible_getChildCount    (Accessible *obj);
 417 Accessible *         Accessible_getChildAtIndex  (Accessible *obj,
 418                                                   long int    childIndex);
 419 long                 Accessible_getIndexInParent (Accessible *obj);
 420 AccessibleRelation **Accessible_getRelationSet   (Accessible *obj);
 421 AccessibleRole       Accessible_getRole          (Accessible *obj);
 422 char *               Accessible_getRoleName      (Accessible *obj);
 423 char *               Accessible_getLocalizedRoleName (Accessible *obj);
 424 AccessibleStateSet * Accessible_getStateSet      (Accessible *obj);
 425
 426 /* Interface query methods */
 427
 428 SPIBoolean Accessible_isAction            (Accessible *obj);
 429 SPIBoolean Accessible_isApplication       (Accessible *obj);
 430 SPIBoolean Accessible_isComponent         (Accessible *obj);
 431 SPIBoolean Accessible_isEditableText      (Accessible *obj);
 432 SPIBoolean Accessible_isHypertext         (Accessible *obj);
 433 SPIBoolean Accessible_isImage             (Accessible *obj);
 434 SPIBoolean Accessible_isSelection         (Accessible *obj);
 435 SPIBoolean Accessible_isStreamableContent (Accessible *obj);
 436 SPIBoolean Accessible_isTable             (Accessible *obj);
 437 SPIBoolean Accessible_isText              (Accessible *obj);
 438 SPIBoolean Accessible_isValue             (Accessible *obj);
 439
 440 AccessibleAction *            Accessible_getAction            (Accessible *obj);
 441 AccessibleApplication *       Accessible_getApplication       (Accessible *obj);
 442 AccessibleComponent *         Accessible_getComponent         (Accessible *obj);
 443 AccessibleEditableText *      Accessible_getEditableText      (Accessible *obj);
 444 AccessibleHypertext *         Accessible_getHypertext         (Accessible *obj);
 445 AccessibleImage *             Accessible_getImage             (Accessible *obj);
 446 AccessibleSelection *         Accessible_getSelection         (Accessible *obj);
 447 AccessibleStreamableContent * Accessible_getStreamableContent (Accessible *obj);
 448 AccessibleTable *             Accessible_getTable             (Accessible *obj);
 449 AccessibleText *              Accessible_getText              (Accessible *obj);
 450 AccessibleValue *             Accessible_getValue             (Accessible *obj);
 451 AccessibleUnknown *           Accessible_queryInterface       (Accessible *obj,
 452                                                    const char *interface_name);
 453
 454 /* AccessibleAction function prototypes  */
 455
 456 void       AccessibleAction_ref            (AccessibleAction *obj);
 457 void       AccessibleAction_unref          (AccessibleAction *obj);
 458 long       AccessibleAction_getNActions    (AccessibleAction *obj);
 459 char      *AccessibleAction_getName        (AccessibleAction *obj,
 460                                             long int          i);
 461 char      *AccessibleAction_getDescription (AccessibleAction *obj,
 462                                             long int          i);
 463 SPIBoolean AccessibleAction_doAction       (AccessibleAction *obj,
 464                                             long int          i);
 465 char      *AccessibleAction_getKeyBinding  (AccessibleAction *obj,
 466                                             long int          i);
 467
 468 /* AccessibleApplication function prototypes  */
 469
 470 void       AccessibleApplication_ref            (AccessibleApplication *obj);
 471 void       AccessibleApplication_unref          (AccessibleApplication *obj);
 472 char      *AccessibleApplication_getToolkitName (AccessibleApplication *obj);
 473 char      *AccessibleApplication_getVersion     (AccessibleApplication *obj);
 474 long       AccessibleApplication_getID          (AccessibleApplication *obj);
 475 SPIBoolean AccessibleApplication_pause          (AccessibleApplication *obj);
 476 SPIBoolean AccessibleApplication_resume         (AccessibleApplication *obj);
 477
 478 /* AccessibleComponent function prototypes */
 479
 480 void        AccessibleComponent_ref         (AccessibleComponent *obj);
 481 void        AccessibleComponent_unref       (AccessibleComponent *obj);
 482 SPIBoolean  AccessibleComponent_contains    (AccessibleComponent *obj,
 483                                              long int             x,
 484                                              long int             y,
 485                                              AccessibleCoordType  ctype);
 486 Accessible *AccessibleComponent_getAccessibleAtPoint (
 487                                              AccessibleComponent *obj,
 488                                              long int             x,
 489                                              long int             y,
 490                                              AccessibleCoordType  ctype);
 491 void        AccessibleComponent_getExtents  (AccessibleComponent *obj,
 492                                              long int            *x,
 493                                              long int            *y,
 494                                              long int            *width,
 495                                              long int            *height,
 496                                              AccessibleCoordType  ctype);
 497 void        AccessibleComponent_getPosition (AccessibleComponent *obj,
 498                                              long int            *x,
 499                                              long int            *y,
 500                                              AccessibleCoordType  ctype);
 501 void        AccessibleComponent_getSize     (AccessibleComponent *obj,
 502                                              long int            *width,
 503                                              long int            *height);
 504 AccessibleComponentLayer
 505             AccessibleComponent_getLayer    (AccessibleComponent *obj);
 506 SPIBoolean  AccessibleComponent_grabFocus   (AccessibleComponent *obj);
 507 short       AccessibleComponent_getMDIZOrder(AccessibleComponent *obj);
 508
 509 /* AccessibleEditableText function prototypes  */
 510
 511 void
 512 AccessibleEditableText_ref (AccessibleEditableText *obj);
 513
 514 void
 515 AccessibleEditableText_unref (AccessibleEditableText *obj);
 516
 517 SPIBoolean
 518 AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
 519                                       const char *attributes,
 520                                       long int startOffset,
 521                                       long int endOffset);
 522
 523 SPIBoolean
 524 AccessibleEditableText_setTextContents (AccessibleEditableText *obj,
 525                                         const char *newContents);
 526
 527 SPIBoolean
 528 AccessibleEditableText_insertText (AccessibleEditableText *obj,
 529                                    long int position,
 530                                    const char *text,
 531                                    long int length);
 532
 533 SPIBoolean
 534 AccessibleEditableText_copyText (AccessibleText *obj,
 535                                  long int startPos,
 536                                  long int endPos);
 537
 538 SPIBoolean
 539 AccessibleEditableText_cutText (AccessibleEditableText *obj,
 540                                 long int startPos,
 541                                 long int endPos);
 542
 543 SPIBoolean
 544 AccessibleEditableText_deleteText (AccessibleEditableText *obj,
 545                                    long int startPos,
 546                                    long int endPos);
 547
 548 SPIBoolean
 549 AccessibleEditableText_pasteText (AccessibleEditableText *obj,
 550                                   long int position);
 551
 552 /*
 553  *
 554  * AccessibleHyperlink function prototypes
 555  *
 556  */
 557 void
 558 AccessibleHyperlink_ref (AccessibleHyperlink *obj);
 559 void
 560 AccessibleHyperlink_unref (AccessibleHyperlink *obj);
 561
 562 long
 563 AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj);
 564
 565 char *
 566 AccessibleHyperlink_getURI (AccessibleHyperlink *obj,
 567                             long int i);
 568
 569 Accessible *
 570 AccessibleHyperlink_getObject (AccessibleHyperlink *obj,
 571                                long int i);
 572
 573 void
 574 AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,
 575                                    long int *startIndex,
 576                                    long int *endIndex);
 577
 578 SPIBoolean
 579 AccessibleHyperlink_isValid (AccessibleHyperlink *obj);
 580
 581 /*
 582  *
 583  * AccessibleHypertext function prototypes
 584  *
 585  */
 586
 587 void
 588 AccessibleHypertext_ref (AccessibleHypertext *obj);
 589
 590 void
 591 AccessibleHypertext_unref (AccessibleHypertext *obj);
 592
 593 long
 594 AccessibleHypertext_getNLinks (AccessibleHypertext *obj);
 595
 596 AccessibleHyperlink *
 597 AccessibleHypertext_getLink (AccessibleHypertext *obj,
 598                              long int linkIndex);
 599
 600 long
 601 AccessibleHypertext_getLinkIndex (AccessibleHypertext *obj,
 602                                   long int characterOffset);
 603
 604 /*
 605  *
 606  * AccessibleImage function prototypes
 607  *
 608  */
 609
 610 void
 611 AccessibleImage_ref (AccessibleImage *obj);
 612
 613 void
 614 AccessibleImage_unref (AccessibleImage *obj);
 615
 616 char *
 617 AccessibleImage_getImageDescription (AccessibleImage *obj);
 618
 619 void
 620 AccessibleImage_getImageSize (AccessibleImage *obj,
 621                               long int *width,
 622                               long int *height);
 623
 624 void
 625 AccessibleImage_getImagePosition (AccessibleImage *obj,
 626                                   long int *x,
 627                                   long int *y,
 628                                   AccessibleCoordType ctype);
 629
 630 void
 631 AccessibleImage_getImageExtents (AccessibleImage *obj,
 632                                  long int *x,
 633                                  long int *y,
 634                                  long int *width,
 635                                  long int *height,
 636                                  AccessibleCoordType ctype);
 637 /*
 638  *
 639  * AccessibleRelation function prototypes
 640  *
 641  */
 642
 643 void AccessibleRelation_ref   (AccessibleRelation *obj);
 644 void AccessibleRelation_unref (AccessibleRelation *obj);
 645
 646 AccessibleRelationType
 647 AccessibleRelation_getRelationType (AccessibleRelation *obj);
 648
 649 int
 650 AccessibleRelation_getNTargets (AccessibleRelation *obj);
 651
 652 Accessible *
 653 AccessibleRelation_getTarget (AccessibleRelation *obj, int i);
 654
 655
 656 /*
 657  *
 658  * AccessibleSelection function prototypes
 659  *
 660  */
 661
 662 void AccessibleSelection_ref   (AccessibleSelection *obj);
 663 void AccessibleSelection_unref (AccessibleSelection *obj);
 664
 665 long
 666 AccessibleSelection_getNSelectedChildren (AccessibleSelection *obj);
 667
 668 Accessible *
 669 AccessibleSelection_getSelectedChild (AccessibleSelection *obj,
 670                                       long int selectedChildIndex);
 671
 672 SPIBoolean
 673 AccessibleSelection_selectChild (AccessibleSelection *obj,
 674                                  long int childIndex);
 675
 676 SPIBoolean
 677 AccessibleSelection_deselectSelectedChild (AccessibleSelection *obj,
 678                                            long int selectedChildIndex);
 679
 680 SPIBoolean
 681 AccessibleSelection_isChildSelected (AccessibleSelection *obj,
 682                                      long int childIndex);
 683
 684 SPIBoolean
 685 AccessibleSelection_selectAll (AccessibleSelection *obj);
 686
 687 SPIBoolean
 688 AccessibleSelection_clearSelection (AccessibleSelection *obj);
 689
 690
 691 /*
 692  *
 693  * AccessibleStateSet function prototypes
 694  *
 695  */
 696
 697 void AccessibleStateSet_ref   (AccessibleStateSet *obj);
 698 void AccessibleStateSet_unref (AccessibleStateSet *obj);
 699
 700 SPIBoolean
 701 AccessibleStateSet_contains (AccessibleStateSet *obj,
 702                              AccessibleState state);
 703
 704 void
 705 AccessibleStateSet_add (AccessibleStateSet *obj,
 706                         AccessibleState state);
 707
 708 void
 709 AccessibleStateSet_remove (AccessibleStateSet *obj,
 710                            AccessibleState state);
 711
 712 SPIBoolean
 713 AccessibleStateSet_equals (AccessibleStateSet *obj,
 714                            AccessibleStateSet *obj2);
 715
 716 AccessibleStateSet *
 717 AccessibleStateSet_compare (AccessibleStateSet *obj,
 718                             AccessibleStateSet *obj2);
 719
 720 SPIBoolean
 721 AccessibleStateSet_isEmpty (AccessibleStateSet *obj);
 722
 723 void
 724 AccessibleStreamableContent_ref (AccessibleStreamableContent *obj);
 725 void
 726 AccessibleStreamableContent_unref (AccessibleStreamableContent *obj);
 727 char **
 728 AccessibleStreamableContent_getContentTypes (AccessibleStreamableContent *obj);
 729 void
 730 AccessibleStreamableContent_freeContentTypeList (AccessibleStreamableContent *obj,
 731                                                  char **list);
 732 SPIBoolean
 733 AccessibleStreamableContent_open (AccessibleStreamableContent *obj,
 734                                   const char *content_type);
 735 SPIBoolean
 736 AccessibleStreamableContent_close (AccessibleStreamableContent *obj);
 737
 738 long int
 739 AccessibleStreamableContent_seek (AccessibleStreamableContent *obj,
 740                                   long int offset,
 741                                   AccessibleStreamableContentSeekType seek_type);
 742 SPIBoolean
 743 AccessibleStreamableContent_read (AccessibleStreamableContent *obj,
 744                                   void *buff,
 745                                   long int nbytes,
 746                                   unsigned int read_type);
 747 /*
 748  *
 749  * AccessibleTable function prototypes
 750  *
 751  */
 752
 753 void AccessibleTable_ref   (AccessibleTable *obj);
 754 void AccessibleTable_unref (AccessibleTable *obj);
 755
 756 Accessible *
 757 AccessibleTable_getCaption (AccessibleTable *obj);
 758
 759 Accessible *
 760 AccessibleTable_getSummary (AccessibleTable *obj);
 761
 762 long
 763 AccessibleTable_getNRows (AccessibleTable *obj);
 764
 765 long
 766 AccessibleTable_getNColumns (AccessibleTable *obj);
 767
 768 Accessible *
 769 AccessibleTable_getAccessibleAt (AccessibleTable *obj,
 770                                  long int row,
 771                                  long int column);
 772
 773 long
 774 AccessibleTable_getIndexAt (AccessibleTable *obj,
 775                             long int row,
 776                             long int column);
 777
 778 long
 779 AccessibleTable_getRowAtIndex (AccessibleTable *obj,
 780                                long int index);
 781
 782 long
 783 AccessibleTable_getColumnAtIndex (AccessibleTable *obj,
 784                                   long int index);
 785
 786 char *
 787 AccessibleTable_getRowDescription (AccessibleTable *obj,
 788                                    long int row);
 789
 790 char *
 791 AccessibleTable_getColumnDescription (AccessibleTable *obj,
 792                                       long int column);
 793
 794 long
 795 AccessibleTable_getRowExtentAt (AccessibleTable *obj,
 796                                 long int row,
 797                                 long int column);
 798
 799 long
 800 AccessibleTable_getColumnExtentAt (AccessibleTable *obj,
 801                                    long int row,
 802                                    long int column);
 803
 804 Accessible *
 805 AccessibleTable_getRowHeader (AccessibleTable *obj,
 806                               long int row);
 807
 808 Accessible *
 809 AccessibleTable_getColumnHeader (AccessibleTable *obj,
 810                                  long int column);
 811
 812 long
 813 AccessibleTable_getNSelectedRows (AccessibleTable *obj);
 814
 815 long
 816 AccessibleTable_getSelectedRows (AccessibleTable *obj,
 817                                  long int **selectedRows);
 818
 819 long
 820 AccessibleTable_getNSelectedColumns (AccessibleTable *obj);
 821
 822 long
 823 AccessibleTable_getSelectedColumns (AccessibleTable *obj,
 824                                     long int **selectedColumns);
 825
 826 SPIBoolean
 827 AccessibleTable_isRowSelected (AccessibleTable *obj,
 828                                long int row);
 829
 830 SPIBoolean
 831 AccessibleTable_isColumnSelected (AccessibleTable *obj,
 832                                   long int column);
 833
 834 SPIBoolean
 835 AccessibleTable_isSelected (AccessibleTable *obj,
 836                             long int row,
 837                             long int column);
 838
 839 /*
 840  *
 841  * AccessibleText function prototypes
 842  *
 843  */
 844
 845 void AccessibleText_ref   (AccessibleText *obj);
 846 void AccessibleText_unref (AccessibleText *obj);
 847
 848 long
 849 AccessibleText_getCharacterCount (AccessibleText *obj);
 850
 851 char *
 852 AccessibleText_getText (AccessibleText *obj,
 853                         long int startOffset,
 854                         long int endOffset);
 855
 856 long
 857 AccessibleText_getCaretOffset (AccessibleText *obj);
 858
 859 char *
 860 AccessibleText_getAttributes (AccessibleText *obj,
 861                                  long int offset,
 862                                  long int *startOffset,
 863                                  long int *endOffset);
 864
 865 char *
 866 AccessibleText_getDefaultAttributes (AccessibleText *obj);
 867
 868 SPIBoolean
 869 AccessibleText_setCaretOffset (AccessibleText *obj,
 870                                long int newOffset);
 871
 872 char *
 873 AccessibleText_getTextBeforeOffset (AccessibleText *obj,
 874                                     long int offset,
 875                                     AccessibleTextBoundaryType type,
 876                                     long int *startOffset,
 877                                     long int *endOffset);
 878
 879 char *
 880 AccessibleText_getTextAtOffset (AccessibleText *obj,
 881                                 long int offset,
 882                                 AccessibleTextBoundaryType type,
 883                                 long int *startOffset,
 884                                 long int *endOffset);
 885
 886 char *
 887 AccessibleText_getTextAfterOffset (AccessibleText *obj,
 888                                    long int offset,
 889                                    AccessibleTextBoundaryType type,
 890                                    long int *startOffset,
 891                                    long int *endOffset);
 892
 893 unsigned long
 894 AccessibleText_getCharacterAtOffset (AccessibleText *obj,
 895                                      long int offset);
 896
 897 void
 898 AccessibleText_getCharacterExtents (AccessibleText *obj,
 899                                     long int offset,
 900                                     long int *x,
 901                                     long int *y,
 902                                     long int *width,
 903                                     long int *height,
 904                                     AccessibleCoordType type);
 905
 906 void
 907 AccessibleText_getRangeExtents (AccessibleText *obj,
 908                                 long int startOffset,
 909                                 long int endOffset,
 910                                 long int *x,
 911                                 long int *y,
 912                                 long int *width,
 913                                 long int *height,
 914                                 AccessibleCoordType type);
 915
 916 AccessibleTextRange **
 917 AccessibleText_getBoundedRanges (AccessibleText *obj,
 918                                  long int x,
 919                                  long int y,
 920                                  long int width,
 921                                  long int height,
 922                                  AccessibleCoordType type,
 923                                  AccessibleTextClipType clipTypeX,
 924                                  AccessibleTextClipType clipTypeY);
 925
 926 void
 927 AccessibleTextRange_freeRanges (AccessibleTextRange **ranges);
 928
 929 long
 930 AccessibleText_getOffsetAtPoint (AccessibleText *obj,
 931                                  long int x,
 932                                  long int y,
 933                                  AccessibleCoordType type);
 934
 935 long
 936 AccessibleText_getNSelections (AccessibleText *obj);
 937
 938 void
 939 AccessibleText_getSelection (AccessibleText *obj,
 940                              long int selectionNum,
 941                              long int *startOffset,
 942                              long int *endOffset);
 943
 944
 945 SPIBoolean
 946 AccessibleText_addSelection (AccessibleText *obj,
 947                              long int startOffset,
 948                              long int endOffset);
 949
 950 SPIBoolean
 951 AccessibleText_removeSelection (AccessibleText *obj,
 952                                 long int selectionNum);
 953
 954 SPIBoolean
 955 AccessibleText_setSelection (AccessibleText *obj,
 956                              long int selectionNum,
 957                              long int startOffset,
 958                              long int endOffset);
 959
 960 /* AccessibleValue Function Prototypes:  */
 961
 962 void       AccessibleValue_ref             (AccessibleValue *obj);
 963 void       AccessibleValue_unref           (AccessibleValue *obj);
 964 double     AccessibleValue_getMinimumValue (AccessibleValue *obj);
 965 double     AccessibleValue_getCurrentValue (AccessibleValue *obj);
 966 double     AccessibleValue_getMaximumValue (AccessibleValue *obj);
 967 SPIBoolean AccessibleValue_setCurrentValue (AccessibleValue *obj,
 968                                             double           newValue);
 969
 970 /* Persistance and lifecycle control for AccessibleEvents. */
 971 SPIBoolean AccessibleEvent_ref (const AccessibleEvent *e);
 972 void AccessibleEvent_unref (const AccessibleEvent *e);
 973
 974 /*
 975  * Prototypes for accessor functions, to obtain context
 976  * information for accessible events.
 977  */
 978
 979 char*        AccessibleTextChangedEvent_getChangeString (const AccessibleEvent *e);
 980 Accessible * AccessibleChildChangedEvent_getChildAccessible (const AccessibleEvent *e);
 981
 982 Accessible * AccessibleParentChangedEvent_getParentAccessible (const AccessibleEvent *e);
 983
 984 char*        AccessibleTextSelectionChangedEvent_getSelectionString (const AccessibleEvent *e);
 985
 986 char*        AccessibleWindowEvent_getTitleString (const AccessibleEvent *e);
 987
 988 Accessible * AccessibleActiveDescendantChangedEvent_getActiveDescendant (const AccessibleEvent *e);
 989
 990 Accessible * AccessibleTableSummaryChangedEvent_getSummaryAccessible (const AccessibleEvent *e);
 991
 992 Accessible * AccessibleTableHeaderChangedEvent_getHeaderAccessible (const AccessibleEvent *e);
 993
 994 char *       AccessibleTableCaptionChangedEvent_getCaptionString (const AccessibleEvent *e);
 995
 996 char *       AccessibleTableRowDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
 997
 998 char *       AccessibleTableColumnDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
 999
1000 char *       AccessibleDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
1001
1002 char *       AccessibleNameChangedEvent_getNameString (const AccessibleEvent *e);
1003
1004 /* Misc methods and error handling */
1005 void SPI_freeString (char *s);
1006
1007 char* SPI_dupString (char *s);
1008
1009 SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler);
1010
1011 SPIExceptionHandler* SPI_exceptionHandlerPop (void);
1012
1013 SPIExceptionType SPIException_getSourceType (SPIException *err);
1014
1015 SPIExceptionCode SPIException_getExceptionCode (SPIException *err);
1016
1017 Accessible* SPIAccessibleException_getSource (SPIException *err);
1018
1019 char* SPIException_getDescription (SPIException *err);
1020
1021 #ifdef  __cplusplus
1022 }
1023 #endif
1024
1025 #endif