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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_plugin_XPlugin_idl__
  20 #define __com_sun_star_plugin_XPlugin_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/io/XActiveDataSource.idl>
  25
  26 #include <com/sun/star/plugin/PluginException.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module plugin {
  31
  32
  33 /** This interface allows the container, e.g. document to control the plugin.
  34 */
  35 published interface XPlugin: com::sun::star::uno::XInterface
  36 {
  37     /** Tells the plugin instance that a new stream is requested.
  38
  39         @param mimetype
  40                mime type of provided data
  41         @param aSource
  42                data source
  43         @param url
  44                url
  45         @param length
  46                number of bytes (if file)
  47         @param lastmodified
  48                time stamp of last modification (if file)
  49         @param isfile
  50                whether data comes from a file
  51         @return true upon success
  52     */
  53     boolean provideNewStream( [in] string mimetype,
  54              [in] com::sun::star::io::XActiveDataSource aSource,
  55              [in] string url,
  56              [in] long length,
  57              [in] long lastmodified,
  58              [in] boolean isfile )
  59             raises( com::sun::star::plugin::PluginException );
  60 };
  61
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */