offapi/com/sun/star/frame/FrameLoaderFactory.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: FrameLoaderFactory.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_FrameLoaderFactory_idl__
  31 #define __com_sun_star_frame_FrameLoaderFactory_idl__
  32
  33 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
  34 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XNameAccess_idl__
  38 #include <com/sun/star/container/XNameAccess.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_container_XContainerQuery_idl__
  42 #include <com/sun/star/container/XContainerQuery.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module frame {
  48
  49 //=============================================================================
  50 /** factory to create frame loader
  51
  52     <p>
  53     With this factory it's possible to
  54     <ul>
  55         <li>have access on configuration of set of registered frame laoder objects</li>
  56         <li>create a frame laoder by his internal name</li>
  57         <li>query for a frame laoder by using special query or property description.</li>
  58     </ul>
  59     </p>
  60  */
  61 published service FrameLoaderFactory
  62 {
  63     //-------------------------------------------------------------------------
  64     /** interface to create loader objects by using his internal name
  65
  66         <p>
  67         Returned objects must support the service specification of a <type>FrameLoader</type>
  68         or <type>SynchronousFrameLoader</type>. (Note: last one will be prefered if both ones
  69         are available)
  70         They can be created by using of his internal name, which must be unambigous everytime, only.
  71         To get this name use further specified interfaces of this factory for access on
  72         the flat configuration.
  73         </p>
  74     */
  75     interface com::sun::star::lang::XMultiServiceFactory;
  76
  77     //-------------------------------------------------------------------------
  78     /** provides access to the whole frame loader configuration
  79
  80     <p>This interface supports an access to the internal configuration of all accessible loader objects.
  81         The return value of <member scope="com::sun::star::container">XNameAccess::getByName()</member>
  82     is a property sequence packed in an any.  </p>
  83         <table border=1>
  84             <tr>
  85                 <td><b>Types<b></td>
  86                 <td>[string]</td>
  87                 <td>file types which loader is registered for</td>
  88             </tr>
  89             <tr>
  90                 <td><b>UIName<b></td>
  91                 <td>[string]</td>
  92                 <td>UI representable and localized name</td>
  93             </tr>
  94         </table>
  95     */
  96     interface com::sun::star::container::XNameAccess;
  97
  98     //-------------------------------------------------------------------------
  99     /** supports query mode for configuration access
 100
 101         <p>
 102         This interface can be used to get sub sets of current configuration entries
 103         which represent given search parameters.
 104         </p>
 105      */
 106     interface com::sun::star::container::XContainerQuery;
 107 };
 108
 109 //=============================================================================
 110
 111 }; }; }; };
 112
 113 #endif