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