gio.ZlibDecompressor 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.ZlibDecompressor;
26 
27 private import gio.ConverterIF;
28 private import gio.ConverterT;
29 private import gio.FileInfo;
30 private import glib.ConstructionException;
31 private import gobject.ObjectG;
32 private import gtkc.gio;
33 public  import gtkc.giotypes;
34 
35 
36 /**
37  * Zlib decompression
38  */
39 public class ZlibDecompressor : ObjectG, ConverterIF
40 {
41 	/** the main Gtk struct */
42 	protected GZlibDecompressor* gZlibDecompressor;
43 
44 	/** Get the main Gtk struct */
45 	public GZlibDecompressor* getZlibDecompressorStruct()
46 	{
47 		return gZlibDecompressor;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)gZlibDecompressor;
54 	}
55 
56 	protected override void setStruct(GObject* obj)
57 	{
58 		gZlibDecompressor = cast(GZlibDecompressor*)obj;
59 		super.setStruct(obj);
60 	}
61 
62 	/**
63 	 * Sets our main struct and passes it to the parent class.
64 	 */
65 	public this (GZlibDecompressor* gZlibDecompressor, bool ownedRef = false)
66 	{
67 		this.gZlibDecompressor = gZlibDecompressor;
68 		super(cast(GObject*)gZlibDecompressor, ownedRef);
69 	}
70 
71 	// add the Converter capabilities
72 	mixin ConverterT!(GZlibDecompressor);
73 
74 
75 	/** */
76 	public static GType getType()
77 	{
78 		return g_zlib_decompressor_get_type();
79 	}
80 
81 	/**
82 	 * Creates a new #GZlibDecompressor.
83 	 *
84 	 * Params:
85 	 *     format = The format to use for the compressed data
86 	 *
87 	 * Return: a new #GZlibDecompressor
88 	 *
89 	 * Since: 2.24
90 	 *
91 	 * Throws: ConstructionException GTK+ fails to create the object.
92 	 */
93 	public this(GZlibCompressorFormat format)
94 	{
95 		auto p = g_zlib_decompressor_new(format);
96 		
97 		if(p is null)
98 		{
99 			throw new ConstructionException("null returned by new");
100 		}
101 		
102 		this(cast(GZlibDecompressor*) p, true);
103 	}
104 
105 	/**
106 	 * Retrieves the #GFileInfo constructed from the GZIP header data
107 	 * of compressed data processed by @compressor, or %NULL if @decompressor's
108 	 * #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP,
109 	 * or the header data was not fully processed yet, or it not present in the
110 	 * data stream at all.
111 	 *
112 	 * Return: a #GFileInfo, or %NULL
113 	 *
114 	 * Since: 2.26
115 	 */
116 	public FileInfo getFileInfo()
117 	{
118 		auto p = g_zlib_decompressor_get_file_info(gZlibDecompressor);
119 		
120 		if(p is null)
121 		{
122 			return null;
123 		}
124 		
125 		return ObjectG.getDObject!(FileInfo)(cast(GFileInfo*) p);
126 	}
127 }