xref: /aoo42x/main/offapi/com/sun/star/plugin/XPlugin.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_plugin_XPlugin_idl__
24#define __com_sun_star_plugin_XPlugin_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_io_XActiveDataSource_idl__
31#include <com/sun/star/io/XActiveDataSource.idl>
32#endif
33
34#ifndef __com_sun_star_plugin_PluginException_idl__
35#include <com/sun/star/plugin/PluginException.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module plugin {
42
43//=============================================================================
44
45/** This interface allows the container, e.g. document to control the plugin.
46*/
47published interface XPlugin: com::sun::star::uno::XInterface
48{
49	/** Tells the plugin instance that a new stream is requested.
50
51        @param mimetype
52               mime type of provided data
53        @param aSource
54               data source
55        @param url
56               url
57        @param length
58               number of bytes (if file)
59        @param lastmodified
60               time stamp of last modification (if file)
61        @param isfile
62               whether data comes from a file
63        @return true upon success
64    */
65	boolean provideNewStream( [in] string mimetype,
66			 [in] com::sun::star::io::XActiveDataSource aSource,
67			 [in] string url,
68			 [in] long length,
69			 [in] long lastmodified,
70			 [in] boolean isfile )
71			raises( com::sun::star::plugin::PluginException );
72};
73
74//=============================================================================
75
76}; }; }; };
77
78#endif
79