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 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  21 #error "Only <atk/atk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __ATK_TABLE_CELL_H__
  25 #define __ATK_TABLE_CELL_H__
  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. @Since: 2.12
  46  * @get_column_header_cells: virtual function that returns the column
  47  * headers as an array of cell accessibles. @Since: 2.12
  48  * @get_position: virtual function that retrieves the tabular position
  49  * of this cell. @Since: 2.12
  50  * @get_row_span: virtual function that returns the number of rows
  51  * occupied by this cell. @Since: 2.12
  52  * @get_row_header_cells: virtual function that returns the row
  53  * headers as an array of cell accessibles. @Since: 2.12
  54  * @get_row_column_span: virtual function that get the row an column
  55  * indexes and span of this cell. @Since: 2.12
  56  * @get_table: virtual function that returns a reference to the
  57  * accessible of the containing table. @Since: 2.12
  58  */
  59 struct _AtkTableCellIface
  60 {
  61   GTypeInterface parent;
  62
  63   gint          (*get_column_span)         (AtkTableCell *cell);
  64   GPtrArray *   (*get_column_header_cells) (AtkTableCell *cell);
  65   gboolean      (*get_position)            (AtkTableCell *cell,
  66                                             gint         *row,
  67                                             gint         *column);
  68   gint          (*get_row_span)            (AtkTableCell *cell);
  69   GPtrArray *   (*get_row_header_cells)    (AtkTableCell *cell);
  70   gboolean      (*get_row_column_span)     (AtkTableCell *cell,
  71                                             gint         *row,
  72                                             gint         *column,
  73                                             gint         *row_span,
  74                                             gint         *column_span);
  75   AtkObject *   (*get_table)               (AtkTableCell *cell);
  76 };
  77
  78 ATK_AVAILABLE_IN_2_12
  79 GType atk_table_cell_get_type (void);
  80
  81 ATK_AVAILABLE_IN_2_12
  82 gint        atk_table_cell_get_column_span         (AtkTableCell *cell);
  83 ATK_AVAILABLE_IN_2_12
  84 GPtrArray * atk_table_cell_get_column_header_cells (AtkTableCell *cell);
  85 ATK_AVAILABLE_IN_2_12
  86 gboolean    atk_table_cell_get_position            (AtkTableCell *cell,
  87                                                     gint         *row,
  88                                                     gint         *column);
  89 ATK_AVAILABLE_IN_2_12
  90 gint        atk_table_cell_get_row_span            (AtkTableCell *cell);
  91 ATK_AVAILABLE_IN_2_12
  92 GPtrArray * atk_table_cell_get_row_header_cells    (AtkTableCell *cell);
  93 ATK_AVAILABLE_IN_2_12
  94 gboolean    atk_table_cell_get_row_column_span     (AtkTableCell *cell,
  95                                                     gint         *row,
  96                                                     gint         *column,
  97                                                     gint         *row_span,
  98                                                     gint         *column_span);
  99 ATK_AVAILABLE_IN_2_12
 100 AtkObject * atk_table_cell_get_table               (AtkTableCell *cell);
 101
 102 G_END_DECLS
 103
 104 #endif /* __ATK_TABLE_CELL_H__ */