xref: /aoo4110/main/offapi/com/sun/star/plugin/XPluginManager.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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