offapi/com/sun/star/mozilla/XPluginInstancePeer.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: XPluginInstancePeer.idl,v $
  10  * $Revision: 1.12 $
  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_XPluginInstancePeer_idl__
  31 #define __com_sun_star_mozilla_XPluginInstancePeer_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_XActiveDataSource_idl__
  38 #include <com/sun/star/io/XActiveDataSource.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_io_XInputStream_idl__
  42 #include <com/sun/star/io/XInputStream.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
  46 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51  module com {  module sun {  module star {  module mozilla {
  52
  53 //=============================================================================
  54
  55  published interface XPluginInstanceNotifySink;
  56
  57 //=============================================================================
  58
  59
  60 // DocMerge from xml: interface com::sun::star::mozilla::XPluginInstancePeer
  61 /** Allows to communicate with a plugin from the office side.
  62     This interface is oriented for communication with browsers plugins.
  63  */
  64 published interface XPluginInstancePeer: com::sun::star::uno::XInterface
  65 {
  66     //-------------------------------------------------------------------------
  67
  68
  69     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::setWindowSize
  70     /** Alters the plugin's window size in the browser window.
  71
  72         @param width    [in]: the new window width
  73         @param height   [in]: the new window height
  74
  75         @return <CODE>TRUE</CODE> on success
  76      */
  77     boolean setWindowSize( [in] long width, [in] long heigth );
  78
  79     //-------------------------------------------------------------------------
  80
  81
  82     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::showStatusMessage
  83     /** Show status / hint message in browser's message area.
  84
  85         @param message  [in]: the string to be displayed
  86      */
  87     [oneway] void showStatusMessage( [in] string message );
  88
  89     //-------------------------------------------------------------------------
  90
  91
  92     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::enableScripting
  93     /** Indicates to the plugin that the document was loaded successfully and scripting
  94         interfaces are now available.
  95
  96         @param document                 [in]: the active document
  97         @param servicemanager   [in]: the office servicemanager
  98
  99      */
 100     [oneway] void enableScripting( [in] com::sun::star::uno::XInterface document, [in] com::sun::star::lang::XMultiServiceFactory servicemanager );
 101
 102     //-------------------------------------------------------------------------
 103
 104
 105     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::newStream
 106     /** Creates a new stream of data produced by the plug-in and consumed by
 107         the browser.
 108
 109         @param MIMEDesc [in]:   the MIME type of the plug-in to create
 110         @param target   [in]:   the name of the target window or frame (supports _blank, _self)
 111         @param data             [in]:   on success the outputstream will be     associated with this instance
 112
 113      */
 114     [oneway] void newStream(
 115         [in] string MIMEDesc,
 116         [in] string target,
 117         [in] com::sun::star::io::XActiveDataSource data
 118     );
 119
 120     //-------------------------------------------------------------------------
 121
 122
 123     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::getURL
 124     /** Fetches an URL into the target window. The parameters and their meaning map to the
 125         corresponding Netscape-API call.
 126
 127         @param aURL                             [in]: the URL to be fetched
 128         @param target                   [in]: the name of the target window or frame (supports _blank, _self)
 129         @param alternativeHost  [in]: alternativeHost
 130         @param referrer                 [in]: referrer
 131         @param sink                             [in]: the sink is notified on success
 132
 133      */
 134     [oneway] void getURL (
 135         [in] string aURL,
 136         [in] string target,
 137         [in] string alternativeHost,
 138         [in] string referrer,
 139         [in] XPluginInstanceNotifySink sink
 140     );
 141
 142     //-------------------------------------------------------------------------
 143
 144
 145     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::postURL
 146     /** Posts to a URL with post data and/or post headers. The parameters and their meaning
 147         map to the corresponding Netscape-API call.
 148
 149         @param aURL                             [in]: the URL to be posted to
 150         @param postData                 [in]: the data to be posted
 151         @param target                   [in]: the name of the target window or frame (supports _blank, _self)
 152         @param alternativeHost  [in]: alternativeHost
 153         @param referrer                 [in]: referrer
 154         @param postHeaders              [in]: the header to be posted
 155         @param sink                             [in]: the sink is notified on success
 156
 157      */
 158     [oneway] void postURL (
 159         [in] string aURL,
 160         [in] com::sun::star::io::XInputStream postData,
 161         [in] string target,
 162         [in] string alternativeHost,
 163         [in] string referrer,
 164         [in] com::sun::star::io::XInputStream postHeaders,
 165         [in] XPluginInstanceNotifySink sink
 166     );
 167 };
 168
 169 //=============================================================================
 170
 171 }; }; }; };
 172
 173 #endif