/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XPlugin.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 02:33:22 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    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
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_plugin_XPlugin_idl__
#define __com_sun_star_plugin_XPlugin_idl__

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

#ifndef __com_sun_star_io_XActiveDataSource_idl__
#include <com/sun/star/io/XActiveDataSource.idl>
#endif

#ifndef __com_sun_star_plugin_PluginException_idl__
#include <com/sun/star/plugin/PluginException.idl>
#endif


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

 module com {  module sun {  module star {  module plugin {

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

/** This interface allows the container, e.g. document to control the plugin.
*/
published interface XPlugin: com::sun::star::uno::XInterface
{
    /** Tells the plugin instance that a new stream is requested.

        @param mimetype
               mime type of provided data
        @param aSource
               data source
        @param url
               url
        @param length
               number of bytes (if file)
        @param lastmodified
               time stamp of last modification (if file)
        @param isfile
               whether data comes from a file
        @return true upon success
    */
    boolean provideNewStream( [in] string mimetype,
             [in] com::sun::star::io::XActiveDataSource aSource,
             [in] string url,
             [in] long length,
             [in] long lastmodified,
             [in] boolean isfile )
            raises( com::sun::star::plugin::PluginException );
};

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

}; }; }; };

#endif
