offapi/com/sun/star/frame/XLoaderFactory.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_XLoaderFactory_idl__
  20 #define __com_sun_star_frame_XLoaderFactory_idl__
  21
  22 #include <com/sun/star/container/XContainerQuery.idl>
  23 #include <com/sun/star/container/XNameAccess.idl>
  24 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module frame {
  29
  30 /**
  31     Unified service interface for FrameLoaderFactory and ContentHandlerFactory.
  32
  33     @since LibreOffice 4.2
  34  */
  35 published interface XLoaderFactory
  36 {
  37     /** interface to create loader objects by using his internal name
  38
  39         <p>
  40         Returned objects must support the service specification of a FrameLoader
  41         or SynchronousFrameLoader. (Note: last one will be preferred if both
  42         are available)
  43         They can be created by using of his internal name, which must be unambiguous every time, only.
  44         To get this name use further specified interfaces of this factory for access on
  45         the flat configuration.
  46         </p>
  47     */
  48     interface com::sun::star::lang::XMultiServiceFactory;
  49
  50     /** provides access to the whole frame loader configuration
  51
  52     <p>This interface supports an access to the internal configuration of all accessible loader objects.
  53         The return value of com::sun::star::container::XNameAccess::getByName()
  54         is a property sequence packed in an any.
  55     </p>
  56         <table border=1>
  57             <tr>
  58                 <td><b>Types</b></td>
  59                 <td>[string]</td>
  60                 <td>file types which loader is registered for</td>
  61             </tr>
  62             <tr>
  63                 <td><b>UIName</b></td>
  64                 <td>[string]</td>
  65                 <td>UI representable and localized name</td>
  66             </tr>
  67         </table>
  68     */
  69     interface com::sun::star::container::XNameAccess;
  70
  71     /** supports query mode for configuration access
  72
  73         <p>
  74         This interface can be used to get sub sets of current configuration entries
  75         which represent given search parameters.
  76         </p>
  77      */
  78     interface com::sun::star::container::XContainerQuery;
  79
  80 };
  81
  82
  83 }; }; }; };
  84
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */