/************************************************************************* * * $RCSfile: XPluginInstance.idl,v $ * * $Revision: 1.12 $ * * last change: $Author: hr $ $Date: 2003-03-26 13:54:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library 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 for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (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.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef __com_sun_star_mozilla_XPluginInstance_idl__ #define __com_sun_star_mozilla_XPluginInstance_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif #ifndef __com_sun_star_io_XInputStream_idl__ #include #endif //============================================================================= module com { module sun { module star { module mozilla { //============================================================================= // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::start /** Allows to controll an office side plugin instance and to communicate with it. This interface is oriented for communication with browsers plugins. */ interface XPluginInstance: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::start /** Starts plugin operation. This is called after a plugin instance is created. */ [oneway] void start(); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::stop /** Stops plugin operation. This is called when the user goes to another web page. The XPluginInstance::destroy method is directly called afterwards. */ [oneway] void stop(); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::destroy /** 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). */ [oneway] void destroy(); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::createWindow /** Creates a new window for plugin operation. @param PlatformParentData [in]: platform dependent window data @param embedded [in]: selects embedded or full page plugin mode */ [oneway] void createWindow( [in] any PlatformParentData, [in] boolean embedded ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::newStream /** 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 */ [oneway] void newStream( [in] string MIMEDesc, [in] string theURL, [in] string filter, [in] ::com::sun::star::io::XInputStream stream , [in] any sessionData ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::newURL /** 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 openend @param filter [in]: a filter string to suggest a component that should handle the document @param sessiondata [in]: the data specifying the current session */ [oneway] void newURL( [in] string MIMEDesc, [in] string theURL, [in] string filter, [in] any sessionData ); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::mozilla::XPluginInstance::getHttpServerURL /** Retrieves the URL of the HTTP Loadbalancing 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