offapi/com/sun/star/frame/XSynchronousFrameLoader.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_frame_XSynchronousFrameLoader_idl__
  28 #define __com_sun_star_frame_XSynchronousFrameLoader_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_frame_XFrame_idl__
  35 #include <com/sun/star/frame/XFrame.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_PropertyValue_idl__
  39 #include <com/sun/star/beans/PropertyValue.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module frame {
  45
  46 //=============================================================================
  47 /** loads a resource into a <type>Frame</type>.
  48
  49     <p>
  50     Unlike the <type>XFrameLoader</type> interface, this loading will be synchronous.
  51      </p>
  52
  53     @see XFrameLoader
  54  */
  55 published interface XSynchronousFrameLoader: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /** starts the loading of the specified resource into the specified <type>Frame</type>.
  59
  60         @param Descriptor
  61             describes the ressource which should be loaded
  62             It use a <type scope="com::sun::star::document">MediaDescriptor</type> for that.
  63
  64         @param Frame
  65             the target frame which should contain the new loaded component
  66
  67         @return
  68             <TRUE/> if loading is successfully
  69             <br>
  70             <FALSE/> otherwise
  71      */
  72     boolean load(
  73         [in] sequence< com::sun::star::beans::PropertyValue > Descriptor,
  74         [in] XFrame Frame );
  75
  76     //-------------------------------------------------------------------------
  77     /** cancels the loading process.
  78
  79         <p>
  80         No notifications (neither to the frame or the caller) must be notified.
  81         Because it's a synchronous process this cancel call can be forced by
  82         another thread the loader thread only. Method
  83         <member>XSynchronousFrameLoader::load()</member> must return <FALSE/>
  84         then and caller of this method <member>XSynchronousFrameLoader::cancel()</member>
  85         already knows the state ...
  86         </p>
  87      */
  88     void cancel();
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; };
  94
  95 #endif