Files
gtk/atk/atktable.h
Emmanuele Bassi 2d158da7a4 Move ATK inside GTK
This is a temporary move that aims to make GTK's accessibility support
independent of external components.

ATK has lived outside of GTK since its inception, as it was meant to be
a generic API implemented by different toolkits; that mostly failed, and
we're now stuck with an abstraction layer that doesn't really abstract
anything of value. What it did bring, on the other hand, was maintenance
burden, with changes being propagated across different projects—ATK,
GTK, and whatever accessibility layer implemented the bridge to ATSPI on
Linux. This complexity is completely unwarranted for the benefits it
gives us.

Ideally, we'd get rid of ATK entirely, and expose the accessility API as
part of the GTK namespace, but that is a fairly sizeable work, so we can
start from this step. The ATK namespace is maintained, similarly to how
we maintain the GDK, GSK, and GTK namespaces. The API is still public,
so that GTK and out of tree widgets can consume it.

The inclusion of ATK comes with the removal of the deprecated entry
points and types, as that's a good chance to begin the cleanup of this
mess of an API. Sadly, this also means we have to disable the a11y tests
for the time being, as they depend on rando API from 2002.

Another side effect of moving ATK in tree is that we cannot link to
atk-bridge on X11, as that will link to the out of tree ATK; this means
that accessibility is disabled on X11.
2020-01-21 18:21:25 +00:00

224 lines
12 KiB
C

