gio.BytesIcon 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.BytesIcon;
26 
27 private import gio.IconIF;
28 private import gio.IconT;
29 private import gio.LoadableIconIF;
30 private import gio.LoadableIconT;
31 private import gio.c.functions;
32 public  import gio.c.types;
33 private import glib.Bytes;
34 private import glib.ConstructionException;
35 private import gobject.ObjectG;
36 
37 
38 /**
39  * #GBytesIcon specifies an image held in memory in a common format (usually
40  * png) to be used as icon.
41  *
42  * Since: 2.38
43  */
44 public class BytesIcon : ObjectG, IconIF, LoadableIconIF
45 {
46 	/** the main Gtk struct */
47 	protected GBytesIcon* gBytesIcon;
48 
49 	/** Get the main Gtk struct */
50 	public GBytesIcon* getBytesIconStruct(bool transferOwnership = false)
51 	{
52 		if (transferOwnership)
53 			ownedRef = false;
54 		return gBytesIcon;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)gBytesIcon;
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (GBytesIcon* gBytesIcon, bool ownedRef = false)
67 	{
68 		this.gBytesIcon = gBytesIcon;
69 		super(cast(GObject*)gBytesIcon, ownedRef);
70 	}
71 
72 	// add the Icon capabilities
73 	mixin IconT!(GBytesIcon);
74 
75 	// add the LoadableIcon capabilities
76 	mixin LoadableIconT!(GBytesIcon);
77 
78 
79 	/** */
80 	public static GType getType()
81 	{
82 		return g_bytes_icon_get_type();
83 	}
84 
85 	/**
86 	 * Creates a new icon for a bytes.
87 	 *
88 	 * This cannot fail, but loading and interpreting the bytes may fail later on
89 	 * (for example, if g_loadable_icon_load() is called) if the image is invalid.
90 	 *
91 	 * Params:
92 	 *     bytes = a #GBytes.
93 	 *
94 	 * Returns: a #GIcon for the given
95 	 *     @bytes.
96 	 *
97 	 * Since: 2.38
98 	 *
99 	 * Throws: ConstructionException GTK+ fails to create the object.
100 	 */
101 	public this(Bytes bytes)
102 	{
103 		auto __p = g_bytes_icon_new((bytes is null) ? null : bytes.getBytesStruct());
104 
105 		if(__p is null)
106 		{
107 			throw new ConstructionException("null returned by new");
108 		}
109 
110 		this(cast(GBytesIcon*) __p, true);
111 	}
112 
113 	/**
114 	 * Gets the #GBytes associated with the given @icon.
115 	 *
116 	 * Returns: a #GBytes.
117 	 *
118 	 * Since: 2.38
119 	 */
120 	public Bytes getBytes()
121 	{
122 		auto __p = g_bytes_icon_get_bytes(gBytesIcon);
123 
124 		if(__p is null)
125 		{
126 			return null;
127 		}
128 
129 		return new Bytes(cast(GBytes*) __p);
130 	}
131 }