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