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

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