offapi/com/sun/star/frame/XSynchronousFrameLoader.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
  20
  21  module com {  module sun {  module star {  module frame {
  22
  23 /** loads a resource into a Frame.
  24
  25     <p>
  26     Unlike the XFrameLoader interface, this loading will be synchronous.
  27      </p>
  28
  29     @see XFrameLoader
  30  */
  31 published interface XSynchronousFrameLoader: com::sun::star::uno::XInterface
  32 {
  33     /** starts the loading of the specified resource into the specified Frame.
  34
  35         @param Descriptor
  36             describes the resource which should be loaded
  37             It use a com::sun::star::document::MediaDescriptor for that.
  38
  39         @param Frame
  40             the target frame which should contain the new loaded component
  41
  42         @return
  43             `TRUE` if loading is successfully
  44             <br>
  45             `FALSE` otherwise
  46      */
  47     boolean load(
  48         [in] sequence< com::sun::star::beans::PropertyValue > Descriptor,
  49         [in] XFrame Frame );
  50
  51     /** cancels the loading process.
  52
  53         <p>
  54         No notifications (neither to the frame or the caller) must be notified.
  55         Because it's a synchronous process this cancel call can be forced by
  56         another thread the loader thread only. Method
  57         XSynchronousFrameLoader::load() must return `FALSE`
  58         then and caller of this method XSynchronousFrameLoader::cancel()
  59         already knows the state ...
  60         </p>
  61      */
  62     void cancel();
  63 };
  64
  65
  66 }; }; }; };
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */