1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module atk.StreamableContentIF; 26 27 private import glib.IOChannel; 28 private import glib.Str; 29 private import gtkc.atk; 30 public import gtkc.atktypes; 31 32 33 /** 34 * An interface whereby an object allows its backing content to be 35 * streamed to clients. Typical implementors would be images or 36 * icons, HTML content, or multimedia display/rendering widgets. 37 * 38 * Negotiation of content type is allowed. Clients may examine the 39 * backing data and transform, convert, or parse the content in order 40 * to present it in an alternate form to end-users. 41 * 42 * The AtkStreamableContent interface is particularly useful for 43 * saving, printing, or post-processing entire documents, or for 44 * persisting alternate views of a document. If document content 45 * itself is being serialized, stored, or converted, then use of the 46 * AtkStreamableContent interface can help address performance 47 * issues. Unlike most ATK interfaces, this interface is not strongly 48 * tied to the current user-agent view of the a particular document, 49 * but may in some cases give access to the underlying model data. 50 */ 51 public interface StreamableContentIF{ 52 /** Get the main Gtk struct */ 53 public AtkStreamableContent* getStreamableContentStruct(); 54 55 /** the main Gtk struct as a void* */ 56 protected void* getStruct(); 57 58 /** 59 */ 60 61 /** 62 * Gets the character string of the specified mime type. The first mime 63 * type is at position 0, the second at position 1, and so on. 64 * 65 * Params: 66 * i = a gint representing the position of the mime type starting from 0 67 * 68 * Return: a gchar* representing the specified mime type; the caller 69 * should not free the character string. 70 */ 71 public string getMimeType(int i); 72 73 /** 74 * Gets the number of mime types supported by this object. 75 * 76 * Return: a gint which is the number of mime types supported by the object. 77 */ 78 public int getNMimeTypes(); 79 80 /** 81 * Gets the content in the specified mime type. 82 * 83 * Params: 84 * mimeType = a gchar* representing the mime type 85 * 86 * Return: A #GIOChannel which contains the content in the 87 * specified mime type. 88 */ 89 public IOChannel getStream(string mimeType); 90 91 /** 92 * Get a string representing a URI in IETF standard format 93 * (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content 94 * may be streamed in the specified mime-type, if one is available. 95 * If mime_type is NULL, the URI for the default (and possibly only) mime-type is 96 * returned. 97 * 98 * Note that it is possible for get_uri to return NULL but for 99 * get_stream to work nonetheless, since not all GIOChannels connect to URIs. 100 * 101 * Params: 102 * mimeType = a gchar* representing the mime type, or NULL to request a URI 103 * for the default mime type. 104 * 105 * Return: Returns a string representing a URI, or %NULL 106 * if no corresponding URI can be constructed. 107 * 108 * Since: 1.12 109 */ 110 public string getUri(string mimeType); 111 }