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