/* ATK - Accessibility Toolkit
* Copyright 2001 Sun Microsystems Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __ATK_TABLE_H__
#define __ATK_TABLE_H__
#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <atk/atk.h> can be included directly."
#endif
#include <atk/atkobject.h>
G_BEGIN_DECLS
#define ATK_TYPE_TABLE (atk_table_get_type ())
#define ATK_IS_TABLE(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_TABLE)
#define ATK_TABLE(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_TABLE, AtkTable)
#define ATK_TABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_TABLE, AtkTableIface))
#ifndef _TYPEDEF_ATK_TABLE_
#define _TYPEDEF_ATK_TABLE_
typedef struct _AtkTable AtkTable;
#endif
typedef struct _AtkTableIface AtkTableIface;
struct _AtkTableIface
{
GTypeInterface parent;
AtkObject* (* ref_at) (AtkTable *table,
gint row,
gint column);
gint (* get_index_at) (AtkTable *table,
gint row,
gint column);
gint (* get_column_at_index) (AtkTable *table,
gint index_);
gint (* get_row_at_index) (AtkTable *table,
gint index_);
gint (* get_n_columns) (AtkTable *table);
gint (* get_n_rows) (AtkTable *table);
gint (* get_column_extent_at) (AtkTable *table,
gint row,
gint column);
gint (* get_row_extent_at) (AtkTable *table,
gint row,
gint column);
AtkObject*
(* get_caption) (AtkTable *table);
const gchar* (* get_column_description) (AtkTable *table,
gint column);
AtkObject* (* get_column_header) (AtkTable *table,
gint column);
const gchar* (* get_row_description) (AtkTable *table,
gint row);
AtkObject* (* get_row_header) (AtkTable *table,
gint row);
AtkObject* (* get_summary) (AtkTable *table);
void (* set_caption) (AtkTable *table,
AtkObject *caption);
void (* set_column_description) (AtkTable *table,
gint column,
const gchar *description);
void (* set_column_header) (AtkTable *table,
gint column,
AtkObject *header);
void (* set_row_description) (AtkTable *table,
gint row,
const gchar *description);
void (* set_row_header) (AtkTable *table,
gint row,
AtkObject *header);
void (* set_summary) (AtkTable *table,
AtkObject *accessible);
gint (* get_selected_columns) (AtkTable *table,
gint **selected);
gint (* get_selected_rows) (AtkTable *table,
gint **selected);
gboolean (* is_column_selected) (AtkTable *table,
gint column);
gboolean (* is_row_selected) (AtkTable *table,
gint row);
gboolean (* is_selected) (AtkTable *table,
gint row,
gint column);
gboolean (* add_row_selection) (AtkTable *table,
gint row);
gboolean (* remove_row_selection) (AtkTable *table,
gint row);
gboolean (* add_column_selection) (AtkTable *table,
gint column);
gboolean (* remove_column_selection) (AtkTable *table,
gint column);
/*
* signal handlers
*/
void (* row_inserted) (AtkTable *table,
gint row,
gint num_inserted);
void (* column_inserted) (AtkTable *table,
gint column,
gint num_inserted);
void (* row_deleted) (AtkTable *table,
gint row,
gint num_deleted);
void (* column_deleted) (AtkTable *table,
gint column,
gint num_deleted);
void (* row_reordered) (AtkTable *table);
void (* column_reordered) (AtkTable *table);
void (* model_changed) (AtkTable *table);
};
GDK_AVAILABLE_IN_ALL
GType atk_table_get_type (void);
GDK_AVAILABLE_IN_ALL
AtkObject* atk_table_ref_at (AtkTable *table,
gint row,
gint column);
GDK_AVAILABLE_IN_ALL
gint atk_table_get_n_columns (AtkTable *table);
GDK_AVAILABLE_IN_ALL
gint atk_table_get_n_rows (AtkTable *table);
GDK_AVAILABLE_IN_ALL
gint atk_table_get_column_extent_at (AtkTable *table,
gint row,
gint column);
GDK_AVAILABLE_IN_ALL
gint atk_table_get_row_extent_at (AtkTable *table,
gint row,
gint column);
GDK_AVAILABLE_IN_ALL
AtkObject*
atk_table_get_caption (AtkTable *table);
GDK_AVAILABLE_IN_ALL
const gchar* atk_table_get_column_description
(AtkTable *table,
gint column);
GDK_AVAILABLE_IN_ALL
AtkObject* atk_table_get_column_header (AtkTable *table,
gint column);
GDK_AVAILABLE_IN_ALL
const gchar* atk_table_get_row_description (AtkTable *table,
gint row);
GDK_AVAILABLE_IN_ALL
AtkObject* atk_table_get_row_header (AtkTable *table,
gint row);
GDK_AVAILABLE_IN_ALL
AtkObject* atk_table_get_summary (AtkTable *table);
GDK_AVAILABLE_IN_ALL
void atk_table_set_caption (AtkTable *table,
AtkObject *caption);
GDK_AVAILABLE_IN_ALL
void atk_table_set_column_description
(AtkTable *table,
gint column,
const gchar *description);
GDK_AVAILABLE_IN_ALL
void atk_table_set_column_header (AtkTable *table,
gint column,
AtkObject *header);
GDK_AVAILABLE_IN_ALL
void atk_table_set_row_description (AtkTable *table,
gint row,
const gchar *description);
GDK_AVAILABLE_IN_ALL
void atk_table_set_row_header (AtkTable *table,
gint row,
AtkObject *header);
GDK_AVAILABLE_IN_ALL
void atk_table_set_summary (AtkTable *table,
AtkObject *accessible);
GDK_AVAILABLE_IN_ALL
gint atk_table_get_selected_columns (AtkTable *table,
gint **selected);
GDK_AVAILABLE_IN_ALL
gint atk_table_get_selected_rows (AtkTable *table,
gint **selected);
GDK_AVAILABLE_IN_ALL
gboolean atk_table_is_column_selected (AtkTable *table,
gint column);
GDK_AVAILABLE_IN_ALL
gboolean atk_table_is_row_selected (AtkTable *table,
gint row);
GDK_AVAILABLE_IN_ALL
gboolean atk_table_is_selected (AtkTable *table,
gint row,
gint column);
GDK_AVAILABLE_IN_ALL
gboolean atk_table_add_row_selection (AtkTable *table,
gint row);
GDK_AVAILABLE_IN_ALL
gboolean atk_table_remove_row_selection (AtkTable *table,
gint row);
GDK_AVAILABLE_IN_ALL
gboolean atk_table_add_column_selection (AtkTable *table,
gint column);
GDK_AVAILABLE_IN_ALL
gboolean atk_table_remove_column_selection
(AtkTable *table,
gint column);
G_END_DECLS
#endif /* __ATK_TABLE_H__ */