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