diff options
author | Alejandro Piñeiro <apinheiro@igalia.com> | 2014-02-18 18:56:44 +0100 |
---|---|---|
committer | Alejandro Piñeiro <apinheiro@igalia.com> | 2014-02-18 18:56:44 +0100 |
commit | de1865db60097bda92af09fd8ef43b96636e5cc4 (patch) | |
tree | 0c72a7d6ef012ec9c566fe990211a3163dc02b02 | |
parent | fdf5f9c1cb5af00fd9a85534bc1460fa3d2869e1 (diff) | |
download | atk-de1865db60097bda92af09fd8ef43b96636e5cc4.tar.gz |
doc: more AtkTableCell documentation
* Adds when the symbols were added.
* Document the interface virtual methods.
-rw-r--r-- | atk/atktablecell.c | 14 | ||||
-rwxr-xr-x | atk/atktablecell.h | 17 | ||||
-rw-r--r-- | docs/atk-sections.txt | 1 |
3 files changed, 32 insertions, 0 deletions
diff --git a/atk/atktablecell.c b/atk/atktablecell.c index 9218b09..7a07c7b 100644 --- a/atk/atktablecell.c +++ b/atk/atktablecell.c @@ -56,6 +56,8 @@ atk_table_cell_default_init (AtkTableCellInterface *iface) * * Returns: a gint representing the number of columns occupied by this cell, * or 0 if the cell does not implement this method. + * + * Since: 2.12 */ gint atk_table_cell_get_column_span (AtkTableCell *cell) @@ -80,6 +82,8 @@ atk_table_cell_get_column_span (AtkTableCell *cell) * * Returns: (element-type AtkObject) (transfer full): a GPtrArray of AtkObjects * representing the column header cells. + * + * Since: 2.12 */ GPtrArray * atk_table_cell_get_column_header_cells (AtkTableCell *cell) @@ -105,6 +109,8 @@ atk_table_cell_get_column_header_cells (AtkTableCell *cell) * Retrieves the tabular position of this cell. * * Returns: TRUE if successful; FALSE otherwise. + * + * Since: 2.12 */ gboolean atk_table_cell_get_position (AtkTableCell *cell, @@ -137,6 +143,8 @@ atk_table_cell_get_position (AtkTableCell *cell, * * Returns: a gint representing the number of rows occupied by this cell, * or 0 if the cell does not implement this method. + * + * Since: 2.12 */ gint atk_table_cell_get_row_span (AtkTableCell *cell) @@ -161,6 +169,8 @@ atk_table_cell_get_row_span (AtkTableCell *cell) * * Returns: (element-type AtkObject) (transfer full): a GPtrArray of AtkObjects * representing the row header cells. + * + * Since: 2.12 */ GPtrArray * atk_table_cell_get_row_header_cells (AtkTableCell *cell) @@ -192,6 +202,8 @@ atk_table_cell_get_row_header_cells (AtkTableCell *cell) * on the object. * * Returns: TRUE if successful; FALSE otherwise. + * + * Since: 2.12 */ gboolean atk_table_cell_get_row_column_span (AtkTableCell *cell, @@ -230,6 +242,8 @@ atk_table_cell_get_row_column_span (AtkTableCell *cell, * Returns a reference to the accessible of the containing table. * * Returns: (transfer full): the atk object for the containing table. + * + * Since: 2.12 */ AtkObject * atk_table_cell_get_table (AtkTableCell *cell) diff --git a/atk/atktablecell.h b/atk/atktablecell.h index ef4bfda..b168451 100755 --- a/atk/atktablecell.h +++ b/atk/atktablecell.h @@ -39,6 +39,23 @@ typedef struct _AtkTableCell AtkTableCell; #endif typedef struct _AtkTableCellIface AtkTableCellIface; +/** + * AtkTableCellIface: + * @get_column_span: virtual function that returns the number of + * columns occupied by this cell accessible. @Since: 2.12 + * @get_column_header_cells: virtual function that returns the column + * headers as an array of cell accessibles. @Since: 2.12 + * @get_position: virtual function that retrieves the tabular position + * of this cell. @Since: 2.12 + * @get_row_span: virtual function that returns the number of rows + * occupied by this cell. @Since: 2.12 + * @get_row_header_cells: virtual function that returns the row + * headers as an array of cell accessibles. @Since: 2.12 + * @get_row_column_span: virtual function that get the row an column + * indexes and span of this cell. @Since: 2.12 + * @get_table: virtual function that returns a reference to the + * accessible of the containing table. @Since: 2.12 + */ struct _AtkTableCellIface { GTypeInterface parent; diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt index 83ce668..8233e3d 100644 --- a/docs/atk-sections.txt +++ b/docs/atk-sections.txt @@ -398,6 +398,7 @@ atk_table_get_type <FILE>atktablecell</FILE> <TITLE>AtkTableCell</TITLE> AtkTableCell +AtkTableCellIface atk_table_cell_get_column_span atk_table_cell_get_column_header_cells atk_table_cell_get_position |