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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_frame_FrameLoaderFactory_idl__
  20 #define __com_sun_star_frame_FrameLoaderFactory_idl__
  21
  22 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  23 #include <com/sun/star/container/XNameAccess.idl>
  24 #include <com/sun/star/container/XContainerQuery.idl>
  25
  26
  27 module com { module sun { module star { module frame {
  28
  29 /** factory to create frame loader
  30
  31     <p>
  32     With this factory it's possible to
  33     <ul>
  34         <li>have access on configuration of set of registered frame loader objects</li>
  35         <li>create a frame loader by his internal name</li>
  36         <li>query for a frame loader by using special query or property description.</li>
  37     </ul>
  38     </p>
  39  */
  40 published service FrameLoaderFactory
  41 {
  42     /** interface to create loader objects by using his internal name
  43
  44         <p>
  45         Returned objects must support the service specification of a <type>FrameLoader</type>
  46         or <type>SynchronousFrameLoader</type>. (Note: last one will be preferred if both ones
  47         are available)
  48         They can be created by using of his internal name, which must be unambiguous everytime, only.
  49         To get this name use further specified interfaces of this factory for access on
  50         the flat configuration.
  51         </p>
  52     */
  53     interface com::sun::star::lang::XMultiServiceFactory;
  54
  55     /** provides access to the whole frame loader configuration
  56
  57     <p>This interface supports an access to the internal configuration of all accessible loader objects.
  58         The return value of <member scope="com::sun::star::container">XNameAccess::getByName()</member>
  59     is a property sequence packed in an any.  </p>
  60         <table border=1>
  61             <tr>
  62                 <td><b>Types<b></td>
  63                 <td>[string]</td>
  64                 <td>file types which loader is registered for</td>
  65             </tr>
  66             <tr>
  67                 <td><b>UIName<b></td>
  68                 <td>[string]</td>
  69                 <td>UI representable and localized name</td>
  70             </tr>
  71         </table>
  72     */
  73     interface com::sun::star::container::XNameAccess;
  74
  75     /** supports query mode for configuration access
  76
  77         <p>
  78         This interface can be used to get sub sets of current configuration entries
  79         which represent given search parameters.
  80         </p>
  81      */
  82     interface com::sun::star::container::XContainerQuery;
  83 };
  84
  85
  86 }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */