offapi/com/sun/star/frame/FrameLoader.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: FrameLoader.idl,v $
  10  * $Revision: 1.11 $
  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_FrameLoader_idl__
  31 #define __com_sun_star_frame_FrameLoader_idl__
  32
  33 #ifndef __com_sun_star_frame_XFrameLoader_idl__
  34 #include <com/sun/star/frame/XFrameLoader.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_XInitialization_idl__
  38 #include <com/sun/star/lang/XInitialization.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_container_XNamed_idl__
  42 #include <com/sun/star/container/XNamed.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module frame {
  48
  49 //=============================================================================
  50 /** derivations of this abstract service are used to load components
  51     into <type>Frame</type>s of the environment
  52
  53     <p>
  54     Concrete implementations of this service register, for example,
  55     for file name extensions or MIME types to load appropriate
  56     components. The components loaded are at least <type>Controller</type>.
  57     Instead of <type>SynchronousFrameLoader</type> this one use asynchronous
  58     processes to load the component.
  59     </p>
  60
  61     @see SynchronousFrameLoader
  62  */
  63 published service FrameLoader
  64 {
  65     //-------------------------------------------------------------------------
  66     /** support asynchronous loading of the component
  67      */
  68     interface XFrameLoader;
  69
  70     //-------------------------------------------------------------------------
  71     /** support initialization of loader with its own configuration!
  72
  73         <p>
  74         Concrete implementations should use it to get her own configuration data
  75         directly after creation by the <type>FrameLoaderFactory</type>.
  76         Otherwhise they must use normal configuration api to do so.
  77         </p>
  78      */
  79     [optional] interface com::sun::star::lang::XInitialization;
  80
  81     //-------------------------------------------------------------------------
  82     /** provides access to the internal name of this frame loader
  83
  84         <p>
  85         The internal name is a part of his configuration and will be passed by
  86         the <type>FrameLoaderFactory</type> after creation
  87         if optional interface <type scope="com::sun::star::lang">XInitialization</type>
  88         is supported. Value of function <member scope="com::sun::star::container">XNamed::getName()</member>
  89     can be used on service <type>FrameLoaderFactory</type> to get further informations about this loader.
  90         Setting of this name by calling <member scope="com::sun::star::container">XNamed::setName()</member>
  91     must be forwarded to same factory service. He should decide, if it's allowed or not.
  92         The reason: prevent code against name ambigities.
  93         </p>
  94      */
  95      [optional] interface com::sun::star::container::XNamed;
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif