xref: /AOO42X/main/udkapi/com/sun/star/io/XActiveDataStreamer.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_io_XActiveDataStreamer_idl__
#define __com_sun_star_io_XActiveDataStreamer_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_io_XStream_idl__
#include <com/sun/star/io/XStream.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module io {

//=============================================================================

// DocMerge from xml: interface com::sun::star::io::XActiveDataStreamer
/** makes it possible to read and write the corresponding stream.


    <p>If you want to allow control from outside, also implement the
    <type>XActiveDataControl</type> interface. </p>
 */
published interface XActiveDataStreamer: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::io::XActiveDataStreamer::setStream
    /** plugs the input/output stream.

        <p>If <type>XConnectable</type> is also implemented, this
        method should query <var>aStream</var> for a
        <type>XConnectable</type> and connect both.</p>
     */
    void setStream( [in] com::sun::star::io::XStream aStream );

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::io::XActiveDataStreamer::getStream
    /** @returns
                the plugged stream.
     */
    com::sun::star::io::XStream getStream();

};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif