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