office-gobmx/offapi/com/sun/star/mozilla/XPluginInstance.idl
Tor Lillqvist d1449a9b99 Bin pointless "DocMerge" comment lines
Change-Id: I8eb2116b39929770f00e30d5ab9ca2c28c988e35
2013-03-13 10:36:21 +02:00

109 lines
3.7 KiB
Text

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef __com_sun_star_mozilla_XPluginInstance_idl__
#define __com_sun_star_mozilla_XPluginInstance_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/io/XInputStream.idl>
module com { module sun { module star { module mozilla {
/** Allows to control an office side plugin instance and to communicate with it.
This interface is oriented for communication with browsers plugins.
*/
published interface XPluginInstance: com::sun::star::uno::XInterface
{
/** Starts plugin operation. This is called after a plugin instance is
created.
*/
void start();
/** Stops plugin operation. This is called when the user goes to another web
page. The <member>XPluginInstance::destroy</member> method is directly called
afterwards.
*/
void stop();
/** Destroy the plugin instance. This method is called when it is no
longer possible to return to the plugin instance, because it was
destroyed by the browser (e.g., window close).
*/
void destroy();
/** Creates a new window for plugin operation.
@param PlatformParentData [in]: platform dependent window data
@param embedded [in]: selects embedded or full page plugin mode
*/
void createWindow( [in] any PlatformParentData, [in] boolean embedded );
/** Notifies the plugin of a new stream to display.
@param MIMEDesc [in]: the MIMEtype of the data stream
@param theURL [in]: the URL that denotes the stream
@param filter [in]: a filter string to suggest a component that should handle the document
@param stream [in]: the data stream
@param sessiondata [in]: the data specifying the current session
*/
void newStream(
[in] string MIMEDesc,
[in] string theURL,
[in] string filter,
[in] ::com::sun::star::io::XInputStream stream ,
[in] any sessionData
);
/** Notifies the plugin of a new url to open as document.
@param MIMEDesc [in]: the MIMEtype of the data stream
@param theURL [in]: the URL to be opened
@param filter [in]: a filter string to suggest a component that should handle the document
@param sessiondata [in]: the data specifying the current session
*/
void newURL( [in] string MIMEDesc, [in] string theURL, [in] string filter, [in] any sessionData );
/** Retrieves the URL of the HTTP Load balancing Slave.
@param aURL [out]: the full qualified host name of the LBS
@param aPort [out]: the port number
@param aPrefix [out]: the url prefix to the portal
*/
void getHttpServerURL( [out] string aHost, [out] unsigned short aPort,
[out] string aPrefix);
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */