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