offapi/com/sun/star/mozilla/XPluginInstance.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: XPluginInstance.idl,v $
  10  * $Revision: 1.15 $
  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_mozilla_XPluginInstance_idl__
  31 #define __com_sun_star_mozilla_XPluginInstance_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_io_XInputStream_idl__
  38 #include <com/sun/star/io/XInputStream.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module mozilla {
  44
  45 //=============================================================================
  46
  47
  48 // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::start
  49 /** Allows to controll an office side plugin instance and to communicate with it.
  50     This interface is oriented for communication with browsers plugins.
  51  */
  52 published interface XPluginInstance: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55
  56
  57     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::start
  58     /** Starts plugin operation. This is called after a plugin instance is
  59         created.
  60      */
  61     [oneway] void start();
  62
  63     //-------------------------------------------------------------------------
  64
  65
  66     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::stop
  67     /** Stops plugin operation. This is called when the user goes to another web
  68         page. The <member>XPluginInstance::destroy</member> method is directly called
  69         afterwards.
  70      */
  71     [oneway] void stop();
  72
  73     //-------------------------------------------------------------------------
  74
  75
  76     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::destroy
  77     /** Destroy the plugin instance. This method is called when it is no
  78         longer possible to return to the plugin instance, because it was
  79         destroyed by the browser (e.g., window close).
  80      */
  81     [oneway] void destroy();
  82
  83     //-------------------------------------------------------------------------
  84
  85
  86     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::createWindow
  87     /** Creates a new window for plugin operation.
  88
  89         @param PlatformParentData       [in]:   platform dependent window data
  90         @param embedded                         [in]:   selects embedded or full page plugin mode
  91
  92      */
  93     [oneway] void createWindow( [in] any PlatformParentData, [in] boolean embedded );
  94
  95     //-------------------------------------------------------------------------
  96
  97
  98     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::newStream
  99     /** Notifies the plugin of a new stream to display.
 100
 101         @param MIMEDesc         [in]:   the MIMEtype of the data stream
 102         @param theURL           [in]:   the URL that denotes the stream
 103         @param filter           [in]:   a filter string to suggest a component that should handle the document
 104         @param stream           [in]:   the data stream
 105         @param sessiondata      [in]:   the data specifying the current session
 106
 107      */
 108     [oneway] void newStream(
 109         [in] string MIMEDesc,
 110         [in] string theURL,
 111         [in] string filter,
 112         [in] ::com::sun::star::io::XInputStream stream ,
 113         [in] any sessionData
 114     );
 115
 116     //-------------------------------------------------------------------------
 117
 118
 119     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::newURL
 120     /** Notifies the plugin of a new url to open as document.
 121
 122         @param MIMEDesc         [in]:   the MIMEtype of the data stream
 123         @param theURL           [in]:   the URL to be openend
 124         @param filter           [in]:   a filter string to suggest a component that should handle the document
 125         @param sessiondata      [in]:   the data specifying the current session
 126
 127      */
 128     [oneway] void newURL( [in] string MIMEDesc, [in] string theURL, [in] string filter, [in] any sessionData );
 129
 130     //-------------------------------------------------------------------------
 131
 132
 133     // DocMerge from idl: method com::sun::star::mozilla::XPluginInstance::getHttpServerURL
 134     /** Retrieves the URL of the HTTP Loadbalancing Slave.
 135
 136         @param aURL             [out]:  the full qualified host name of the LBS
 137         @param aPort    [out]:  the port number
 138         @param aPrefix  [out]:  the url prefix to the portal
 139
 140      */
 141     void getHttpServerURL( [out] string aHost, [out] unsigned short aPort,
 142                            [out] string aPrefix);
 143 };
 144
 145 //=============================================================================
 146
 147 }; }; }; };
 148
 149 #endif