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.EmblemedIcon;
26 
27 private import gio.Emblem;
28 private import gio.IconIF;
29 private import gio.IconT;
30 private import gio.c.functions;
31 public  import gio.c.types;
32 private import glib.ConstructionException;
33 private import glib.ListG;
34 private import gobject.ObjectG;
35 public  import gtkc.giotypes;
36 
37 
38 /**
39  * #GEmblemedIcon is an implementation of #GIcon that supports
40  * adding an emblem to an icon. Adding multiple emblems to an
41  * icon is ensured via g_emblemed_icon_add_emblem().
42  * 
43  * Note that #GEmblemedIcon allows no control over the position
44  * of the emblems. See also #GEmblem for more information.
45  */
46 public class EmblemedIcon : ObjectG, IconIF
47 {
48 	/** the main Gtk struct */
49 	protected GEmblemedIcon* gEmblemedIcon;
50 
51 	/** Get the main Gtk struct */
52 	public GEmblemedIcon* getEmblemedIconStruct(bool transferOwnership = false)
53 	{
54 		if (transferOwnership)
55 			ownedRef = false;
56 		return gEmblemedIcon;
57 	}
58 
59 	/** the main Gtk struct as a void* */
60 	protected override void* getStruct()
61 	{
62 		return cast(void*)gEmblemedIcon;
63 	}
64 
65 	/**
66 	 * Sets our main struct and passes it to the parent class.
67 	 */
68 	public this (GEmblemedIcon* gEmblemedIcon, bool ownedRef = false)
69 	{
70 		this.gEmblemedIcon = gEmblemedIcon;
71 		super(cast(GObject*)gEmblemedIcon, ownedRef);
72 	}
73 
74 	// add the Icon capabilities
75 	mixin IconT!(GEmblemedIcon);
76 
77 
78 	/** */
79 	public static GType getType()
80 	{
81 		return g_emblemed_icon_get_type();
82 	}
83 
84 	/**
85 	 * Creates a new emblemed icon for @icon with the emblem @emblem.
86 	 *
87 	 * Params:
88 	 *     icon = a #GIcon
89 	 *     emblem = a #GEmblem, or %NULL
90 	 *
91 	 * Returns: a new #GIcon
92 	 *
93 	 * Since: 2.18
94 	 *
95 	 * Throws: ConstructionException GTK+ fails to create the object.
96 	 */
97 	public this(IconIF icon, Emblem emblem)
98 	{
99 		auto p = g_emblemed_icon_new((icon is null) ? null : icon.getIconStruct(), (emblem is null) ? null : emblem.getEmblemStruct());
100 
101 		if(p is null)
102 		{
103 			throw new ConstructionException("null returned by new");
104 		}
105 
106 		this(cast(GEmblemedIcon*) p, true);
107 	}
108 
109 	/**
110 	 * Adds @emblem to the #GList of #GEmblems.
111 	 *
112 	 * Params:
113 	 *     emblem = a #GEmblem
114 	 *
115 	 * Since: 2.18
116 	 */
117 	public void addEmblem(Emblem emblem)
118 	{
119 		g_emblemed_icon_add_emblem(gEmblemedIcon, (emblem is null) ? null : emblem.getEmblemStruct());
120 	}
121 
122 	/**
123 	 * Removes all the emblems from @icon.
124 	 *
125 	 * Since: 2.28
126 	 */
127 	public void clearEmblems()
128 	{
129 		g_emblemed_icon_clear_emblems(gEmblemedIcon);
130 	}
131 
132 	/**
133 	 * Gets the list of emblems for the @icon.
134 	 *
135 	 * Returns: a #GList of
136 	 *     #GEmblems that is owned by @emblemed
137 	 *
138 	 * Since: 2.18
139 	 */
140 	public ListG getEmblems()
141 	{
142 		auto p = g_emblemed_icon_get_emblems(gEmblemedIcon);
143 
144 		if(p is null)
145 		{
146 			return null;
147 		}
148 
149 		return new ListG(cast(GList*) p);
150 	}
151 
152 	/**
153 	 * Gets the main icon for @emblemed.
154 	 *
155 	 * Returns: a #GIcon that is owned by @emblemed
156 	 *
157 	 * Since: 2.18
158 	 */
159 	public IconIF getIcon()
160 	{
161 		auto p = g_emblemed_icon_get_icon(gEmblemedIcon);
162 
163 		if(p is null)
164 		{
165 			return null;
166 		}
167 
168 		return ObjectG.getDObject!(IconIF)(cast(GIcon*) p);
169 	}
170 }