offapi/com/sun/star/mozilla/XPluginInstancePeer.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_mozilla_XPluginInstancePeer_idl__
  29 #define __com_sun_star_mozilla_XPluginInstancePeer_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/io/XActiveDataSource.idl>
  34
  35 #include <com/sun/star/io/XInputStream.idl>
  36
  37 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module mozilla {
  42
  43 //=============================================================================
  44
  45  published interface XPluginInstanceNotifySink;
  46
  47 //=============================================================================
  48
  49
  50 // DocMerge from xml: interface com::sun::star::mozilla::XPluginInstancePeer
  51 /** Allows to communicate with a plugin from the office side.
  52     This interface is oriented for communication with browsers plugins.
  53  */
  54 published interface XPluginInstancePeer: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58
  59     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::setWindowSize
  60     /** Alters the plugin's window size in the browser window.
  61
  62         @param width    [in]: the new window width
  63         @param height   [in]: the new window height
  64
  65         @return <CODE>TRUE</CODE> on success
  66      */
  67     boolean setWindowSize( [in] long width, [in] long heigth );
  68
  69     //-------------------------------------------------------------------------
  70
  71
  72     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::showStatusMessage
  73     /** Show status / hint message in browser's message area.
  74
  75         @param message  [in]: the string to be displayed
  76      */
  77     [oneway] void showStatusMessage( [in] string message );
  78
  79     //-------------------------------------------------------------------------
  80
  81
  82     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::enableScripting
  83     /** Indicates to the plugin that the document was loaded successfully and scripting
  84         interfaces are now available.
  85
  86         @param document         [in]: the active document
  87         @param servicemanager   [in]: the office servicemanager
  88
  89      */
  90     [oneway] void enableScripting( [in] com::sun::star::uno::XInterface document, [in] com::sun::star::lang::XMultiServiceFactory servicemanager );
  91
  92     //-------------------------------------------------------------------------
  93
  94
  95     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::newStream
  96     /** Creates a new stream of data produced by the plug-in and consumed by
  97         the browser.
  98
  99         @param MIMEDesc [in]:   the MIME type of the plug-in to create
 100         @param target   [in]:   the name of the target window or frame (supports _blank, _self)
 101         @param data     [in]:   on success the output stream will be    associated with this instance
 102
 103      */
 104     [oneway] void newStream(
 105         [in] string MIMEDesc,
 106         [in] string target,
 107         [in] com::sun::star::io::XActiveDataSource data
 108     );
 109
 110     //-------------------------------------------------------------------------
 111
 112
 113     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::getURL
 114     /** Fetches an URL into the target window. The parameters and their meaning map to the
 115         corresponding Netscape-API call.
 116
 117         @param aURL             [in]: the URL to be fetched
 118         @param target           [in]: the name of the target window or frame (supports _blank, _self)
 119         @param alternativeHost  [in]: alternativeHost
 120         @param referrer         [in]: referrer
 121         @param sink             [in]: the sink is notified on success
 122
 123      */
 124     [oneway] void getURL (
 125         [in] string aURL,
 126         [in] string target,
 127         [in] string alternativeHost,
 128         [in] string referrer,
 129         [in] XPluginInstanceNotifySink sink
 130     );
 131
 132     //-------------------------------------------------------------------------
 133
 134
 135     // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::postURL
 136     /** Posts to a URL with post data and/or post headers. The parameters and their meaning
 137         map to the corresponding Netscape-API call.
 138
 139         @param aURL             [in]: the URL to be posted to
 140         @param postData         [in]: the data to be posted
 141         @param target           [in]: the name of the target window or frame (supports _blank, _self)
 142         @param alternativeHost  [in]: alternativeHost
 143         @param referrer         [in]: referrer
 144         @param postHeaders      [in]: the header to be posted
 145         @param sink             [in]: the sink is notified on success
 146
 147      */
 148     [oneway] void postURL (
 149         [in] string aURL,
 150         [in] com::sun::star::io::XInputStream postData,
 151         [in] string target,
 152         [in] string alternativeHost,
 153         [in] string referrer,
 154         [in] com::sun::star::io::XInputStream postHeaders,
 155         [in] XPluginInstanceNotifySink sink
 156     );
 157 };
 158
 159 //=============================================================================
 160
 161 }; }; }; };
 162
 163 #endif
 164
 165 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */