+/**
+ * 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)
{
+/**
+ * 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)
{
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)
{
}
-
+/**
+ * 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);
+/**
+ * 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)
{
+/**
+ * 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)
{
+/**
+ * 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)
{
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)
{
+/**
+ * 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)
{
+/**
+ * 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)
{
+/**
+ * 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)
{
}
+/**
+ * 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,
}
+/**
+ * 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,
+/**
+ * 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)
+/**
+ * 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)
+/**
+ * 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,
+/**
+ * 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,
+/**
+ * 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,
+/**
+ * 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,
}
-
+/**
+ * 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,
+/**
+ * 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,
}
-
+/**
+ * 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)
{
+/**
+ * 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;
+/**
+ * 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)
{
}
+/**
+ * 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;
}
+/**
+ * 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,
+/**
+ * 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,
+/**
+ * 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);
}
projects / platform / core / uifw / at-spi2-atk.git / commitdiff