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

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