1/* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
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_STREAMABLE_CONTENT_H__
21#define __ATK_STREAMABLE_CONTENT_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
29G_BEGIN_DECLS
30
31#define ATK_TYPE_STREAMABLE_CONTENT (atk_streamable_content_get_type ())
32#define ATK_IS_STREAMABLE_CONTENT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_STREAMABLE_CONTENT)
33#define ATK_STREAMABLE_CONTENT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_STREAMABLE_CONTENT, AtkStreamableContent)
34#define ATK_STREAMABLE_CONTENT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_STREAMABLE_CONTENT, AtkStreamableContentIface))
35
36#ifndef _TYPEDEF_ATK_STREAMABLE_CONTENT
37#define _TYPEDEF_ATK_STREAMABLE_CONTENT
38typedef struct _AtkStreamableContent AtkStreamableContent;
39#endif
40typedef struct _AtkStreamableContentIface AtkStreamableContentIface;
41
42struct _AtkStreamableContentIface
43{
44 GTypeInterface parent;
45
46 /*
47 * Get the number of mime types supported by this object
48 */
49 gint (* get_n_mime_types) (AtkStreamableContent *streamable);
50 /*
51 * Gets the specified mime type supported by this object.
52 * The mime types are 0-based so the first mime type is
53 * at index 0, the second at index 1 and so on. The mime-type
54 * at index 0 should be considered the "default" data type for the stream.
55 *
56 * This assumes that the strings for the mime types are stored in the
57 * AtkStreamableContent. Alternatively the const could be removed
58 * and the caller would be responsible for calling g_free() on the
59 * returned value.
60 */
61 const gchar* (* get_mime_type) (AtkStreamableContent *streamable,
62 gint i);
63 /*
64 * One possible implementation for this method is that it constructs the
65 * content appropriate for the mime type and then creates a temporary
66 * file containing the content, opens the file and then calls
67 * g_io_channel_unix_new_fd().
68 */
69 GIOChannel* (* get_stream) (AtkStreamableContent *streamable,
70 const gchar *mime_type);
71
72/*
73 * Returns a string representing a URI in IETF standard format
74 * (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content
75 * may be streamed in the specified mime-type.
76 * If mime_type is NULL, the URI for the default (and possibly only) mime-type is
77 * returned.
78 *
79 * returns NULL if the mime-type is not supported, or if no URI can be
80 * constructed. Note that it is possible for get_uri to return NULL but for
81 * get_stream to work nonetheless, since not all GIOChannels connect to URIs.
82 */
83 const gchar* (* get_uri) (AtkStreamableContent *streamable,
84 const gchar *mime_type);
85
86
87 AtkFunction pad1;
88 AtkFunction pad2;
89 AtkFunction pad3;
90};
91ATK_AVAILABLE_IN_ALL
92GType atk_streamable_content_get_type (void);
93
94ATK_AVAILABLE_IN_ALL
95gint atk_streamable_content_get_n_mime_types (AtkStreamableContent *streamable);
96
97ATK_AVAILABLE_IN_ALL
98const gchar* atk_streamable_content_get_mime_type (AtkStreamableContent *streamable,
99 gint i);
100ATK_AVAILABLE_IN_ALL
101GIOChannel* atk_streamable_content_get_stream (AtkStreamableContent *streamable,
102 const gchar *mime_type);
103
104ATK_AVAILABLE_IN_ALL
105const gchar* atk_streamable_content_get_uri (AtkStreamableContent *streamable,
106 const gchar *mime_type);
107
108G_END_DECLS
109
110#endif /* __ATK_STREAMABLE_CONTENT_H__ */
111