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.FilterInputStream; 26 27 private import gio.InputStream; 28 private import gio.c.functions; 29 public import gio.c.types; 30 private import gobject.ObjectG; 31 public import gtkc.giotypes; 32 33 34 /** 35 * Base class for input stream implementations that perform some 36 * kind of filtering operation on a base stream. Typical examples 37 * of filtering operations are character set conversion, compression 38 * and byte order flipping. 39 */ 40 public class FilterInputStream : InputStream 41 { 42 /** the main Gtk struct */ 43 protected GFilterInputStream* gFilterInputStream; 44 45 /** Get the main Gtk struct */ 46 public GFilterInputStream* getFilterInputStreamStruct(bool transferOwnership = false) 47 { 48 if (transferOwnership) 49 ownedRef = false; 50 return gFilterInputStream; 51 } 52 53 /** the main Gtk struct as a void* */ 54 protected override void* getStruct() 55 { 56 return cast(void*)gFilterInputStream; 57 } 58 59 protected override void setStruct(GObject* obj) 60 { 61 gFilterInputStream = cast(GFilterInputStream*)obj; 62 super.setStruct(obj); 63 } 64 65 /** 66 * Sets our main struct and passes it to the parent class. 67 */ 68 public this (GFilterInputStream* gFilterInputStream, bool ownedRef = false) 69 { 70 this.gFilterInputStream = gFilterInputStream; 71 super(cast(GInputStream*)gFilterInputStream, ownedRef); 72 } 73 74 75 /** */ 76 public static GType getType() 77 { 78 return g_filter_input_stream_get_type(); 79 } 80 81 /** 82 * Gets the base stream for the filter stream. 83 * 84 * Returns: a #GInputStream. 85 */ 86 public InputStream getBaseStream() 87 { 88 auto p = g_filter_input_stream_get_base_stream(gFilterInputStream); 89 90 if(p is null) 91 { 92 return null; 93 } 94 95 return ObjectG.getDObject!(InputStream)(cast(GInputStream*) p); 96 } 97 98 /** 99 * Returns whether the base stream will be closed when @stream is 100 * closed. 101 * 102 * Returns: %TRUE if the base stream will be closed. 103 */ 104 public bool getCloseBaseStream() 105 { 106 return g_filter_input_stream_get_close_base_stream(gFilterInputStream) != 0; 107 } 108 109 /** 110 * Sets whether the base stream will be closed when @stream is closed. 111 * 112 * Params: 113 * closeBase = %TRUE to close the base stream. 114 */ 115 public void setCloseBaseStream(bool closeBase) 116 { 117 g_filter_input_stream_set_close_base_stream(gFilterInputStream, closeBase); 118 } 119 }