gio.FileIcon 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.FileIcon;
26 
27 private import gio.FileIF;
28 private import gio.IconIF;
29 private import gio.IconT;
30 private import gio.LoadableIconIF;
31 private import gio.LoadableIconT;
32 private import gio.c.functions;
33 public  import gio.c.types;
34 private import glib.ConstructionException;
35 private import gobject.ObjectG;
36 
37 
38 /**
39  * #GFileIcon specifies an icon by pointing to an image file
40  * to be used as icon.
41  */
42 public class FileIcon : ObjectG, IconIF, LoadableIconIF
43 {
44 	/** the main Gtk struct */
45 	protected GFileIcon* gFileIcon;
46 
47 	/** Get the main Gtk struct */
48 	public GFileIcon* getFileIconStruct(bool transferOwnership = false)
49 	{
50 		if (transferOwnership)
51 			ownedRef = false;
52 		return gFileIcon;
53 	}
54 
55 	/** the main Gtk struct as a void* */
56 	protected override void* getStruct()
57 	{
58 		return cast(void*)gFileIcon;
59 	}
60 
61 	/**
62 	 * Sets our main struct and passes it to the parent class.
63 	 */
64 	public this (GFileIcon* gFileIcon, bool ownedRef = false)
65 	{
66 		this.gFileIcon = gFileIcon;
67 		super(cast(GObject*)gFileIcon, ownedRef);
68 	}
69 
70 	// add the Icon capabilities
71 	mixin IconT!(GFileIcon);
72 
73 	// add the LoadableIcon capabilities
74 	mixin LoadableIconT!(GFileIcon);
75 
76 
77 	/** */
78 	public static GType getType()
79 	{
80 		return g_file_icon_get_type();
81 	}
82 
83 	/**
84 	 * Creates a new icon for a file.
85 	 *
86 	 * Params:
87 	 *     file = a #GFile.
88 	 *
89 	 * Returns: a #GIcon for the given
90 	 *     @file, or %NULL on error.
91 	 *
92 	 * Throws: ConstructionException GTK+ fails to create the object.
93 	 */
94 	public this(FileIF file)
95 	{
96 		auto __p = g_file_icon_new((file is null) ? null : file.getFileStruct());
97 
98 		if(__p is null)
99 		{
100 			throw new ConstructionException("null returned by new");
101 		}
102 
103 		this(cast(GFileIcon*) __p, true);
104 	}
105 
106 	/**
107 	 * Gets the #GFile associated with the given @icon.
108 	 *
109 	 * Returns: a #GFile.
110 	 */
111 	public FileIF getFile()
112 	{
113 		auto __p = g_file_icon_get_file(gFileIcon);
114 
115 		if(__p is null)
116 		{
117 			return null;
118 		}
119 
120 		return ObjectG.getDObject!(FileIF)(cast(GFile*) __p);
121 	}
122 }