Files
gtk/atk/atkstreamablecontent.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

111 lines
4.7 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_STREAMABLE_CONTENT_H__
#define __ATK_STREAMABLE_CONTENT_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_STREAMABLE_CONTENT (atk_streamable_content_get_type ())
#define ATK_IS_STREAMABLE_CONTENT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_STREAMABLE_CONTENT)
#define ATK_STREAMABLE_CONTENT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_STREAMABLE_CONTENT, AtkStreamableContent)
#define ATK_STREAMABLE_CONTENT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_STREAMABLE_CONTENT, AtkStreamableContentIface))
#ifndef _TYPEDEF_ATK_STREAMABLE_CONTENT
#define _TYPEDEF_ATK_STREAMABLE_CONTENT
typedef struct _AtkStreamableContent AtkStreamableContent;
#endif
typedef struct _AtkStreamableContentIface AtkStreamableContentIface;
struct _AtkStreamableContentIface
{
GTypeInterface parent;
/*
* Get the number of mime types supported by this object
*/
gint (* get_n_mime_types) (AtkStreamableContent *streamable);
/*
* Gets the specified mime type supported by this object.
* The mime types are 0-based so the first mime type is
* at index 0, the second at index 1 and so on. The mime-type
* at index 0 should be considered the "default" data type for the stream.
*
* This assumes that the strings for the mime types are stored in the
* AtkStreamableContent. Alternatively the const could be removed
* and the caller would be responsible for calling g_free() on the
* returned value.
*/
const gchar* (* get_mime_type) (AtkStreamableContent *streamable,
gint i);
/*
* One possible implementation for this method is that it constructs the
* content appropriate for the mime type and then creates a temporary
* file containing the content, opens the file and then calls
* g_io_channel_unix_new_fd().
*/
GIOChannel* (* get_stream) (AtkStreamableContent *streamable,
const gchar *mime_type);
/*
* Returns a string representing a URI in IETF standard format
* (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content
* may be streamed in the specified mime-type.
* If mime_type is NULL, the URI for the default (and possibly only) mime-type is
* returned.
*
* returns NULL if the mime-type is not supported, or if no URI can be
* constructed. Note that it is possible for get_uri to return NULL but for
* get_stream to work nonetheless, since not all GIOChannels connect to URIs.
*/
const gchar* (* get_uri) (AtkStreamableContent *streamable,
const gchar *mime_type);
AtkFunction pad1;
AtkFunction pad2;
AtkFunction pad3;
};
GDK_AVAILABLE_IN_ALL
GType atk_streamable_content_get_type (void);
GDK_AVAILABLE_IN_ALL
gint atk_streamable_content_get_n_mime_types (AtkStreamableContent *streamable);
GDK_AVAILABLE_IN_ALL
const gchar* atk_streamable_content_get_mime_type (AtkStreamableContent *streamable,
gint i);
GDK_AVAILABLE_IN_ALL
GIOChannel* atk_streamable_content_get_stream (AtkStreamableContent *streamable,
const gchar *mime_type);
GDK_AVAILABLE_IN_ALL
const gchar* atk_streamable_content_get_uri (AtkStreamableContent *streamable,
const gchar *mime_type);
G_END_DECLS
#endif /* __ATK_STREAMABLE_CONTENT_H__ */