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(bool transferOwnership = false) 46 { 47 if (transferOwnership) 48 ownedRef = false; 49 return gFilterOutputStream; 50 } 51 52 /** the main Gtk struct as a void* */ 53 protected override void* getStruct() 54 { 55 return cast(void*)gFilterOutputStream; 56 } 57 58 protected override void setStruct(GObject* obj) 59 { 60 gFilterOutputStream = cast(GFilterOutputStream*)obj; 61 super.setStruct(obj); 62 } 63 64 /** 65 * Sets our main struct and passes it to the parent class. 66 */ 67 public this (GFilterOutputStream* gFilterOutputStream, bool ownedRef = false) 68 { 69 this.gFilterOutputStream = gFilterOutputStream; 70 super(cast(GOutputStream*)gFilterOutputStream, ownedRef); 71 } 72 73 74 /** */ 75 public static GType getType() 76 { 77 return g_filter_output_stream_get_type(); 78 } 79 80 /** 81 * Gets the base stream for the filter stream. 82 * 83 * Returns: a #GOutputStream. 84 */ 85 public OutputStream getBaseStream() 86 { 87 auto p = g_filter_output_stream_get_base_stream(gFilterOutputStream); 88 89 if(p is null) 90 { 91 return null; 92 } 93 94 return ObjectG.getDObject!(OutputStream)(cast(GOutputStream*) p); 95 } 96 97 /** 98 * Returns whether the base stream will be closed when @stream is 99 * closed. 100 * 101 * Returns: %TRUE if the base stream will be closed. 102 */ 103 public bool getCloseBaseStream() 104 { 105 return g_filter_output_stream_get_close_base_stream(gFilterOutputStream) != 0; 106 } 107 108 /** 109 * Sets whether the base stream will be closed when @stream is closed. 110 * 111 * Params: 112 * closeBase = %TRUE to close the base stream. 113 */ 114 public void setCloseBaseStream(bool closeBase) 115 { 116 g_filter_output_stream_set_close_base_stream(gFilterOutputStream, closeBase); 117 } 118 }