atk-1.0/atk/atktablecell.h

0001 /* ATK -  Accessibility Toolkit
0002  * Copyright 2014 SUSE LLC.
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public
0015  * License along with this library; if not, write to the
0016  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0017  * Boston, MA 02111-1307, USA.
0018  */
0019
0020 #ifndef __ATK_TABLE_CELL_H__
0021 #define __ATK_TABLE_CELL_H__
0022
0023 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined(__ATK_H_INSIDE__) && !defined(ATK_COMPILATION)
0024 #error "Only <atk/atk.h> can be included directly."
0025 #endif
0026
0027 #include <atk/atkobject.h>
0028
0029 G_BEGIN_DECLS
0030
0031 #define ATK_TYPE_TABLE_CELL (atk_table_cell_get_type ())
0032 #define ATK_IS_TABLE_CELL(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_TABLE_CELL)
0033 #define ATK_TABLE_CELL(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_TABLE_CELL, AtkTableCell)
0034 #define ATK_TABLE_CELL_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_TABLE_CELL, AtkTableCellIface))
0035
0036 #ifndef _TYPEDEF_ATK_TABLE_CELL_
0037 #define _TYPEDEF_ATK_TABLE_CELL_
0038 typedef struct _AtkTableCell AtkTableCell;
0039 #endif
0040 typedef struct _AtkTableCellIface AtkTableCellIface;
0041
0042 /**
0043  * AtkTableCellIface:
0044  * @get_column_span: virtual function that returns the number of
0045  *   columns occupied by this cell accessible
0046  * @get_column_header_cells: virtual function that returns the column
0047  *   headers as an array of cell accessibles
0048  * @get_position: virtual function that retrieves the tabular position
0049  *   of this cell
0050  * @get_row_span: virtual function that returns the number of rows
0051  *   occupied by this cell
0052  * @get_row_header_cells: virtual function that returns the row
0053  *   headers as an array of cell accessibles
0054  * @get_row_column_span: virtual function that get the row an column
0055  *   indexes and span of this cell
0056  * @get_table: virtual function that returns a reference to the
0057  *   accessible of the containing table
0058  *
0059  * AtkTableCell is an interface for cells inside an #AtkTable.
0060  *
0061  * Since: 2.12
0062  */
0063 struct _AtkTableCellIface
0064 {
0065   /*< private >*/
0066   GTypeInterface parent;
0067
0068   /*< public >*/
0069   gint (*get_column_span) (AtkTableCell *cell);
0070   GPtrArray *(*get_column_header_cells) (AtkTableCell *cell);
0071   gboolean (*get_position) (AtkTableCell *cell,
0072                             gint *row,
0073                             gint *column);
0074   gint (*get_row_span) (AtkTableCell *cell);
0075   GPtrArray *(*get_row_header_cells) (AtkTableCell *cell);
0076   gboolean (*get_row_column_span) (AtkTableCell *cell,
0077                                    gint *row,
0078                                    gint *column,
0079                                    gint *row_span,
0080                                    gint *column_span);
0081   AtkObject *(*get_table) (AtkTableCell *cell);
0082 };
0083
0084 ATK_AVAILABLE_IN_2_12
0085 GType atk_table_cell_get_type (void);
0086
0087 ATK_AVAILABLE_IN_2_12
0088 gint atk_table_cell_get_column_span (AtkTableCell *cell);
0089 ATK_AVAILABLE_IN_2_12
0090 GPtrArray *atk_table_cell_get_column_header_cells (AtkTableCell *cell);
0091 ATK_AVAILABLE_IN_2_12
0092 gboolean atk_table_cell_get_position (AtkTableCell *cell,
0093                                       gint *row,
0094                                       gint *column);
0095 ATK_AVAILABLE_IN_2_12
0096 gint atk_table_cell_get_row_span (AtkTableCell *cell);
0097 ATK_AVAILABLE_IN_2_12
0098 GPtrArray *atk_table_cell_get_row_header_cells (AtkTableCell *cell);
0099 ATK_AVAILABLE_IN_2_12
0100 gboolean atk_table_cell_get_row_column_span (AtkTableCell *cell,
0101                                              gint *row,
0102                                              gint *column,
0103                                              gint *row_span,
0104                                              gint *column_span);
0105 ATK_AVAILABLE_IN_2_12
0106 AtkObject *atk_table_cell_get_table (AtkTableCell *cell);
0107
0108 G_END_DECLS
0109
0110 #endif /* __ATK_TABLE_CELL_H__ */