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