2d158da7a4
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.
104 lines
4.5 KiB
C
104 lines
4.5 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_DOCUMENT_H__
|
|
#define __ATK_DOCUMENT_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
|
|
|
|
/*
|
|
* The AtkDocument interface should be supported by any object that is a container
|
|
* for 'document content' as opposed to a collection of user interface elements.
|
|
*
|
|
*/
|
|
|
|
#define ATK_TYPE_DOCUMENT (atk_document_get_type ())
|
|
#define ATK_IS_DOCUMENT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_DOCUMENT)
|
|
#define ATK_DOCUMENT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_DOCUMENT, AtkDocument)
|
|
#define ATK_DOCUMENT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_DOCUMENT, AtkDocumentIface))
|
|
|
|
#ifndef _TYPEDEF_ATK_DOCUMENT_
|
|
#define _TYPEDEF_ATK_DOCUMENT_
|
|
typedef struct _AtkDocument AtkDocument;
|
|
#endif
|
|
typedef struct _AtkDocumentIface AtkDocumentIface;
|
|
|
|
/**
|
|
* AtkDocumentIface:
|
|
* @get_document_type: gets a string indicating the document
|
|
* type. This virtual function is deprecated since 2.12 and it
|
|
* should not be overriden.
|
|
* @get_document: a #GObject instance that implements
|
|
* AtkDocumentIface. This virtual method is deprecated since 2.12
|
|
* and it should not be overriden.
|
|
* @get_document_locale: gets locale. This virtual function is
|
|
* deprecated since 2.7.90 and it should not be overriden.
|
|
* @get_document_attributes: gets an AtkAttributeSet which describes
|
|
* document-wide attributes as name-value pairs.
|
|
* @get_document_attribute_value: returns a string value assocciated
|
|
* with the named attribute for this document, or NULL
|
|
* @set_document_attribute: sets the value of an attribute. Returns
|
|
* TRUE on success, FALSE otherwise
|
|
* @get_current_page_number: gets the current page number. Since 2.12
|
|
* @get_page_count: gets the page count of the document. Since 2.12
|
|
*/
|
|
struct _AtkDocumentIface
|
|
{
|
|
GTypeInterface parent;
|
|
const gchar* ( *get_document_type) (AtkDocument *document);
|
|
gpointer ( *get_document) (AtkDocument *document);
|
|
|
|
const gchar* ( *get_document_locale) (AtkDocument *document);
|
|
AtkAttributeSet * ( *get_document_attributes) (AtkDocument *document);
|
|
const gchar* ( *get_document_attribute_value) (AtkDocument *document,
|
|
const gchar *attribute_name);
|
|
gboolean ( *set_document_attribute) (AtkDocument *document,
|
|
const gchar *attribute_name,
|
|
const gchar *attribute_value);
|
|
gint ( *get_current_page_number) (AtkDocument *document);
|
|
gint ( *get_page_count) (AtkDocument *document);
|
|
};
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
GType atk_document_get_type (void);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
AtkAttributeSet* atk_document_get_attributes (AtkDocument *document);
|
|
GDK_AVAILABLE_IN_ALL
|
|
const gchar* atk_document_get_attribute_value (AtkDocument *document,
|
|
const gchar *attribute_name);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean atk_document_set_attribute_value (AtkDocument *document,
|
|
const gchar *attribute_name,
|
|
const gchar *attribute_value);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gint atk_document_get_current_page_number (AtkDocument *document);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gint atk_document_get_page_count (AtkDocument *document);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __ATK_DOCUMENT_H__ */
|