diff options
| author | Alejandro Piñeiro <apinheiro@igalia.com> | 2014-02-10 17:02:11 +0100 |
|---|---|---|
| committer | Alejandro Piñeiro <apinheiro@igalia.com> | 2014-02-18 17:23:51 +0100 |
| commit | a3b6bb15885b5c59fc7bf2283bbb1fb06b602ba7 (patch) | |
| tree | cc2049bef7e562d61187557e3862a398566f51a4 /atk/atktablecell.c | |
| parent | 1349b6330379191a825955fc8107079ec742bb68 (diff) | |
| download | atk-a3b6bb15885b5c59fc7bf2283bbb1fb06b602ba7.tar.gz | |
doc: documentation for AtkTableCell, AtkTable, deprecations and padding
Index based methods forced ATK implementations to expose
the cells are direct children of the table. Something that
was complex in the practice. In fact some implementation
were not doing it, making the index-based methods not
properly implemented. This became even more clear with the
addition of AtkTableCell.
Additionally, this patch documents AtkTableCell and that
those cells should implement the newly added AtkTableCell
interface.
Diffstat (limited to 'atk/atktablecell.c')
| -rw-r--r-- | atk/atktablecell.c | 42 |
1 files changed, 28 insertions, 14 deletions
diff --git a/atk/atktablecell.c b/atk/atktablecell.c index 20baf1a..9218b09 100644 --- a/atk/atktablecell.c +++ b/atk/atktablecell.c @@ -19,14 +19,28 @@ #include "atktablecell.h" + +/** + * SECTION:atktablecell + * @Short_description: The ATK interface implemented for a cell inside + * a two-dimentional #AtkTable + * @Title:AtkTableCell + * + * Being #AtkTable a component which present elements ordered via rows + * and columns, an #AtkTableCell is the interface which each of those + * elements, so "cells" should implement. + * + * See also #AtkTable. + */ + typedef AtkTableCellIface AtkTableCellInterface; G_DEFINE_INTERFACE (AtkTableCell, atk_table_cell, ATK_TYPE_OBJECT) static gboolean atk_table_cell_real_get_row_column_span (AtkTableCell *cell, - gint *row, - gint *column, - gint *row_span, - gint *column_span); + gint *row, + gint *column, + gint *row_span, + gint *column_span); static void atk_table_cell_default_init (AtkTableCellInterface *iface) @@ -85,8 +99,8 @@ atk_table_cell_get_column_header_cells (AtkTableCell *cell) /** * atk_table_cell_get_position: * @cell: a GObject instance that implements AtkTableCellIface - * row: (out): the row of the given cell. - * column: (out): the column of the given cell. + * @row: (out): the row of the given cell. + * @column: (out): the column of the given cell. * * Retrieves the tabular position of this cell. * @@ -181,10 +195,10 @@ atk_table_cell_get_row_header_cells (AtkTableCell *cell) */ gboolean atk_table_cell_get_row_column_span (AtkTableCell *cell, - gint *row, - gint *column, - gint *row_span, - gint *column_span) + gint *row, + gint *column, + gint *row_span, + gint *column_span) { AtkTableCellIface *iface; gint local_row = 0, local_column = 0; @@ -234,10 +248,10 @@ atk_table_cell_get_table (AtkTableCell *cell) static gboolean atk_table_cell_real_get_row_column_span (AtkTableCell *cell, - gint *row, - gint *column, - gint *row_span, - gint *column_span) + gint *row, + gint *column, + gint *row_span, + gint *column_span) { atk_table_cell_get_position (cell, row, column); *row_span = atk_table_cell_get_row_span (cell); |