tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

atkstreamablecontent.h (4734B)

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