summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/plugin/XPluginManager.idl
blob: daaae1d68792caeec9a7f13bd33e6ddfacfcc49d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XPluginManager.idl,v $
 * $Revision: 1.9 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_plugin_XPluginManager_idl__
#define __com_sun_star_plugin_XPluginManager_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_plugin_XPluginContext_idl__
#include <com/sun/star/plugin/XPluginContext.idl>
#endif

#ifndef __com_sun_star_plugin_PluginDescription_idl__
#include <com/sun/star/plugin/PluginDescription.idl>
#endif

#ifndef __com_sun_star_plugin_XPlugin_idl__
#include <com/sun/star/plugin/XPlugin.idl>
#endif

#ifndef __com_sun_star_plugin_PluginException_idl__
#include <com/sun/star/plugin/PluginException.idl>
#endif

#ifndef __com_sun_star_awt_XToolkit_idl__
#include <com/sun/star/awt/XToolkit.idl>
#endif

#ifndef __com_sun_star_awt_XWindowPeer_idl__
#include <com/sun/star/awt/XWindowPeer.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module plugin {

//=============================================================================

/** Interface accessing all recognized Netscape plugins.
*/
published interface XPluginManager: com::sun::star::uno::XInterface
{
    /** Creates a default context.  This context depends on the service
        <type scope="com::sun::star::frame">Desktop</type>.</p>

        @return plugin context
    */
    com::sun::star::plugin::XPluginContext createPluginContext();

    /** Returns the descriptions for all recognized plugins.

        @return plugin descriptions
    */
    sequence<com::sun::star::plugin::PluginDescription> getPluginDescriptions();

    /** Creates a new plugin instance.

        @param acontext
               plugin context
        @param mode
               plugin mode
        @param argn
               argument name list provided to plugin
        @param argv
               argument value list provided to plugin
        @param plugintype
               plugin description
        @return plugin instance
    */
    com::sun::star::plugin::XPlugin createPlugin(
        [in] com::sun::star::plugin::XPluginContext acontext,
        [in] short mode,
        [in] sequence<string> argn,
        [in] sequence<string> argv,
        [in] com::sun::star::plugin::PluginDescription plugintype )
        raises( com::sun::star::plugin::PluginException );

    /** Creates a new plugin instance.

        @param acontext
               plugin context
        @param mode
               plugin mode
        @param argn
               argument name list provided to plugin
        @param argv
               argument value list provided to plugin
        @param toolkit
               toolkit to be used to get system window handle for plugin
        @param parent
               parent window
        @param url
               url
        @return plugin instance
    */
    com::sun::star::plugin::XPlugin createPluginFromURL(
        [in] com::sun::star::plugin::XPluginContext acontext,
        [in] short mode,
        [in] sequence<string> argn,
        [in] sequence<string> argv,
        [in] com::sun::star::awt::XToolkit toolkit,
        [in] com::sun::star::awt::XWindowPeer parent,
        [in] string url );

};

//=============================================================================

}; }; }; };

#endif