source: appstream-generator/build/girepo/gio/LoadableIconIF.d @ 4841

Last change on this file since 4841 was 4841, checked in by Juanma, 2 years ago

Initial release

File size: 2.8 KB
Line 
1/*
2 * Licensed under the GNU Lesser General Public License Version 3
3 *
4 * This library is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published by
6 * the Free Software Foundation, either version 3 of the license, or
7 * (at your option) any later version.
8 *
9 * This software 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
12 * GNU Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
16 */
17
18// generated automatically - do not change
19
20
21module gio.LoadableIconIF;
22
23private import gi.gio;
24public  import gi.giotypes;
25private import gio.AsyncResultIF;
26private import gio.Cancellable;
27private import gio.InputStream;
28private import glib.ErrorG;
29private import glib.GException;
30private import glib.Str;
31private import gobject.ObjectG;
32
33
34/**
35 * Extends the #GIcon interface and adds the ability to
36 * load icons from streams.
37 */
38public interface LoadableIconIF{
39        /** Get the main Gtk struct */
40        public GLoadableIcon* getLoadableIconStruct();
41
42        /** the main Gtk struct as a void* */
43        protected void* getStruct();
44
45
46        /**
47         * Loads a loadable icon. For the asynchronous version of this function,
48         * see g_loadable_icon_load_async().
49         *
50         * Params:
51         *     size = an integer.
52         *     type = a location to store the type of the loaded
53         *         icon, %NULL to ignore.
54         *     cancellable = optional #GCancellable object, %NULL to
55         *         ignore.
56         *
57         * Returns: a #GInputStream to read the icon from.
58         *
59         * Throws: GException on failure.
60         */
61        public InputStream load(int size, out string type, Cancellable cancellable);
62
63        /**
64         * Loads an icon asynchronously. To finish this function, see
65         * g_loadable_icon_load_finish(). For the synchronous, blocking
66         * version of this function, see g_loadable_icon_load().
67         *
68         * Params:
69         *     size = an integer.
70         *     cancellable = optional #GCancellable object, %NULL to ignore.
71         *     callback = a #GAsyncReadyCallback to call when the
72         *         request is satisfied
73         *     userData = the data to pass to callback function
74         */
75        public void loadAsync(int size, Cancellable cancellable, GAsyncReadyCallback callback, void* userData);
76
77        /**
78         * Finishes an asynchronous icon load started in g_loadable_icon_load_async().
79         *
80         * Params:
81         *     res = a #GAsyncResult.
82         *     type = a location to store the type of the loaded
83         *         icon, %NULL to ignore.
84         *
85         * Returns: a #GInputStream to read the icon from.
86         *
87         * Throws: GException on failure.
88         */
89        public InputStream loadFinish(AsyncResultIF res, out string type);
90}
Note: See TracBrowser for help on using the repository browser.