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