offapi/com/sun/star/plugin/XPlugin.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPlugin.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_plugin_XPlugin_idl__
  31 #define __com_sun_star_plugin_XPlugin_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_XActiveDataSource_idl__
  38 #include <com/sun/star/io/XActiveDataSource.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_plugin_PluginException_idl__
  42 #include <com/sun/star/plugin/PluginException.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module plugin {
  49
  50 //=============================================================================
  51
  52 /** This interface allows the container, e.g. document to control the plugin.
  53 */
  54 published interface XPlugin: com::sun::star::uno::XInterface
  55 {
  56     /** Tells the plugin instance that a new stream is requested.
  57
  58         @param mimetype
  59                mime type of provided data
  60         @param aSource
  61                data source
  62         @param url
  63                url
  64         @param length
  65                number of bytes (if file)
  66         @param lastmodified
  67                time stamp of last modification (if file)
  68         @param isfile
  69                whether data comes from a file
  70         @return true upon success
  71     */
  72     boolean provideNewStream( [in] string mimetype,
  73              [in] com::sun::star::io::XActiveDataSource aSource,
  74              [in] string url,
  75              [in] long length,
  76              [in] long lastmodified,
  77              [in] boolean isfile )
  78             raises( com::sun::star::plugin::PluginException );
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 #endif