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