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