root/trunk/src/gio/FilterOutputStream.d

/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */
 
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage

/*
 * Conversion parameters:
 * inFile  = GFilterOutputStream.html
 * outPack = gio
 * outFile = FilterOutputStream
 * strct   = GFilterOutputStream
 * realStrct=
 * ctorStrct=
 * clss    = FilterOutputStream
 * interf  = 
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 *  - g_filter_output_stream_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 *  - gio.OutputStream
 * structWrap:
 *  - GOutputStream* -> OutputStream
 * module aliases:
 * local aliases:
 * overrides:
 */

module gio.FilterOutputStream;

public  import gtkc.giotypes;

private import gtkc.gio;
private import glib.ConstructionException;


private import gio.OutputStream;



private import gio.OutputStream;

/**
 * Description
 * Base class for output stream implementations that perform some
 * kind of filtering operation on a base stream. Typical examples
 * of filtering operations are character set conversion, compression
 * and byte order flipping.
 */
public class FilterOutputStream : OutputStream
{
    
    /** the main Gtk struct */
    protected GFilterOutputStream* gFilterOutputStream;
    
    
    public GFilterOutputStream* getFilterOutputStreamStruct()
    {
        return gFilterOutputStream;
    }
    
    
    /** the main Gtk struct as a void* */
    protected override void* getStruct()
    {
        return cast(void*)gFilterOutputStream;
    }
    
    /**
     * Sets our main struct and passes it to the parent class
     */
    public this (GFilterOutputStream* gFilterOutputStream)
    {
        if(gFilterOutputStream is null)
        {
            this = null;
            return;
        }
        //Check if there already is a D object for this gtk struct
        void* ptr = getDObject(cast(GObject*)gFilterOutputStream);
        if( ptr !is null )
        {
            this = cast(FilterOutputStream)ptr;
            return;
        }
        super(cast(GOutputStream*)gFilterOutputStream);
        this.gFilterOutputStream = gFilterOutputStream;
    }
    
    protected override void setStruct(GObject* obj)
    {
        super.setStruct(obj);
        gFilterOutputStream = cast(GFilterOutputStream*)obj;
    }
    
    /**
     */
    
    /**
     * Gets the base stream for the filter stream.
     * Returns: a GOutputStream. [transfer none]
     */
    public OutputStream getBaseStream()
    {
        // GOutputStream * g_filter_output_stream_get_base_stream  (GFilterOutputStream *stream);
        auto p = g_filter_output_stream_get_base_stream(gFilterOutputStream);
        if(p is null)
        {
            return null;
        }
        return new OutputStream(cast(GOutputStream*) p);
    }
    
    /**
     * Returns whether the base stream will be closed when stream is
     * closed.
     * Returns: TRUE if the base stream will be closed.
     */
    public int getCloseBaseStream()
    {
        // gboolean g_filter_output_stream_get_close_base_stream  (GFilterOutputStream *stream);
        return g_filter_output_stream_get_close_base_stream(gFilterOutputStream);
    }
    
    /**
     * Sets whether the base stream will be closed when stream is closed.
     * Params:
     * closeBase = TRUE to close the base stream.
     */
    public void setCloseBaseStream(int closeBase)
    {
        // void g_filter_output_stream_set_close_base_stream  (GFilterOutputStream *stream,  gboolean close_base);
        g_filter_output_stream_set_close_base_stream(gFilterOutputStream, closeBase);
    }
}