offapi/com/sun/star/sdb/ContentLoader.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
  20
  21 module com {  module sun {  module star {  module sdb {
  22
  23 /** implements a loader for various datasource-related user interface components.
  24
  25     <p>Usually, you don't deal with this loader directly. Instead, use an instance with
  26     the com::sun::star::frame::XComponentLoader interface, and pass
  27     one of the below-mentioned URLs to it.</p>
  28
  29     @see com::sun::star::frame::XComponentLoader
  30     @see com::sun::star::frame::Desktop
  31 */
  32 published service ContentLoader
  33 {
  34     /** ensures the basic functionality.
  35
  36         <p>
  37         Supporting this service ensures that you can plug any of the components
  38         the loader can create into an arbitrary frame.
  39         </p>
  40
  41         The loader should be registered for the URL scheme
  42         <b>
  43         .component:DB/ *
  44         </b>
  45         , the concrete URLs supported are:
  46         <ul>
  47             <li><b>.component:DB/DataSourceBrowser</b><br/>
  48                 Using this URL creates an instance of the
  49                 com::sun::star::sdb::DataSourceBrowser
  50                 service and plugs it into the frame passed to the loader.
  51             </li>
  52             <li><b>.component:DB/FormGridView</b><br/>
  53                 Using this URL creates an instance of the
  54                 com::sun::star::sdb::ExternalSourceBrowser
  55                 service and plugs it into the frame passed to the loader.
  56             </li>
  57             <li><b>.component:DB/QueryDesign</b><br/>
  58                 Using this URL creates an instance of the
  59                 com::sun::star::sdb::QueryDesign
  60                 service and plugs it into the frame passed to the loader.
  61             </li>
  62             <li><b>.component:DB/TableDesign</b><br/>
  63                 Using this URL creates an instance of the
  64                 com::sun::star::sdb::TableDesign
  65                 service and plugs it into the frame passed to the loader.
  66             </li>
  67             <li><b>.component:DB/RelationDesign</b><br/>
  68                 Using this URL creates an instance of the
  69                 com::sun::star::sdb::RelationDesign
  70                 service and plugs it into the frame passed to the loader.
  71             </li>
  72         </ul>
  73
  74         The parameters passed to the
  75         com::sun::star::frame::XFrameLoader::load()
  76         are forwarded to the object being created,
  77         in particular to its
  78         com::sun::star::lang::XInitialization
  79         interface.
  80     **/
  81     service com::sun::star::frame::FrameLoader;
  82 };
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */