offapi/com/sun/star/sdb/TableDesign.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 module com {  module sun {  module star {  module sdb {
  21
  22 /** implements a component which allows the creation of tables.
  23
  24     <p>This service implements a user interface for creating tables through a graphical design interface.</p>
  25
  26     <p>The design view of the TableDesign is divided into two parts. The first part contains the rows
  27     where columns can be defined for the table. The second part contains the properties of the selected column.</p>
  28
  29     @see com::sun::star::sdb::ContentLoader
  30     @see com::sun::star::frame::XDispatch
  31     @see com::sun::star::frame::XDispatchProviderInterceptor
  32
  33     @since OOo 1.1.2
  34 */
  35
  36 published service TableDesign
  37 {
  38     /** allows the component to be plugged into frames.
  39     */
  40     interface com::sun::star::frame::XController;
  41
  42     /** is used to initialize the TableDesign.
  43
  44         <p>Parameters (passed to the method
  45         com::sun::star::lang::XInitialization::initialize())
  46         have to be instances of com::sun::star::beans::PropertyValue, where the
  47         com::sun::star::beans::PropertyValue::Name member specifies what the parameter controls,
  48         with the com::sun::star::beans::PropertyValue::Value member containing the value
  49         to be used.<br>
  50         Recognized parameters are:
  51         <ul>
  52             <li><b>Frame</b><br>
  53             has to be a com::sun::star::frame::XFrame interface specifying the frame to plug the
  54             TableDesign component into.
  55             </li>
  56             <li><b>DataSourceName</b><br>
  57             The name of the globally registered DataSource to be used for initial display. It is only
  58             meaningful together with the other parameters specifying the object to display.
  59             </li>
  60             <li><b>CurrentTable</b><br>
  61             This is a string giving the name of the object to display initially.
  62             </li>
  63         </ul>
  64         </p>
  65     */
  66     interface com::sun::star::lang::XInitialization;
  67 };
  68
  69 }; }; }; };
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */