* AT-SPI - Assistive Technology Service Provider Interface
* (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
*
- * Copyright 2001 Sun Microsystems Inc.
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
Accessible *
AccessibleTable_getCaption (AccessibleTable *obj)
{
- return cspi_object_add (
- Accessibility_Table__get_caption (CSPI_OBJREF (obj), cspi_ev ()));
+ Accessible *retval;
+
+ cspi_return_val_if_fail (obj != NULL, NULL);
+
+ retval = cspi_object_add (
+ Accessibility_Table__get_caption (CSPI_OBJREF (obj), cspi_ev ()));
+ cspi_return_val_if_ev ("getCaption", NULL);
+ return retval;
}
/**
Accessible *
AccessibleTable_getSummary (AccessibleTable *obj)
{
- return cspi_object_add (
- Accessibility_Table__get_summary (CSPI_OBJREF (obj), cspi_ev ()));
+ Accessible *retval;
+
+ cspi_return_val_if_fail (obj != NULL, NULL);
+
+retval = cspi_object_add (
+ Accessibility_Table__get_summary (CSPI_OBJREF (obj), cspi_ev ()));
+ cspi_return_val_if_ev ("getSummary", NULL);
+ return retval;
}
/**
retval =
Accessibility_Table__get_nColumns (CSPI_OBJREF (obj), cspi_ev ());
- cspi_return_val_if_ev ("", -1);
+ cspi_return_val_if_ev ("getNColumns", -1);
return retval;
}
long int row,
long int column)
{
- return cspi_object_add (
- Accessibility_Table_getAccessibleAt (
- CSPI_OBJREF (obj), (CORBA_long) row,
- (CORBA_long) column, cspi_ev ()));
+ Accessible *retval;
+
+ cspi_return_val_if_fail (obj != NULL, NULL);
+
+ retval = cspi_object_add (
+ Accessibility_Table_getAccessibleAt (
+ CSPI_OBJREF (obj), row,
+ column, cspi_ev ()));
+ cspi_return_val_if_ev ("getAccessibleAt", NULL);
+ return retval;
}
/**
retval =
Accessibility_Table_getIndexAt (
- CSPI_OBJREF (obj), (CORBA_long) row,
- (CORBA_long) column, cspi_ev ());
+ CSPI_OBJREF (obj), row,
+ column, cspi_ev ());
cspi_return_val_if_ev ("getIndexAt", -1);
retval =
Accessibility_Table_getRowAtIndex (CSPI_OBJREF (obj),
- (CORBA_long) index, cspi_ev ());
+ index, cspi_ev ());
- cspi_return_val_if_ev ("", -1);
+ cspi_return_val_if_ev ("getRowAtIndex", -1);
return retval;
}
retval =
Accessibility_Table_getColumnAtIndex (CSPI_OBJREF (obj),
- (CORBA_long) index, cspi_ev ());
+ index, cspi_ev ());
cspi_return_val_if_ev ("getColumnAtIndex", -1);
retval =
Accessibility_Table_getRowDescription (CSPI_OBJREF (obj),
- (CORBA_long) row, cspi_ev ());
+ row, cspi_ev ());
cspi_return_val_if_ev ("getRowDescription", NULL);
retval =
Accessibility_Table_getColumnDescription (CSPI_OBJREF (obj),
- (CORBA_long) column, cspi_ev ());
+ column, cspi_ev ());
cspi_return_val_if_ev ("getColumnDescription", NULL);
retval =
Accessibility_Table_getRowExtentAt (
- CSPI_OBJREF (obj), (CORBA_long) row,
- (CORBA_long) column, cspi_ev ());
+ CSPI_OBJREF (obj), row,
+ column, cspi_ev ());
cspi_return_val_if_ev ("getRowExtentAt", -1);
retval =
Accessibility_Table_getColumnExtentAt (
- CSPI_OBJREF (obj), (CORBA_long) row,
- (CORBA_long) column, cspi_ev ());
+ CSPI_OBJREF (obj), row,
+ column, cspi_ev ());
cspi_return_val_if_ev ("getColumnExtentAt", -1);
AccessibleTable_getRowHeader (AccessibleTable *obj,
long int row)
{
- return cspi_object_add (
- Accessibility_Table_getRowHeader (CSPI_OBJREF (obj),
- (CORBA_long) row, cspi_ev ()));
+ Accessible *retval;
+
+ cspi_return_val_if_fail (obj != NULL, NULL);
+
+ retval = cspi_object_add (
+ Accessibility_Table_getRowHeader (CSPI_OBJREF (obj),
+ row, cspi_ev ()));
+ cspi_return_val_if_ev ("getRowHeader", NULL);
+
+ return retval;
}
/**
AccessibleTable_getColumnHeader (AccessibleTable *obj,
long int column)
{
- return cspi_object_add (
- Accessibility_Table_getColumnHeader (CSPI_OBJREF (obj),
- (CORBA_long) column, cspi_ev ()));
+ Accessible *retval;
+
+ cspi_return_val_if_fail (obj != NULL, NULL);
+
+ retval = cspi_object_add (
+ Accessibility_Table_getColumnHeader (CSPI_OBJREF (obj),
+ column, cspi_ev ()));
+ cspi_return_val_if_ev ("getColumnHeader", NULL);
+
+ return retval;
}
/**
static long
cspi_long_seq_to_array (Accessibility_LongSeq *seq, long int **array)
{
- long *j, length, i;
+ long *j;
+ long length, i;
if (!cspi_check_ev ("getSelectionItems"))
{
rows = Accessibility_Table_getSelectedRows (CSPI_OBJREF (obj), cspi_ev ());
+ cspi_return_val_if_ev ("getSelectedRows", -1);
+
return cspi_long_seq_to_array (rows, selectedRows);
}
* 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
+ * Query a table to find out how many columns are currently selected. Not all tables
* support column selection.
*
* Returns: a long integer indicating the number of columns currently selected.
columns = Accessibility_Table_getSelectedColumns (CSPI_OBJREF (obj), cspi_ev ());
+ cspi_return_val_if_ev ("getSelectedColumns", -1);
return cspi_long_seq_to_array (columns, selectedColumns);
}
/**
* AccessibleTable_isRowSelected:
* @obj: a pointer to the #AccessibleTable implementor on which to operate.
- * @row:
+ * @row: the zero-indexed row number of the row being queried.
*
* Determine whether a table row is selected. Not all tables support row selection.
*
retval =
Accessibility_Table_isRowSelected (CSPI_OBJREF (obj),
- (CORBA_long) row, cspi_ev ());
+ row, cspi_ev ());
cspi_return_val_if_ev ("isRowSelected", FALSE);
/**
* AccessibleTable_isColumnSelected:
* @obj: a pointer to the #AccessibleTable implementor on which to operate.
- * @column:
+ * @column: the zero-indexed column number of the column being queried.
*
* Determine whether specified table column is selected.
* Not all tables support column selection.
retval =
Accessibility_Table_isColumnSelected (CSPI_OBJREF (obj),
- (CORBA_long) column, cspi_ev ());
+ column, cspi_ev ());
cspi_return_val_if_ev ("isColumnSelected", FALSE);
/**
* AccessibleTable_addRowSelection:
* @obj: a pointer to the #AccessibleTable implementor on which to operate.
- * @row:
+ * @row: the zero-indexed row number of the row being selected.
*
* Select the specified row, adding it to the current row selection.
* Not all tables support row selection.
retval =
Accessibility_Table_addRowSelection (CSPI_OBJREF (obj),
- (CORBA_long) row, cspi_ev ());
+ row, cspi_ev ());
cspi_return_val_if_ev ("addRowSelection", FALSE);
/**
* AccessibleTable_addColumnSelection:
* @obj: a pointer to the #AccessibleTable implementor on which to operate.
- * @column:
+ * @column: the zero-indexed column number of the column being selected.
*
* Select the specified column, adding it to the current column selection.
* Not all tables support column selection.
retval =
Accessibility_Table_addColumnSelection (CSPI_OBJREF (obj),
- (CORBA_long) column, cspi_ev ());
+ column, cspi_ev ());
cspi_return_val_if_ev ("addColumnSelection", FALSE);
/**
* AccessibleTable_removeRowSelection:
* @obj: a pointer to the #AccessibleTable implementor on which to operate.
- * @row:
+ * @row: the zero-indexed number of the row being deselected.
*
* De-select the specified row, removing it to the current row selection.
* Not all tables support row selection.
retval =
Accessibility_Table_removeRowSelection (CSPI_OBJREF (obj),
- (CORBA_long) row, cspi_ev ());
+ row, cspi_ev ());
cspi_return_val_if_ev ("removeRowSelection", FALSE);
/**
* AccessibleTable_removeColumnSelection:
* @obj: a pointer to the #AccessibleTable implementor on which to operate.
- * @column:
+ * @column: the zero-indexed column number of the column being de-selected.
*
* De-select the specified column, removing it to the current column selection.
* Not all tables support column selection.
retval =
Accessibility_Table_removeColumnSelection (CSPI_OBJREF (obj),
- (CORBA_long) column, cspi_ev ());
+ column, cspi_ev ());
cspi_return_val_if_ev ("removeColumnSelection", FALSE);
}
/**
+ * AccessibleTable_getRowColumnExtentsAtIndex:
+ * @obj: a pointer to the #AccessibleTable implementor on which to operate.
+ * @index: the index of the Table child whose row/column
+ * extents are requested.
+ * @row: back-filled with the first table row associated with
+ * the cell with child index \c index.
+ * @col: back-filled with the first table column associated
+ * with the cell with child index \c index.
+ * @row_extents: back-filled with the number of table rows
+ * across which child \c i extends.
+ * @col_extents: back-filled with the number of table columns
+ * across which child \c i extends.
+ * @is_selected: a boolean which is back-filled with \c True
+ * if the child at index \c i corresponds to a selected table cell,
+ * \c False otherwise.
+ *
+ * Given a child index, determine the row and column indices and
+ * extents, and whether the cell is currently selected. If
+ * the child at \c index is not a cell (for instance, if it is
+ * a summary, caption, etc.), \c False is returned.
+ *
+ * Example:
+ * If the Table child at index '6' extends across columns 5 and 6 of
+ * row 2 of a Table instance, and is currently selected, then
+ *
+ * retval = table::getRowColumnExtentsAtIndex (6, row, col,
+ * row_extents,
+ * col_extents,
+ * is_selected);
+ *
+ * will return True, and after the call
+ * row, col, row_extents, col_extents,
+ * and \c is_selected will contain 2, 5, 1, 2, and
+ * True, respectively.
+ *
+ * Returns: \c True if the index is associated with a valid table
+ * cell, \c False if the index does not correspond to a cell. If
+ * \c False is returned, the values of the out parameters are
+ * undefined.
+ *
+ * Since AT-SPI 1.7.0
+ **/
+SPIBoolean
+AccessibleTable_getRowColumnExtentsAtIndex (AccessibleTable *obj,
+ long int index, long int *row, long int *col,
+ long int *row_extents, long int *col_extents,
+ long int *is_selected){
+ SPIBoolean retval;
+ CORBA_long cRow, cCol, cRow_extents, cCol_extents;
+ CORBA_boolean cIs_selected;
+
+ cspi_return_val_if_fail (obj != NULL, FALSE);
+
+ retval = Accessibility_Table_getRowColumnExtentsAtIndex (CSPI_OBJREF (obj),
+ index, &cRow, &cCol,
+ &cRow_extents, &cCol_extents,
+ &cIs_selected,
+ cspi_ev ());
+
+ if (!cspi_check_ev ("getRowColumnExtentsAtIndex")){
+
+ *row = 0;
+ *col = 0;
+ *row_extents = 0;
+ *col_extents = 0;
+ *is_selected = FALSE;
+ retval = FALSE;
+ }
+
+ else {
+ *row = cRow;
+ *col = cCol;
+ *row_extents = cRow_extents;;
+ *col_extents = cCol_extents;
+ *is_selected = cIs_selected;;
+ }
+
+ return retval;
+
+}
+
+
+/**
* AccessibleTable_isSelected:
* @obj: a pointer to the #AccessibleTable implementor on which to operate.
- * @row:
- * @column:
+ * @row: the zero-indexed row of the cell being queried.
+ * @column: the zero-indexed column of the cell being queried.
*
* Determine whether the cell at a specific row and column is selected.
*
retval =
Accessibility_Table_isSelected (CSPI_OBJREF (obj),
- (CORBA_long) row,
- (CORBA_long) column, cspi_ev ());
+ row,
+ column, cspi_ev ());
cspi_return_val_if_ev ("isSelected", FALSE);
projects / platform / core / uifw / at-spi2-atk.git / blobdiff