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