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