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