offapi/com/sun/star/sdb/ContentLoader.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: ContentLoader.idl,v $
  10  * $Revision: 1.9 $
  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
  31
  32 #ifndef __com_sun_star_sdb_ContentLoader_idl__
  33 #define __com_sun_star_sdb_ContentLoader_idl__
  34
  35 #ifndef __com_sun_star_frame_Frame_idl__
  36 #include <com/sun/star/frame/FrameLoader.idl>
  37 #endif
  38
  39 module com {  module sun {  module star {  module sdb {
  40
  41 //=============================================================================
  42 /** implements a loader for various datasource-related user interface components.
  43
  44     <p>Usually, you don't deal with this loader directly. Instead, use an instance with
  45     the <type scope="com::sun::star::frame">XComponentLoader</type> interface, and pass
  46     one of the below-mentioned URLs to it.</p>
  47
  48     @see com::sun::star::frame::XComponentLoader
  49     @see com::sun::star::frame::Desktop
  50 */
  51 published service ContentLoader
  52 {
  53     /** ensures the basic functionality.
  54
  55         <p>
  56         Supporting this service ensures that you can plug any of the components
  57         the loader can create into an arbitrary frame.
  58         </p>
  59
  60         The loader should be registered for the URL scheme
  61         <b>
  62         .component:DB/ *
  63         </b>
  64         , the concrete URLs supported are:
  65         <ul>
  66             <li><b>.component:DB/DataSourceBrowser</b><br/>
  67                 Using this URL creates an instance of the
  68                 <type scope="com::sun::star::sdb">DataSourceBrowser</type>
  69                 service and plugs it into the frame passed to the loader.
  70             </li>
  71             <li><b>.component:DB/FormGridView</b><br/>
  72                 Using this URL creates an instance of the
  73                 <type scope="com::sun::star::sdb">ExternalSourceBrowser</type>
  74                 service and plugs it into the frame passed to the loader.
  75             </li>
  76             <li><b>.component:DB/QueryDesign</b><br/>
  77                 Using this URL creates an instance of the
  78                 <type scope="com::sun::star::sdb">QueryDesign</type>
  79                 service and plugs it into the frame passed to the loader.
  80             </li>
  81             <li><b>.component:DB/TableDesign</b><br/>
  82                 Using this URL creates an instance of the
  83                 <type scope="com::sun::star::sdb">TableDesign</type>
  84                 service and plugs it into the frame passed to the loader.
  85             </li>
  86             <li><b>.component:DB/RelationDesign</b><br/>
  87                 Using this URL creates an instance of the
  88                 <type scope="com::sun::star::sdb">RelationDesign</type>
  89                 service and plugs it into the frame passed to the loader.
  90             </li>
  91         </ul>
  92
  93         The parameters passed to the
  94         <member scope="com::sun::star::frame">XFrameLoader::load()</member>
  95         are forwarded to the object beeing created,
  96         in particular to it's
  97         <type scope="com::sun::star::lang">XInitialization</type>
  98         interface.
  99     **/
 100     service com::sun::star::frame::FrameLoader;
 101 };
 102
 103 //=============================================================================
 104 }; }; }; };
 105
 106 #endif