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