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.BufferedOutputStream;
26 
27 private import gio.FilterOutputStream;
28 private import gio.OutputStream;
29 private import gio.SeekableIF;
30 private import gio.SeekableT;
31 private import glib.ConstructionException;
32 private import gobject.ObjectG;
33 private import gtkc.gio;
34 public  import gtkc.giotypes;
35 
36 
37 /**
38  * Buffered output stream implements #GFilterOutputStream and provides
39  * for buffered writes.
40  * 
41  * By default, #GBufferedOutputStream's buffer size is set at 4 kilobytes.
42  * 
43  * To create a buffered output stream, use g_buffered_output_stream_new(),
44  * or g_buffered_output_stream_new_sized() to specify the buffer's size
45  * at construction.
46  * 
47  * To get the size of a buffer within a buffered input stream, use
48  * g_buffered_output_stream_get_buffer_size(). To change the size of a
49  * buffered output stream's buffer, use
50  * g_buffered_output_stream_set_buffer_size(). Note that the buffer's
51  * size cannot be reduced below the size of the data within the buffer.
52  */
53 public class BufferedOutputStream : FilterOutputStream, SeekableIF
54 {
55 	/** the main Gtk struct */
56 	protected GBufferedOutputStream* gBufferedOutputStream;
57 
58 	/** Get the main Gtk struct */
59 	public GBufferedOutputStream* getBufferedOutputStreamStruct()
60 	{
61 		return gBufferedOutputStream;
62 	}
63 
64 	/** the main Gtk struct as a void* */
65 	protected override void* getStruct()
66 	{
67 		return cast(void*)gBufferedOutputStream;
68 	}
69 
70 	protected override void setStruct(GObject* obj)
71 	{
72 		gBufferedOutputStream = cast(GBufferedOutputStream*)obj;
73 		super.setStruct(obj);
74 	}
75 
76 	/**
77 	 * Sets our main struct and passes it to the parent class.
78 	 */
79 	public this (GBufferedOutputStream* gBufferedOutputStream, bool ownedRef = false)
80 	{
81 		this.gBufferedOutputStream = gBufferedOutputStream;
82 		super(cast(GFilterOutputStream*)gBufferedOutputStream, ownedRef);
83 	}
84 
85 	// add the Seekable capabilities
86 	mixin SeekableT!(GBufferedOutputStream);
87 
88 
89 	/** */
90 	public static GType getType()
91 	{
92 		return g_buffered_output_stream_get_type();
93 	}
94 
95 	/**
96 	 * Creates a new buffered output stream for a base stream.
97 	 *
98 	 * Params:
99 	 *     baseStream = a #GOutputStream.
100 	 *
101 	 * Return: a #GOutputStream for the given @base_stream.
102 	 *
103 	 * Throws: ConstructionException GTK+ fails to create the object.
104 	 */
105 	public this(OutputStream baseStream)
106 	{
107 		auto p = g_buffered_output_stream_new((baseStream is null) ? null : baseStream.getOutputStreamStruct());
108 		
109 		if(p is null)
110 		{
111 			throw new ConstructionException("null returned by new");
112 		}
113 		
114 		this(cast(GBufferedOutputStream*) p, true);
115 	}
116 
117 	/**
118 	 * Creates a new buffered output stream with a given buffer size.
119 	 *
120 	 * Params:
121 	 *     baseStream = a #GOutputStream.
122 	 *     size = a #gsize.
123 	 *
124 	 * Return: a #GOutputStream with an internal buffer set to @size.
125 	 *
126 	 * Throws: ConstructionException GTK+ fails to create the object.
127 	 */
128 	public this(OutputStream baseStream, size_t size)
129 	{
130 		auto p = g_buffered_output_stream_new_sized((baseStream is null) ? null : baseStream.getOutputStreamStruct(), size);
131 		
132 		if(p is null)
133 		{
134 			throw new ConstructionException("null returned by new_sized");
135 		}
136 		
137 		this(cast(GBufferedOutputStream*) p, true);
138 	}
139 
140 	/**
141 	 * Checks if the buffer automatically grows as data is added.
142 	 *
143 	 * Return: %TRUE if the @stream's buffer automatically grows,
144 	 *     %FALSE otherwise.
145 	 */
146 	public bool getAutoGrow()
147 	{
148 		return g_buffered_output_stream_get_auto_grow(gBufferedOutputStream) != 0;
149 	}
150 
151 	/**
152 	 * Gets the size of the buffer in the @stream.
153 	 *
154 	 * Return: the current size of the buffer.
155 	 */
156 	public size_t getBufferSize()
157 	{
158 		return g_buffered_output_stream_get_buffer_size(gBufferedOutputStream);
159 	}
160 
161 	/**
162 	 * Sets whether or not the @stream's buffer should automatically grow.
163 	 * If @auto_grow is true, then each write will just make the buffer
164 	 * larger, and you must manually flush the buffer to actually write out
165 	 * the data to the underlying stream.
166 	 *
167 	 * Params:
168 	 *     autoGrow = a #gboolean.
169 	 */
170 	public void setAutoGrow(bool autoGrow)
171 	{
172 		g_buffered_output_stream_set_auto_grow(gBufferedOutputStream, autoGrow);
173 	}
174 
175 	/**
176 	 * Sets the size of the internal buffer to @size.
177 	 *
178 	 * Params:
179 	 *     size = a #gsize.
180 	 */
181 	public void setBufferSize(size_t size)
182 	{
183 		g_buffered_output_stream_set_buffer_size(gBufferedOutputStream, size);
184 	}
185 }