gio.LoadableIconIF source code

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 gio.LoadableIconIF;
26 
27 private import gio.AsyncResultIF;
28 private import gio.Cancellable;
29 private import gio.InputStream;
30 private import glib.ErrorG;
31 private import glib.GException;
32 private import glib.Str;
33 private import gobject.ObjectG;
34 private import gtkc.gio;
35 public  import gtkc.giotypes;
36 
37 
38 /**
39  * Extends the #GIcon interface and adds the ability to
40  * load icons from streams.
41  */
42 public interface LoadableIconIF{
43 	/** Get the main Gtk struct */
44 	public GLoadableIcon* getLoadableIconStruct();
45 
46 	/** the main Gtk struct as a void* */
47 	protected void* getStruct();
48 
49 	/**
50 	 */
51 
52 	/**
53 	 * Loads a loadable icon. For the asynchronous version of this function,
54 	 * see g_loadable_icon_load_async().
55 	 *
56 	 * Params:
57 	 *     size = an integer.
58 	 *     type = a location to store the type of the loaded
59 	 *         icon, %NULL to ignore.
60 	 *     cancellable = optional #GCancellable object, %NULL to
61 	 *         ignore.
62 	 *
63 	 * Return: a #GInputStream to read the icon from.
64 	 *
65 	 * Throws: GException on failure.
66 	 */
67 	public InputStream load(int size, out string type, Cancellable cancellable);
68 
69 	/**
70 	 * Loads an icon asynchronously. To finish this function, see
71 	 * g_loadable_icon_load_finish(). For the synchronous, blocking
72 	 * version of this function, see g_loadable_icon_load().
73 	 *
74 	 * Params:
75 	 *     size = an integer.
76 	 *     cancellable = optional #GCancellable object, %NULL to ignore.
77 	 *     callback = a #GAsyncReadyCallback to call when the
78 	 *         request is satisfied
79 	 *     userData = the data to pass to callback function
80 	 */
81 	public void loadAsync(int size, Cancellable cancellable, GAsyncReadyCallback callback, void* userData);
82 
83 	/**
84 	 * Finishes an asynchronous icon load started in g_loadable_icon_load_async().
85 	 *
86 	 * Params:
87 	 *     res = a #GAsyncResult.
88 	 *     type = a location to store the type of the loaded
89 	 *         icon, %NULL to ignore.
90 	 *
91 	 * Return: a #GInputStream to read the icon from.
92 	 *
93 	 * Throws: GException on failure.
94 	 */
95 	public InputStream loadFinish(AsyncResultIF res, out string type);
96 }