13
0
livetrax/libs/glibmm2/gio/giomm/bufferedoutputstream.h
Paul Davis a73d15e989 switch glibmm/giomm to 2.18
git-svn-id: svn://localhost/ardour2/branches/3.0@5306 d708f5d6-7413-0410-9779-e7cbd77b26cf
2009-07-02 16:00:45 +00:00

174 lines
5.3 KiB
C++

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GIOMM_BUFFEREDOUTPUTSTREAM_H
#define _GIOMM_BUFFEREDOUTPUTSTREAM_H
#include <glibmm.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2008 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <giomm/filteroutputstream.h>
#include <glibmm/object.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GBufferedOutputStream GBufferedOutputStream;
typedef struct _GBufferedOutputStreamClass GBufferedOutputStreamClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class BufferedOutputStream_Class; } // namespace Gio
namespace Gio
{
/** The buffered output stream implements FilterOutputStream and provides for buffered writes.
* By default, BufferedOutputStream's buffer size is set at 4 kilobytes, but you
* can specify this to the constructor.
*
* To get the size of a buffer within a buffered input stream, use get_buffer_size().
* To change the size of a buffered output stream's buffer, use set_buffer_size().
* Note that the buffer's size cannot be reduced below the size of the data within the buffer.
*
* @ingroup Streams
*
* @newin2p16
*/
class BufferedOutputStream : public Gio::FilterOutputStream
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef BufferedOutputStream CppObjectType;
typedef BufferedOutputStream_Class CppClassType;
typedef GBufferedOutputStream BaseObjectType;
typedef GBufferedOutputStreamClass BaseClassType;
private: friend class BufferedOutputStream_Class;
static CppClassType bufferedoutputstream_class_;
private:
// noncopyable
BufferedOutputStream(const BufferedOutputStream&);
BufferedOutputStream& operator=(const BufferedOutputStream&);
protected:
explicit BufferedOutputStream(const Glib::ConstructParams& construct_params);
explicit BufferedOutputStream(GBufferedOutputStream* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~BufferedOutputStream();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_type() G_GNUC_CONST;
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GBufferedOutputStream* gobj() { return reinterpret_cast<GBufferedOutputStream*>(gobject_); }
///Provides access to the underlying C GObject.
const GBufferedOutputStream* gobj() const { return reinterpret_cast<GBufferedOutputStream*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GBufferedOutputStream* gobj_copy();
private:
protected:
explicit BufferedOutputStream(const Glib::RefPtr<OutputStream>& base_stream);
explicit BufferedOutputStream(const Glib::RefPtr<OutputStream>& base_stream, gsize size);
public:
static Glib::RefPtr<BufferedOutputStream> create(const Glib::RefPtr<OutputStream>& base_stream);
static Glib::RefPtr<BufferedOutputStream> create_sized(const Glib::RefPtr<OutputStream>& base_stream, gsize size);
/** Gets the size of the buffer in the @a stream.
* @return The current size of the buffer.
*/
gsize get_buffer_size() const;
/** Sets the size of the internal buffer to @a size.
* @param size A #gsize.
*/
void set_buffer_size(gsize size);
/** Sets whether or not the @a stream's buffer should automatically grow.
* If @a auto_grow is true, then each write will just make the buffer
* larger, and you must manually flush the buffer to actually write out
* the data to the underlying stream.
* @param auto_grow A <tt>bool</tt>.
*/
void set_auto_grow(bool auto_grow=true);
/** Checks if the buffer automatically grows as data is added.
* @return <tt>true</tt> if the @a stream's buffer automatically grows,
* <tt>false</tt> otherwise.
*/
bool get_auto_grow() const;
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED
protected:
//GTK+ Virtual Functions (override these to change behaviour):
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED
//Default Signal Handlers::
#ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
#endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
};
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::BufferedOutputStream
*/
Glib::RefPtr<Gio::BufferedOutputStream> wrap(GBufferedOutputStream* object, bool take_copy = false);
}
#endif /* _GIOMM_BUFFEREDOUTPUTSTREAM_H */