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  * Conversion parameters:
26  * inFile  = GZlibDecompressor.html
27  * outPack = gio
28  * outFile = ZlibDecompressor
29  * strct   = GZlibDecompressor
30  * realStrct=
31  * ctorStrct=
32  * clss    = ZlibDecompressor
33  * interf  = 
34  * class Code: Yes
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * 	- ConverterIF
40  * prefixes:
41  * 	- g_zlib_decompressor_
42  * omit structs:
43  * omit prefixes:
44  * omit code:
45  * omit signals:
46  * imports:
47  * 	- gio.FileInfo
48  * 	- gio.ConverterT
49  * 	- gio.ConverterIF
50  * structWrap:
51  * 	- GFileInfo* -> FileInfo
52  * module aliases:
53  * local aliases:
54  * overrides:
55  */
56 
57 module gio.ZlibDecompressor;
58 
59 public  import gtkc.giotypes;
60 
61 private import gtkc.gio;
62 private import glib.ConstructionException;
63 private import gobject.ObjectG;
64 
65 private import gio.FileInfo;
66 private import gio.ConverterT;
67 private import gio.ConverterIF;
68 
69 
70 private import gobject.ObjectG;
71 
72 /**
73  * GZlibDecompressor is an implementation of GConverter that
74  * decompresses data compressed with zlib.
75  */
76 public class ZlibDecompressor : ObjectG, ConverterIF
77 {
78 	
79 	/** the main Gtk struct */
80 	protected GZlibDecompressor* gZlibDecompressor;
81 	
82 	
83 	/** Get the main Gtk struct */
84 	public GZlibDecompressor* getZlibDecompressorStruct()
85 	{
86 		return gZlibDecompressor;
87 	}
88 	
89 	
90 	/** the main Gtk struct as a void* */
91 	protected override void* getStruct()
92 	{
93 		return cast(void*)gZlibDecompressor;
94 	}
95 	
96 	/**
97 	 * Sets our main struct and passes it to the parent class
98 	 */
99 	public this (GZlibDecompressor* gZlibDecompressor)
100 	{
101 		super(cast(GObject*)gZlibDecompressor);
102 		this.gZlibDecompressor = gZlibDecompressor;
103 	}
104 	
105 	protected override void setStruct(GObject* obj)
106 	{
107 		super.setStruct(obj);
108 		gZlibDecompressor = cast(GZlibDecompressor*)obj;
109 	}
110 	
111 	// add the Converter capabilities
112 	mixin ConverterT!(GZlibDecompressor);
113 	
114 	/**
115 	 */
116 	
117 	/**
118 	 * Creates a new GZlibDecompressor.
119 	 * Since 2.24
120 	 * Params:
121 	 * format = The format to use for the compressed data
122 	 * Throws: ConstructionException GTK+ fails to create the object.
123 	 */
124 	public this (GZlibCompressorFormat format)
125 	{
126 		// GZlibDecompressor * g_zlib_decompressor_new (GZlibCompressorFormat format);
127 		auto p = g_zlib_decompressor_new(format);
128 		if(p is null)
129 		{
130 			throw new ConstructionException("null returned by g_zlib_decompressor_new(format)");
131 		}
132 		this(cast(GZlibDecompressor*) p);
133 	}
134 	
135 	/**
136 	 * Retrieves the GFileInfo constructed from the GZIP header data
137 	 * of compressed data processed by compressor, or NULL if decompressor's
138 	 * "format" property is not G_ZLIB_COMPRESSOR_FORMAT_GZIP,
139 	 * or the header data was not fully processed yet, or it not present in the
140 	 * data stream at all.
141 	 * Since 2.26
142 	 * Returns: a GFileInfo, or NULL. [transfer none]
143 	 */
144 	public FileInfo getFileInfo()
145 	{
146 		// GFileInfo * g_zlib_decompressor_get_file_info (GZlibDecompressor *decompressor);
147 		auto p = g_zlib_decompressor_get_file_info(gZlibDecompressor);
148 		
149 		if(p is null)
150 		{
151 			return null;
152 		}
153 		
154 		return ObjectG.getDObject!(FileInfo)(cast(GFileInfo*) p);
155 	}
156 }