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.StreamableContentT; 26 27 public import glib.IOChannel; 28 public import glib.Str; 29 public 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 template StreamableContentT(TStruct) 52 { 53 /** Get the main Gtk struct */ 54 public AtkStreamableContent* getStreamableContentStruct() 55 { 56 return cast(AtkStreamableContent*)getStruct(); 57 } 58 59 60 /** 61 * Gets the character string of the specified mime type. The first mime 62 * type is at position 0, the second at position 1, and so on. 63 * 64 * Params: 65 * i = a gint representing the position of the mime type starting from 0 66 * 67 * Return: a gchar* representing the specified mime type; the caller 68 * should not free the character string. 69 */ 70 public string getMimeType(int i) 71 { 72 return Str.toString(atk_streamable_content_get_mime_type(getStreamableContentStruct(), i)); 73 } 74 75 /** 76 * Gets the number of mime types supported by this object. 77 * 78 * Return: a gint which is the number of mime types supported by the object. 79 */ 80 public int getNMimeTypes() 81 { 82 return atk_streamable_content_get_n_mime_types(getStreamableContentStruct()); 83 } 84 85 /** 86 * Gets the content in the specified mime type. 87 * 88 * Params: 89 * mimeType = a gchar* representing the mime type 90 * 91 * Return: A #GIOChannel which contains the content in the 92 * specified mime type. 93 */ 94 public IOChannel getStream(string mimeType) 95 { 96 auto p = atk_streamable_content_get_stream(getStreamableContentStruct(), Str.toStringz(mimeType)); 97 98 if(p is null) 99 { 100 return null; 101 } 102 103 return new IOChannel(cast(GIOChannel*) p); 104 } 105 106 /** 107 * Get a string representing a URI in IETF standard format 108 * (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content 109 * may be streamed in the specified mime-type, if one is available. 110 * If mime_type is NULL, the URI for the default (and possibly only) mime-type is 111 * returned. 112 * 113 * Note that it is possible for get_uri to return NULL but for 114 * get_stream to work nonetheless, since not all GIOChannels connect to URIs. 115 * 116 * Params: 117 * mimeType = a gchar* representing the mime type, or NULL to request a URI 118 * for the default mime type. 119 * 120 * Return: Returns a string representing a URI, or %NULL 121 * if no corresponding URI can be constructed. 122 * 123 * Since: 1.12 124 */ 125 public string getUri(string mimeType) 126 { 127 return Str.toString(atk_streamable_content_get_uri(getStreamableContentStruct(), Str.toStringz(mimeType))); 128 } 129 }