gio.FilterOutputStream source code

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 gio.c.functions;
29 public  import gio.c.types;
30 private import gobject.ObjectG;
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 	/**
59 	 * Sets our main struct and passes it to the parent class.
60 	 */
61 	public this (GFilterOutputStream* gFilterOutputStream, bool ownedRef = false)
62 	{
63 		this.gFilterOutputStream = gFilterOutputStream;
64 		super(cast(GOutputStream*)gFilterOutputStream, ownedRef);
65 	}
66 
67 
68 	/** */
69 	public static GType getType()
70 	{
71 		return g_filter_output_stream_get_type();
72 	}
73 
74 	/**
75 	 * Gets the base stream for the filter stream.
76 	 *
77 	 * Returns: a #GOutputStream.
78 	 */
79 	public OutputStream getBaseStream()
80 	{
81 		auto __p = g_filter_output_stream_get_base_stream(gFilterOutputStream);
82 
83 		if(__p is null)
84 		{
85 			return null;
86 		}
87 
88 		return ObjectG.getDObject!(OutputStream)(cast(GOutputStream*) __p);
89 	}
90 
91 	/**
92 	 * Returns whether the base stream will be closed when @stream is
93 	 * closed.
94 	 *
95 	 * Returns: %TRUE if the base stream will be closed.
96 	 */
97 	public bool getCloseBaseStream()
98 	{
99 		return g_filter_output_stream_get_close_base_stream(gFilterOutputStream) != 0;
100 	}
101 
102 	/**
103 	 * Sets whether the base stream will be closed when @stream is closed.
104 	 *
105 	 * Params:
106 	 *     closeBase = %TRUE to close the base stream.
107 	 */
108 	public void setCloseBaseStream(bool closeBase)
109 	{
110 		g_filter_output_stream_set_close_base_stream(gFilterOutputStream, closeBase);
111 	}
112 }