root/trunk/src/gio/ConverterOutputStream.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  = gio-GConverterOutputstream.html
 * outPack = gio
 * outFile = ConverterOutputStream
 * strct   = GConverterOutputStream
 * realStrct=
 * ctorStrct=GOutputStream
 * clss    = ConverterOutputStream
 * interf  = 
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 *  - g_converter_output_stream_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 *  - gio.Converter
 *  - gio.ConverterIF
 * structWrap:
 *  - GConverter* -> ConverterIF
 * module aliases:
 * local aliases:
 * overrides:
 */

module gio.ConverterOutputStream;

public  import gtkc.giotypes;

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


private import gio.Converter;
private import gio.ConverterIF;



private import gio.FilterOutputStream;

/**
 * Description
 * Converter output stream implements GOutputStream and allows
 * conversion of data of various types during reading.
 */
public class ConverterOutputStream : FilterOutputStream
{
    
    /** the main Gtk struct */
    protected GConverterOutputStream* gConverterOutputStream;
    
    
    public GConverterOutputStream* getConverterOutputStreamStruct()
    {
        return gConverterOutputStream;
    }
    
    
    /** the main Gtk struct as a void* */
    protected override void* getStruct()
    {
        return cast(void*)gConverterOutputStream;
    }
    
    /**
     * Sets our main struct and passes it to the parent class
     */
    public this (GConverterOutputStream* gConverterOutputStream)
    {
        if(gConverterOutputStream is null)
        {
            this = null;
            return;
        }
        //Check if there already is a D object for this gtk struct
        void* ptr = getDObject(cast(GObject*)gConverterOutputStream);
        if( ptr !is null )
        {
            this = cast(ConverterOutputStream)ptr;
            return;
        }
        super(cast(GFilterOutputStream*)gConverterOutputStream);
        this.gConverterOutputStream = gConverterOutputStream;
    }
    
    protected override void setStruct(GObject* obj)
    {
        super.setStruct(obj);
        gConverterOutputStream = cast(GConverterOutputStream*)obj;
    }
    
    /**
     */
    
    /**
     * Creates a new converter output stream for the base_stream.
     * Params:
     * baseStream = a GOutputStream
     * converter = a GConverter
     * Throws: ConstructionException GTK+ fails to create the object.
     */
    public this (GOutputStream* baseStream, ConverterIF converter)
    {
        // GOutputStream * g_converter_output_stream_new (GOutputStream *base_stream,  GConverter *converter);
        auto p = g_converter_output_stream_new(baseStream, (converter is null) ? null : converter.getConverterTStruct());
        if(p is null)
        {
            throw new ConstructionException("null returned by g_converter_output_stream_new(baseStream, (converter is null) ? null : converter.getConverterTStruct())");
        }
        this(cast(GConverterOutputStream*) p);
    }
    
    /**
     * Gets the GConverter that is used by converter_stream.
     * Since 2.24
     * Returns: the converter of the converter output stream. [transfer none]
     */
    public ConverterIF getConverter()
    {
        // GConverter * g_converter_output_stream_get_converter  (GConverterOutputStream *converter_stream);
        auto p = g_converter_output_stream_get_converter(gConverterOutputStream);
        if(p is null)
        {
            return null;
        }
        return new Converter(cast(GConverter*) p);
    }
}