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