offapi/com/sun/star/plugin/XPluginContext.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_plugin_XPluginContext_idl__
  20 #define __com_sun_star_plugin_XPluginContext_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/plugin/XPlugin.idl>
  25
  26 #include <com/sun/star/plugin/PluginVariable.idl>
  27
  28 #include <com/sun/star/plugin/PluginException.idl>
  29
  30 #include <com/sun/star/lang/XEventListener.idl>
  31
  32 #include <com/sun/star/io/XActiveDataSource.idl>
  33
  34
  35
  36  module com {  module sun {  module star {  module plugin {
  37
  38
  39 /** Interface receiving calls from a plugin library.
  40     A default context can be created using the <type>PluginManager</type>.
  41 */
  42 published interface XPluginContext: com::sun::star::uno::XInterface
  43 {
  44     /** Requests global application parameters like display connection
  45         on UNIX systems.
  46
  47         @param xPlugin
  48                plugin
  49         @param aVariable
  50                variable
  51         @return value
  52     */
  53     string getValue( [in] com::sun::star::plugin::XPlugin xPlugin,
  54              [in] com::sun::star::plugin::PluginVariable aVariable )
  55             raises( com::sun::star::plugin::PluginException );
  56
  57     /** Requests a notification of completion of the operation on an URL.
  58
  59         @param plugin
  60                plugin
  61         @param url
  62                url
  63         @param target
  64                target frame
  65         @param listener
  66                event listener
  67     */
  68     void getURLNotify( [in] com::sun::star::plugin::XPlugin plugin,
  69              [in] string url,
  70              [in] string target,
  71              [in] com::sun::star::lang::XEventListener listener )
  72             raises( com::sun::star::plugin::PluginException );
  73
  74     /** Requests an URL to be loaded into the frame target.
  75
  76         @param plugin
  77                plugin
  78         @param url
  79                url
  80         @param target
  81                target frame
  82     */
  83     void getURL( [in] com::sun::star::plugin::XPlugin plugin,
  84              [in] string url,
  85              [in] string target )
  86             raises( com::sun::star::plugin::PluginException );
  87
  88     /** Posts data from a buffer or file to an URL and receives a
  89         notification upon completion.
  90
  91         @param plugin
  92                plugin
  93         @param url
  94                url
  95         @param target
  96                target frame
  97         @param buf
  98                data
  99         @param file
 100                whether data is from file
 101         @param listener
 102                event listener
 103     */
 104     void postURLNotify( [in] com::sun::star::plugin::XPlugin plugin,
 105              [in] string url,
 106              [in] string target,
 107              [in] sequence<byte> buf,
 108              [in] boolean file,
 109              [in] com::sun::star::lang::XEventListener listener )
 110             raises( com::sun::star::plugin::PluginException );
 111
 112     /** Posts data from a buffer or file to an URL.
 113
 114         @param plugin
 115                plugin
 116         @param url
 117                url
 118         @param target
 119                target frame
 120         @param buf
 121                data
 122         @param file
 123                whether data is from file
 124     */
 125     void postURL( [in] com::sun::star::plugin::XPlugin plugin,
 126              [in] string url,
 127              [in] string target,
 128              [in] sequence<byte> buf,
 129              [in] boolean file )
 130             raises( com::sun::star::plugin::PluginException );
 131
 132     /** Requests a new stream that is created by the plugin and consumed
 133         by the browser.
 134
 135         @param plugin
 136                plugin
 137         @param mimetype
 138                mime type
 139         @param target
 140                target frame
 141         @param aSource
 142                data source
 143     */
 144     void newStream( [in] com::sun::star::plugin::XPlugin plugin,
 145              [in] string mimetype,
 146              [in] string target,
 147              [in] com::sun::star::io::XActiveDataSource aSource )
 148             raises( com::sun::star::plugin::PluginException );
 149
 150     /** Displays a message in the browser status line.
 151
 152         @param plugin
 153                plugin
 154         @param message
 155                message
 156     */
 157     void displayStatusText( [in] com::sun::star::plugin::XPlugin plugin,
 158              [in] string message )
 159             raises( com::sun::star::plugin::PluginException );
 160
 161     /** Returns an application dependent identification string.
 162         This is the same string that is transmitted by a browser to an http server.
 163
 164         @param plugin
 165                plugin
 166         @return id
 167     */
 168     string getUserAgent( [in] com::sun::star::plugin::XPlugin plugin )
 169             raises( com::sun::star::plugin::PluginException );
 170 };
 171
 172
 173 }; }; }; };
 174
 175 #endif
 176
 177 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */