offapi/com/sun/star/frame/XFrameLoader.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_frame_XFrameLoader_idl__
  20 #define __com_sun_star_frame_XFrameLoader_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/frame/XFrame.idl>
  24 #include <com/sun/star/beans/PropertyValue.idl>
  25 #include <com/sun/star/frame/XLoadEventListener.idl>
  26
  27
  28
  29  module com {  module sun {  module star {  module frame {
  30
  31 /** load components into a frame
  32
  33     <p>
  34     It's an asynchronous loading. For synchronous processes use XSynchronousFrameLoader
  35     instead of this one. The generic load algorithm of the office supports both ones - but preferred
  36     the synchronous interface.
  37     </p>
  38
  39     @see XFrame
  40  */
  41 published interface XFrameLoader: com::sun::star::uno::XInterface
  42 {
  43     /** starts the loading of the specified resource into the specified Frame.
  44
  45         @param Frame
  46             specifies the loading target
  47
  48         @param URL
  49             describes the resource of loading component
  50             Support of special protocols are implementation details
  51             and depends from the environment.
  52
  53         @param Arguments
  54             optional arguments for loading
  55             (see com::sun::star::document::MediaDescriptor for further information)
  56
  57         @param Listener
  58             this listener will be informed about success
  59
  60         @see XLoadEventListener
  61      */
  62     void load(
  63         [in] XFrame Frame,
  64         [in] string URL,
  65         [in] sequence< com::sun::star::beans::PropertyValue > Arguments,
  66         [in] XLoadEventListener Listener);
  67
  68     /** cancels the loading process.
  69
  70         <p>
  71         After returning from this call, neither the frame nor the
  72         load-event-listener specified in XFrameLoader::load() may be called back.
  73         Because only the owner of this process who called load method
  74         before can cancel this process. And he doesn't need any notification about that.
  75         On the other hand - nobody then this owner himself can be registered as an
  76         XLoadEventListener here.
  77         </p>
  78      */
  79     void cancel();
  80 };
  81
  82
  83 }; }; }; };
  84
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */