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