atk/atktablecell.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2014 SUSE LLC.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __ATK_TABLE_CELL_H__
  21 #define __ATK_TABLE_CELL_H__
  22
  23 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  24 #error "Only <atk/atk.h> can be included directly."
  25 #endif
  26
  27 #include <atk/atkobject.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define ATK_TYPE_TABLE_CELL                    (atk_table_cell_get_type ())
  32 #define ATK_IS_TABLE_CELL(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_TABLE_CELL)
  33 #define ATK_TABLE_CELL(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_TABLE_CELL, AtkTableCell)
  34 #define ATK_TABLE_CELL_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_TABLE_CELL, AtkTableCellIface))
  35
  36 #ifndef _TYPEDEF_ATK_TABLE_CELL_
  37 #define _TYPEDEF_ATK_TABLE_CELL_
  38 typedef struct _AtkTableCell AtkTableCell;
  39 #endif
  40 typedef struct _AtkTableCellIface AtkTableCellIface;
  41
  42 /**
  43  * AtkTableCellIface:
  44  * @get_column_span: virtual function that returns the number of
  45  *   columns occupied by this cell accessible
  46  * @get_column_header_cells: virtual function that returns the column
  47  *   headers as an array of cell accessibles
  48  * @get_position: virtual function that retrieves the tabular position
  49  *   of this cell
  50  * @get_row_span: virtual function that returns the number of rows
  51  *   occupied by this cell
  52  * @get_row_header_cells: virtual function that returns the row
  53  *   headers as an array of cell accessibles
  54  * @get_row_column_span: virtual function that get the row an column
  55  *   indexes and span of this cell
  56  * @get_table: virtual function that returns a reference to the
  57  *   accessible of the containing table
  58  *
  59  * AtkTableCell is an interface for cells inside an #AtkTable.
  60  *
  61  * Since: 2.12
  62  */
  63 struct _AtkTableCellIface
  64 {
  65   /*< private >*/
  66   GTypeInterface parent;
  67
  68   /*< public >*/
  69   gint          (*get_column_span)         (AtkTableCell *cell);
  70   GPtrArray *   (*get_column_header_cells) (AtkTableCell *cell);
  71   gboolean      (*get_position)            (AtkTableCell *cell,
  72                                             gint         *row,
  73                                             gint         *column);
  74   gint          (*get_row_span)            (AtkTableCell *cell);
  75   GPtrArray *   (*get_row_header_cells)    (AtkTableCell *cell);
  76   gboolean      (*get_row_column_span)     (AtkTableCell *cell,
  77                                             gint         *row,
  78                                             gint         *column,
  79                                             gint         *row_span,
  80                                             gint         *column_span);
  81   AtkObject *   (*get_table)               (AtkTableCell *cell);
  82 };
  83
  84 ATK_AVAILABLE_IN_2_12
  85 GType atk_table_cell_get_type (void);
  86
  87 ATK_AVAILABLE_IN_2_12
  88 gint        atk_table_cell_get_column_span         (AtkTableCell *cell);
  89 ATK_AVAILABLE_IN_2_12
  90 GPtrArray * atk_table_cell_get_column_header_cells (AtkTableCell *cell);
  91 ATK_AVAILABLE_IN_2_12
  92 gboolean    atk_table_cell_get_position            (AtkTableCell *cell,
  93                                                     gint         *row,
  94                                                     gint         *column);
  95 ATK_AVAILABLE_IN_2_12
  96 gint        atk_table_cell_get_row_span            (AtkTableCell *cell);
  97 ATK_AVAILABLE_IN_2_12
  98 GPtrArray * atk_table_cell_get_row_header_cells    (AtkTableCell *cell);
  99 ATK_AVAILABLE_IN_2_12
 100 gboolean    atk_table_cell_get_row_column_span     (AtkTableCell *cell,
 101                                                     gint         *row,
 102                                                     gint         *column,
 103                                                     gint         *row_span,
 104                                                     gint         *column_span);
 105 ATK_AVAILABLE_IN_2_12
 106 AtkObject * atk_table_cell_get_table               (AtkTableCell *cell);
 107
 108 G_END_DECLS
 109
 110 #endif /* __ATK_TABLE_CELL_H__ */