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.ZlibCompressor;
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 ZlibCompressor : ObjectG, ConverterIF
41 {
42 	/** the main Gtk struct */
43 	protected GZlibCompressor* gZlibCompressor;
44 
45 	/** Get the main Gtk struct */
46 	public GZlibCompressor* getZlibCompressorStruct(bool transferOwnership = false)
47 	{
48 		if (transferOwnership)
49 			ownedRef = false;
50 		return gZlibCompressor;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)gZlibCompressor;
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (GZlibCompressor* gZlibCompressor, bool ownedRef = false)
63 	{
64 		this.gZlibCompressor = gZlibCompressor;
65 		super(cast(GObject*)gZlibCompressor, ownedRef);
66 	}
67 
68 	// add the Converter capabilities
69 	mixin ConverterT!(GZlibCompressor);
70 
71 
72 	/** */
73 	public static GType getType()
74 	{
75 		return g_zlib_compressor_get_type();
76 	}
77 
78 	/**
79 	 * Creates a new #GZlibCompressor.
80 	 *
81 	 * Params:
82 	 *     format = The format to use for the compressed data
83 	 *     level = compression level (0-9), -1 for default
84 	 *
85 	 * Returns: a new #GZlibCompressor
86 	 *
87 	 * Since: 2.24
88 	 *
89 	 * Throws: ConstructionException GTK+ fails to create the object.
90 	 */
91 	public this(GZlibCompressorFormat format, int level)
92 	{
93 		auto p = g_zlib_compressor_new(format, level);
94 
95 		if(p is null)
96 		{
97 			throw new ConstructionException("null returned by new");
98 		}
99 
100 		this(cast(GZlibCompressor*) p, true);
101 	}
102 
103 	/**
104 	 * Returns the #GZlibCompressor:file-info property.
105 	 *
106 	 * Returns: a #GFileInfo, or %NULL
107 	 *
108 	 * Since: 2.26
109 	 */
110 	public FileInfo getFileInfo()
111 	{
112 		auto p = g_zlib_compressor_get_file_info(gZlibCompressor);
113 
114 		if(p is null)
115 		{
116 			return null;
117 		}
118 
119 		return ObjectG.getDObject!(FileInfo)(cast(GFileInfo*) p);
120 	}
121 
122 	/**
123 	 * Sets @file_info in @compressor. If non-%NULL, and @compressor's
124 	 * #GZlibCompressor:format property is %G_ZLIB_COMPRESSOR_FORMAT_GZIP,
125 	 * it will be used to set the file name and modification time in
126 	 * the GZIP header of the compressed data.
127 	 *
128 	 * Note: it is an error to call this function while a compression is in
129 	 * progress; it may only be called immediately after creation of @compressor,
130 	 * or after resetting it with g_converter_reset().
131 	 *
132 	 * Params:
133 	 *     fileInfo = a #GFileInfo
134 	 *
135 	 * Since: 2.26
136 	 */
137 	public void setFileInfo(FileInfo fileInfo)
138 	{
139 		g_zlib_compressor_set_file_info(gZlibCompressor, (fileInfo is null) ? null : fileInfo.getFileInfoStruct());
140 	}
141 }