offapi/com/sun/star/plugin/XPluginManager.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPluginManager.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_plugin_XPluginManager_idl__
  31 #define __com_sun_star_plugin_XPluginManager_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_plugin_XPluginContext_idl__
  38 #include <com/sun/star/plugin/XPluginContext.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_plugin_PluginDescription_idl__
  42 #include <com/sun/star/plugin/PluginDescription.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_plugin_XPlugin_idl__
  46 #include <com/sun/star/plugin/XPlugin.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_plugin_PluginException_idl__
  50 #include <com/sun/star/plugin/PluginException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_awt_XToolkit_idl__
  54 #include <com/sun/star/awt/XToolkit.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_awt_XWindowPeer_idl__
  58 #include <com/sun/star/awt/XWindowPeer.idl>
  59 #endif
  60
  61
  62 //=============================================================================
  63
  64  module com {  module sun {  module star {  module plugin {
  65
  66 //=============================================================================
  67
  68 /** Interface accessing all recognized Netscape plugins.
  69 */
  70 published interface XPluginManager: com::sun::star::uno::XInterface
  71 {
  72     /** Creates a default context.  This context depends on the service
  73         <type scope="com::sun::star::frame">Desktop</type>.</p>
  74
  75         @return plugin context
  76     */
  77     com::sun::star::plugin::XPluginContext createPluginContext();
  78
  79     /** Returns the descriptions for all recognized plugins.
  80
  81         @return plugin descriptions
  82     */
  83     sequence<com::sun::star::plugin::PluginDescription> getPluginDescriptions();
  84
  85     /** Creates a new plugin instance.
  86
  87         @param acontext
  88                plugin context
  89         @param mode
  90                plugin mode
  91         @param argn
  92                argument name list provided to plugin
  93         @param argv
  94                argument value list provided to plugin
  95         @param plugintype
  96                plugin description
  97         @return plugin instance
  98     */
  99     com::sun::star::plugin::XPlugin createPlugin(
 100         [in] com::sun::star::plugin::XPluginContext acontext,
 101         [in] short mode,
 102         [in] sequence<string> argn,
 103         [in] sequence<string> argv,
 104         [in] com::sun::star::plugin::PluginDescription plugintype )
 105         raises( com::sun::star::plugin::PluginException );
 106
 107     /** Creates a new plugin instance.
 108
 109         @param acontext
 110                plugin context
 111         @param mode
 112                plugin mode
 113         @param argn
 114                argument name list provided to plugin
 115         @param argv
 116                argument value list provided to plugin
 117         @param toolkit
 118                toolkit to be used to get system window handle for plugin
 119         @param parent
 120                parent window
 121         @param url
 122                url
 123         @return plugin instance
 124     */
 125     com::sun::star::plugin::XPlugin createPluginFromURL(
 126         [in] com::sun::star::plugin::XPluginContext acontext,
 127         [in] short mode,
 128         [in] sequence<string> argn,
 129         [in] sequence<string> argv,
 130         [in] com::sun::star::awt::XToolkit toolkit,
 131         [in] com::sun::star::awt::XWindowPeer parent,
 132         [in] string url );
 133
 134 };
 135
 136 //=============================================================================
 137
 138 }; }; }; };
 139
 140 #endif