From: billh Date: Fri, 16 Nov 2001 16:52:26 +0000 (+0000) Subject: Added additional documentation and fixed a couple of latent bugs. X-Git-Tag: AT_SPI2_CORE_0_1_3~1077 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=fb1e8ce4bd1b97a4029321017b414bd04cef087d;p=platform%2Fupstream%2Fat-spi2-core.git Added additional documentation and fixed a couple of latent bugs. gtk-doc API documentation coverage now 92%. git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@93 e2bd861d-eb25-0410-b326-f6ed22b6b98c --- diff --git a/ChangeLog b/ChangeLog index 1cbdf6d..59b901e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -7,7 +7,10 @@ * cspi/spi_editabletext.c: * cspi/spi_hypertext.c: - Added docs. Doc coverage now 70%. + * cspi/spi_image.c: + * cspi/spi_hyperlink.c: + * cspi/spi_table.c: + Added docs. Doc coverage now 92%. 2001-16-11 Bill Haneman diff --git a/cspi/spi-roletypes.h b/cspi/spi-roletypes.h index 73a33e2..43b61cb 100644 --- a/cspi/spi-roletypes.h +++ b/cspi/spi-roletypes.h @@ -1,12 +1,17 @@ #ifndef _SPI_ROLETYPES_H_ #define _SPI_ROLETYPES_H_ -/* +/** + * AccessibleRole: + * @SPI_ROLE_INVALID: role is not legal, something is wrong with this object + * @SPI_ROLE_ALERT: Object is used to alert the user about something + * @SPI_ROLE_CANVAS: Object that can be drawn into and is used to trap events + * @SPI_ROLE_CHECK_BOX: Object representd a choice that can be checked or unchecked + * and provides a separate indicator for the current state. * - * Enumerated type for AccessibleRole + * * - */ - + **/ typedef enum { SPI_ROLE_INVALID, @@ -187,4 +192,6 @@ typedef enum SPI_ROLE_LAST_DEFINED } AccessibleRole; +char* AccessibleRole_getName (AccessibleRole role); + #endif diff --git a/cspi/spi.h b/cspi/spi.h index d702338..6875994 100644 --- a/cspi/spi.h +++ b/cspi/spi.h @@ -106,6 +106,11 @@ typedef struct _AccessibleKeySet short len; } AccessibleKeySet; +/** + * SPI_KEYSET_ALL_KEYS: + * @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly + * includes all keycodes and keyvals for the specified modifier set. + **/ #define SPI_KEYSET_ALL_KEYS ((void *)NULL) typedef unsigned long AccessibleKeyMaskType; @@ -953,9 +958,10 @@ int AccessibleEditableText_unref (AccessibleEditableText *obj); boolean -AccessibleEditableText_setRunAttributes (AccessibleEditableText *obj, - const char *attributes, - long int startPos, long int intendPos); +AccessibleEditableText_setAttributes (AccessibleEditableText *obj, + const char *attributes, + long int startOffset, + long int endOffset); boolean AccessibleEditableText_setTextContents (AccessibleEditableText *obj, @@ -1179,7 +1185,7 @@ long AccessibleTable_getNColumns (AccessibleTable *obj); Accessible * -AccessibleTable_refAt (AccessibleTable *obj, +AccessibleTable_getAccessibleAt (AccessibleTable *obj, long int row, long int column); diff --git a/cspi/spi_accessible.c b/cspi/spi_accessible.c index b98f835..2dc78ad 100644 --- a/cspi/spi_accessible.c +++ b/cspi/spi_accessible.c @@ -71,11 +71,16 @@ static char *role_names [MAX_ROLES] = "window", }; -/* - * Returns a localizable string name for an AtkRole enumerated type. - */ +/** + * AccessibleRole_getName: + * @role: an #AccessibleRole object to query. + * + * Get a localizeable string that indicates the name of an #AccessibleRole. + * + * Returns: a localizable string name for an #AccessibleRole enumerated type. + **/ char* -Accessible_Role_getName (Accessibility_Role role) +AccessibleRole_getName (AccessibleRole role) { if (role < MAX_ROLES) return role_names [(int) role]; else return ""; @@ -258,7 +263,7 @@ Accessible_getRelationSet (Accessible *obj) char * Accessible_getRole (Accessible *obj) { - char *retval = Accessible_Role_getName ( + char *retval = AccessibleRole_getName ( Accessibility_Accessible_getRole (*obj, &ev)); spi_check_ev (&ev, "getRole"); return retval; diff --git a/cspi/spi_editabletext.c b/cspi/spi_editabletext.c index 576da71..2fbf22e 100644 --- a/cspi/spi_editabletext.c +++ b/cspi/spi_editabletext.c @@ -41,6 +41,8 @@ AccessibleEditableText_unref (AccessibleEditableText *obj) /** * AccessibleEditableText_setAttributes: * @obj: a pointer to the #AccessibleEditableText object to modify. + * @attributes: a character string indicating the attributes to apply to the range, + * delimited by ':'. * @startOffset: a #long indicating the start of the desired text range. * @endOffset: a #long indicating the first character past the desired range. * diff --git a/cspi/spi_hyperlink.c b/cspi/spi_hyperlink.c index 037c85e..4d039b6 100644 --- a/cspi/spi_hyperlink.c +++ b/cspi/spi_hyperlink.c @@ -1,3 +1,12 @@ +/** + * AccessibleHyperlink_ref: + * @obj: a pointer to the #AccessibleHyperlink object on which to operate. + * + * Increment the reference count for an #AccessibleHyperlink object. + * + * Returns: (no return code implemented yet). + * + **/ int AccessibleHyperlink_ref (AccessibleHyperlink *obj) { @@ -7,6 +16,15 @@ AccessibleHyperlink_ref (AccessibleHyperlink *obj) +/** + * AccessibleHyperlink_unref: + * @obj: a pointer to the #AccessibleHyperlink object on which to operate. + * + * Decrement the reference count for an #AccessibleHyperlink object. + * + * Returns: (no return code implemented yet). + * + **/ int AccessibleHyperlink_unref (AccessibleHyperlink *obj) { @@ -14,8 +32,19 @@ AccessibleHyperlink_unref (AccessibleHyperlink *obj) return 0; } - - +/** + * AccessibleHyperlink_getNAnchors: + * @obj: a pointer to the #AccessibleHyperlink object on which to operate. + * + * Get the total number of anchors which an #AccessibleHyperlink implementor has. + * Though typical hyperlinks have only one anchor, client-side image maps and + * other hypertext objects may potentially activate or refer to multiple + * URIs. For each anchor there is a corresponding URI and object. + * @see AccessibleHyperlink_getURI() and AccessibleHyperlink_getObject(). + * + * Returns: a #long indicating the number of anchors in this hyperlink. + * + **/ long AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj) { @@ -24,33 +53,62 @@ AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj) } - +/** + * AccessibleHyperlink_getURI: + * @obj: a pointer to the #AccessibleHyperlink implementor on which to operate. + * @i: a (zero-index) long integer indicating which hyperlink anchor to query. + * + * Get the URI associated with a particular hyperlink anchor. + * + * Returns: a UTF-8 string giving the URI of the @ith hyperlink anchor. + * + **/ char * AccessibleHyperlink_getURI (AccessibleHyperlink *obj, - long i) + long int i) { return (char *) Accessibility_Hyperlink_getURI (*obj, (CORBA_long) i, &ev); } - - +/** + * AccessibleHyperlink_getObject: + * @obj: a pointer to the #AccessibleHyperlink implementor on which to operate. + * @i: a (zero-index) long integer indicating which hyperlink anchor to query. + * + * Get the object associated with a particular hyperlink anchor, as an #Accessible. + * + * Returns: an #Accessible that represents the object associated with the @ith anchor + * of the specified #AccessibleHyperlink. + * + **/ Accessible* AccessibleHyperlink_getObject (AccessibleHyperlink *obj, - long i) + long int i) { return Obj_Add ( Accessibility_Hyperlink_getObject (*obj, (CORBA_long) i, &ev)); } - - +/** + * AccessibleHyperlink_getIndexRange: + * @obj: a pointer to the #AccessibleHyperlink implementor on which to operate. + * @startIndex: a pointer to a long integer into which the starting + * offset of the text associated with this #AccessibleHyperlink is returned. + * @endIndex: a pointer to a long integer into which the offset of the first character + * after the text associated with this #AccessibleHyperlink is returned. + * + * + * Get the starting and ending character offsets of the text range associated with + * a #AccessibleHyperlink, in its originating #AccessibleHypertext. + * + **/ void AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj, - long *startIndex, - long *endIndex) + long int *startIndex, + long int *endIndex) { *startIndex = (long) Accessibility_Hyperlink__get_startIndex (*obj, &ev); @@ -60,6 +118,17 @@ AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj, +/** + * AccessibleHyperlink_isValid: + * @obj: a pointer to the #AccessibleHyperlink on which to operate. + * + * Tell whether an #AccessibleHyperlink object is still valid with respect to its + * originating hypertext object. + * + * Returns: #TRUE of the specified #AccessibleHyperlink is still valid with respect + * to its originating #AccessibleHypertext object, #FALSE otherwise. + * + **/ boolean AccessibleHyperlink_isValid (AccessibleHyperlink *obj) { diff --git a/cspi/spi_image.c b/cspi/spi_image.c index 8b340a5..ddd7955 100644 --- a/cspi/spi_image.c +++ b/cspi/spi_image.c @@ -1,3 +1,12 @@ +/** + * AccessibleImage_ref: + * @obj: a pointer to the #AccessibleImage implementor on which to operate. + * + * Increment the reference count for an #AccessibleImage object. + * + * Returns: (no return code implemented yet). + * + **/ int AccessibleImage_ref (AccessibleImage *obj) { @@ -7,6 +16,15 @@ AccessibleImage_ref (AccessibleImage *obj) +/** + * AccessibleImage_unref: + * @obj: a pointer to the #AccessibleImage implementor on which to operate. + * + * Decrement the reference count for an #AccessibleImage object. + * + * Returns: (no return code implemented yet). + * + **/ int AccessibleImage_unref (AccessibleImage *obj) { @@ -15,7 +33,15 @@ AccessibleImage_unref (AccessibleImage *obj) } - +/** + * AccessibleImage_getImageDescription: + * @obj: a pointer to the #AccessibleImage implementor on which to operate. + * + * Get the description of the image displayed in an #AccessibleImage object. + * + * Returns: a UTF-8 string describing the image. + * + **/ char * AccessibleImage_getImageDescription (AccessibleImage *obj) { @@ -25,10 +51,19 @@ AccessibleImage_getImageDescription (AccessibleImage *obj) +/** + * AccessibleImage_getImageSize: + * @obj: a pointer to the #AccessibleImage to query. + * @width: a pointer to a #long into which the x extents (width) will be returned. + * @height: a pointer to a #long into which the y extents (height) will be returned. + * + * Get the size of the image displayed in a specified #AccessibleImage object. + * + **/ void AccessibleImage_getImageSize (AccessibleImage *obj, - long *width, - long *height) + long int *width, + long int *height) { Accessibility_Image_getImageSize (*obj, (CORBA_long *) width, (CORBA_long *) height, &ev); @@ -36,6 +71,18 @@ AccessibleImage_getImageSize (AccessibleImage *obj, +/** + * AccessibleImage_getImagePosition: + * @obj: a pointer to the #AccessibleImage implementor to query. + * @x: a pointer to a #long into which the minimum x coordinate will be returned. + * @y: a pointer to a #long into which the minimum y coordinate will be returned. + * @ctype: the desired coordinate system into which to return the results, + * (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN). + * + * Get the minimum x and y coordinates of the image displayed in a + * specified #AccessibleImage implementor. + * + **/ void AccessibleImage_getImagePosition (AccessibleImage *obj, long *x, @@ -46,6 +93,3 @@ AccessibleImage_getImagePosition (AccessibleImage *obj, (CORBA_long *) x, (CORBA_long *) y, (CORBA_short) ctype, &ev); } - - - diff --git a/cspi/spi_registry.c b/cspi/spi_registry.c index 6709df7..72f9314 100644 --- a/cspi/spi_registry.c +++ b/cspi/spi_registry.c @@ -253,6 +253,8 @@ registerAccessibleKeystrokeListener (AccessibleKeystrokeListener *listener, * @modmask: the key modifier mask for which this listener is to be * 'deregistered' (of type #AccessibleeyMaskType). * + * Removes a keystroke event listener from the registry's listener queue, + * ceasing notification of events with modifiers matching @modmask. **/ void deregisterAccessibleKeystrokeListener (AccessibleKeystrokeListener *listener, diff --git a/cspi/spi_selection.c b/cspi/spi_selection.c index 606edda..68c0334 100644 --- a/cspi/spi_selection.c +++ b/cspi/spi_selection.c @@ -1,6 +1,6 @@ /** * AccessibleSelection_ref: - * @obj: a pointer to the #AccessibleSelecion implementor on which to operate. + * @obj: a pointer to the #AccessibleSelection implementor on which to operate. * * Increment the reference count for an #AccessibleSelection object. * diff --git a/cspi/spi_table.c b/cspi/spi_table.c index 91d9f76..32a409a 100644 --- a/cspi/spi_table.c +++ b/cspi/spi_table.c @@ -1,3 +1,12 @@ +/** + * AccessibleTable_ref: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * + * Increment the reference count for an #AccessibleTable object. + * + * Returns: (no return code implemented yet). + * + **/ int AccessibleTable_ref (AccessibleTable *obj) { @@ -7,6 +16,15 @@ AccessibleTable_ref (AccessibleTable *obj) +/** + * AccessibleTable_unref: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * + * Decrement the reference count for an #AccessibleTable object. + * + * Returns: (no return code implemented yet). + * + **/ int AccessibleTable_unref (AccessibleTable *obj) { @@ -14,8 +32,15 @@ AccessibleTable_unref (AccessibleTable *obj) return 0; } - - +/** + * AccessibleTable_getCaption: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * + * Get an accessible representation of the caption for an #AccessibleTable. + * + * Returns: an #Accessible object that serves as the table's caption. + * + **/ Accessible * AccessibleTable_getCaption (AccessibleTable *obj) { @@ -25,6 +50,16 @@ AccessibleTable_getCaption (AccessibleTable *obj) +/** + * AccessibleTable_getSummary: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * + * Get an accessible object which summarizes the contents of an #AccessibleTable. + * + * Returns: an #Accessible object that serves as the table's summary (often a + * reduced #AccessibleTable). + * + **/ Accessible * AccessibleTable_getSummary (AccessibleTable *obj) { @@ -34,6 +69,17 @@ AccessibleTable_getSummary (AccessibleTable *obj) +/** + * AccessibleTable_getNRows: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * + * Get the number of rows in an #AccessibleTable, + * exclusive of any rows that are programmatically hidden, but inclusive + * of rows that may be outside of the current scrolling window or viewport. + * + * Returns: a #long integer indicating the number of rows in the table. + * + **/ long AccessibleTable_getNRows (AccessibleTable *obj) { @@ -43,6 +89,17 @@ AccessibleTable_getNRows (AccessibleTable *obj) +/** + * AccessibleTable_getNColumns: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * + * Get the number of columns in an #AccessibleTable, + * exclusive of any columns that are programmatically hidden, but inclusive + * of columns that may be outside of the current scrolling window or viewport. + * + * Returns: a #long integer indicating the number of columns in the table. + * + **/ long AccessibleTable_getNColumns (AccessibleTable *obj) { @@ -51,10 +108,23 @@ AccessibleTable_getNColumns (AccessibleTable *obj) } +/** + * AccessibleTable_getAccessibleAt: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @row: the specified table row, zero-indexed. + * @column: the specified table column, zero-indexed. + * + * Get the table cell at the specified row and column indices. + * To get the accessible object at a particular (x, y) screen coordinate, + * use #Accessible_getAccessibleAtPoint (). + * + * Returns: an #Accessible object representing the specified table cell. + * + **/ Accessible * AccessibleTable_getAccessibleAt (AccessibleTable *obj, - long row, - long column) + long int row, + long int column) { return (Accessible *) Accessibility_Table_getAccessibleAt (*obj, @@ -62,10 +132,25 @@ AccessibleTable_getAccessibleAt (AccessibleTable *obj, } +/** + * AccessibleTable_getIndexAt: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @row: the specified table row, zero-indexed. + * @column: the specified table column, zero-indexed. + * + * Get the 1-D child index corresponding to the specified 2-D row and column indices. + * To get the accessible object at a particular (x, y) screen coordinate, + * use #Accessible_getAccessibleAtPoint (). + * @see #AccessibleTable_getRowAtIndex(), #AccessibleTable_getColumnAtIndex() + * + * Returns: a long integer which serves as the index of a specified cell in the + * table, in a form usable by #Accessible_getChildAtIndex(). + * + **/ long AccessibleTable_getIndexAt (AccessibleTable *obj, - long row, - long column) + long int row, + long int column) { return (long) Accessibility_Table_getIndexAt (*obj, @@ -74,6 +159,19 @@ AccessibleTable_getIndexAt (AccessibleTable *obj, +/** + * AccessibleTable_getRowAtIndex: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @index: the specified child index, zero-indexed. + * + * Get the table row index occupied by the child at a particular 1-D child index. + * + * @see #AccessibleTable_getIndexAt(), #AccessibleTable_getColumnAtIndex() + * + * Returns: a long integer indicating the first row spanned by the child of a + * table, at the specified 1-D (zero-offset) @index. + * + **/ long AccessibleTable_getRowAtIndex (AccessibleTable *obj, long index) @@ -85,6 +183,19 @@ AccessibleTable_getRowAtIndex (AccessibleTable *obj, +/** + * AccessibleTable_getColumnAtIndex: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @index: the specified child index, zero-indexed. + * + * Get the table column index occupied by the child at a particular 1-D child index. + * + * @see #AccessibleTable_getIndexAt(), #AccessibleTable_getRowAtIndex() + * + * Returns: a long integer indicating the first column spanned by the child of a + * table, at the specified 1-D (zero-offset) @index. + * + **/ long AccessibleTable_getColumnAtIndex (AccessibleTable *obj, long index) @@ -96,9 +207,20 @@ AccessibleTable_getColumnAtIndex (AccessibleTable *obj, +/** + * AccessibleTable_getRowDescription: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @row: the specified table row, zero-indexed. + * + * Get a text description of a particular table row. This differs from + * AccessibleTable_getRowHeader, which returns an #Accessible. + * + * Returns: a UTF-8 string describing the specified table row, if available. + * + **/ char * AccessibleTable_getRowDescription (AccessibleTable *obj, - long row) + long int row) { return (char *) Accessibility_Table_getRowDescription (*obj, @@ -107,9 +229,20 @@ AccessibleTable_getRowDescription (AccessibleTable *obj, +/** + * AccessibleTable_getColumnDescription: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @column: the specified table column, zero-indexed. + * + * Get a text description of a particular table column. This differs from + * AccessibleTable_getColumnHeader, which returns an #Accessible. + * + * Returns: a UTF-8 string describing the specified table column, if available. + * + **/ char * AccessibleTable_getColumnDescription (AccessibleTable *obj, - long column) + long int column) { return (char *) Accessibility_Table_getColumnDescription (*obj, @@ -118,10 +251,22 @@ AccessibleTable_getColumnDescription (AccessibleTable *obj, +/** + * AccessibleTable_getRowExtentAt: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @row: the specified table row, zero-indexed. + * @column: the specified table column, zero-indexed. + * + * Get the number of rows spanned by the table cell at the specific row and column. + * (some tables can have cells which span multiple rows and/or columns). + * + * Returns: a long integer indicating the number of rows spanned by the specified cell. + * + **/ long AccessibleTable_getRowExtentAt (AccessibleTable *obj, - long row, - long column) + long int row, + long int column) { return (long) Accessibility_Table_getRowExtentAt (*obj, @@ -130,10 +275,22 @@ AccessibleTable_getRowExtentAt (AccessibleTable *obj, +/** + * AccessibleTable_getColumnExtentAt: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @row: the specified table row, zero-indexed. + * @column: the specified table column, zero-indexed. + * + * Get the number of columns spanned by the table cell at the specific row and column. + * (some tables can have cells which span multiple rows and/or columns). + * + * Returns: a long integer indicating the number of columns spanned by the specified cell. + * + **/ long AccessibleTable_getColumnExtentAt (AccessibleTable *obj, - long row, - long column) + long int row, + long int column) { return (long) Accessibility_Table_getColumnExtentAt (*obj, @@ -141,10 +298,20 @@ AccessibleTable_getColumnExtentAt (AccessibleTable *obj, } - +/** + * AccessibleTable_getRowHeader: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @row: the specified table row, zero-indexed. + * + * Get the header associated with a table row, if available. This differs from + * AccessibleTable_getRowDescription, which returns a string. + * + * Returns: a #Accessible representatin of the specified table row, if available. + * + **/ Accessible * AccessibleTable_getRowHeader (AccessibleTable *obj, - long row) + long int row) { return (Accessible *) Accessibility_Table_getRowHeader (*obj, @@ -153,9 +320,20 @@ AccessibleTable_getRowHeader (AccessibleTable *obj, +/** + * AccessibleTable_getColumnHeader: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @column: the specified table column, zero-indexed. + * + * Get the header associated with a table column, if available. This differs from + * AccessibleTable_getColumnDescription, which returns a string. + * + * Returns: a #Accessible representatin of the specified table column, if available. + * + **/ Accessible * AccessibleTable_getColumnHeader (AccessibleTable *obj, - long column) + long int column) { return (Accessible *) Accessibility_Table_getColumnHeader (*obj, @@ -163,7 +341,15 @@ AccessibleTable_getColumnHeader (AccessibleTable *obj, } - +/** + * AccessibleTable_getNSelectedRows: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * + * Query a table to find out how many rows are currently selected. Not all tables + * support row selection. + * + * Returns: a long integer indicating the number of rows currently selected. + **/ long AccessibleTable_getNSelectedRows (AccessibleTable *obj) { @@ -173,9 +359,19 @@ AccessibleTable_getNSelectedRows (AccessibleTable *obj) +/** + * AccessibleTable_getSelectedRows: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @selectedRows: a doubly indirected pointer which will be set to the address + * of an array of long integers, specifying which rows are currently selected. + * + * Query a table for a list of indices of rows which are currently selected. + * + * Returns: a long integer indicating the length of the array returned in @selectedRows. + **/ long AccessibleTable_getSelectedRows (AccessibleTable *obj, - long **selectedRows) + long int **selectedRows) { Accessibility_LongSeq *rows = Accessibility_Table_getSelectedRows (*obj, &ev); CORBA_long *i; @@ -196,6 +392,15 @@ AccessibleTable_getSelectedRows (AccessibleTable *obj, +/** + * AccessibleTable_getNSelectedColumns: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * + * Query a table to find out how many columnss are currently selected. Not all tables + * support column selection. + * + * Returns: a long integer indicating the number of columns currently selected. + **/ long AccessibleTable_getNSelectedColumns (AccessibleTable *obj) { @@ -204,9 +409,20 @@ AccessibleTable_getNSelectedColumns (AccessibleTable *obj) } +/** + * AccessibleTable_getSelectedColumns: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @selectedColumns: a doubly indirected pointer which will be set to the address + * of an array of long integers, specifying which columns are currently selected. + * + * Query a table for a list of indices of columns which are currently selected. + * Not all tables support column selection. + * + * Returns: a long integer indicating the length of the array returned in @selectedColumns. + **/ long AccessibleTable_getSelectedColumns (AccessibleTable *obj, - long **selectedColumns) + long int **selectedColumns) { Accessibility_LongSeq *columns = Accessibility_Table_getSelectedColumns (*obj, &ev); CORBA_long *i; @@ -226,9 +442,19 @@ AccessibleTable_getSelectedColumns (AccessibleTable *obj, } +/** + * AccessibleTable_isRowSelected: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @row: + * + * Determine whether a table row is selected. Not all tables support row selection. + * + * Returns: #TRUE if the specified row is currently selected, #FALSE if not. + * + **/ boolean AccessibleTable_isRowSelected (AccessibleTable *obj, - long row) + long int row) { return (boolean) Accessibility_Table_isRowSelected (*obj, @@ -237,9 +463,20 @@ AccessibleTable_isRowSelected (AccessibleTable *obj, +/** + * AccessibleTable_isColumnSelected: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @column: + * + * Determine whether specified table column is selected. + * Not all tables support column selection. + * + * Returns: #TRUE if the specified column is currently selected, #FALSE if not. + * + **/ boolean AccessibleTable_isColumnSelected (AccessibleTable *obj, - long column) + long int column) { return (boolean) Accessibility_Table_isColumnSelected (*obj, @@ -248,12 +485,23 @@ AccessibleTable_isColumnSelected (AccessibleTable *obj, +/** + * AccessibleTable_isSelected: + * @obj: a pointer to the #AccessibleTable implementor on which to operate. + * @row: + * @column: + * + * Determine whether the cell at a specific row and column is selected. + * + * Returns: #TRUE if the specified cell is currently selected, #FALSE if not. + * + **/ boolean AccessibleTable_isSelected (AccessibleTable *obj, - long row, - long column) + long int row, + long int column) { -return (boolean) + return (boolean) Accessibility_Table_isSelected (*obj, (CORBA_long) row, (CORBA_long) column, &ev); } diff --git a/docs/at-spi-sections.txt b/docs/at-spi-sections.txt index 569b605..16579ab 100644 --- a/docs/at-spi-sections.txt +++ b/docs/at-spi-sections.txt @@ -78,6 +78,7 @@ Accessible_getText Accessible_queryInterface AccessibleRole +AccessibleRole_getName
@@ -100,6 +101,7 @@ AccessibleAction_unref AccessibleAction_getNActions AccessibleAction_doAction AccessibleAction_getKeyBinding +AccessibleAction_getName AccessibleAction_getDescription
@@ -128,7 +130,7 @@ AccessibleEditableText_insertText AccessibleEditableText_cutText AccessibleEditableText_pasteText AccessibleEditableText_setTextContents -AccessibleEditableText_setRunAttributes +AccessibleEditableText_setAttributes
@@ -170,6 +172,7 @@ AccessibleSelection_selectAll AccessibleTable Interface AccessibleTable_ref AccessibleTable_unref +AccessibleTable_getAccessibleAt AccessibleTable_getCaption AccessibleTable_getColumnAtIndex AccessibleTable_getColumnDescription @@ -190,7 +193,6 @@ AccessibleTable_getSummary AccessibleTable_isColumnSelected AccessibleTable_isRowSelected AccessibleTable_isSelected -AccessibleTable_refAt