offapi/com/sun/star/frame/XFrameLoader.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: XFrameLoader.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_XFrameLoader_idl__
  31 #define __com_sun_star_frame_XFrameLoader_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 #ifndef __com_sun_star_frame_XLoadEventListener_idl__
  46 #include <com/sun/star/frame/XLoadEventListener.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module frame {
  53
  54 //=============================================================================
  55 /** load components into a frame
  56
  57     <p>
  58     It's an asynchronous loading. For synchronous processes use <type>XSynchronousFrameLoader</type>
  59     instead of this one. The generic load algorithm of the office supports both ones - but prefered
  60     the synchronous interface.
  61     </p>
  62
  63     @see XFrame
  64  */
  65 published interface XFrameLoader: com::sun::star::uno::XInterface
  66 {
  67     //-------------------------------------------------------------------------
  68     /** starts the loading of the specified resource into the specified <type>Frame</type>.
  69
  70         @param Frame
  71             specifies the loading target
  72
  73         @param URL
  74             describes the ressource of loading component
  75             Support of special protocols are implementation details
  76             and depends from the environment.
  77
  78         @param Arguments
  79             optional arguments for loading
  80             (see <type scope="com::sun::star::document">MediaDescriptor</type> for further informations)
  81
  82         @param Listener
  83             this listener will be informed about success
  84
  85         @see XLoadEventListener
  86      */
  87     [oneway] void load(
  88         [in] XFrame Frame,
  89         [in] string URL,
  90         [in] sequence< com::sun::star::beans::PropertyValue > Arguments,
  91         [in] XLoadEventListener Listener);
  92
  93     //-------------------------------------------------------------------------
  94     /** cancels the loading process.
  95
  96         <p>
  97         After returning from this call, neither the frame nor the
  98         load-event-listener specified in <member>XFrameLoader::load()</member> may be called back.
  99         Because only the owner of this process who called load method
 100         before can cancel this process. And he doesn't need any notification about that.
 101         On the other hand - nobody then this owner himself can be registered as an
 102         <type>XLoadEventListener</type> here.
 103         </p>
 104      */
 105     [oneway] void cancel();
 106 };
 107
 108 //=============================================================================
 109
 110 }; }; }; };
 111
 112 #endif