offapi/com/sun/star/sdb/RelationDesign.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: RelationDesign.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 #ifndef __com_sun_star_sdb_RelationDesign_idl__
  31 #define __com_sun_star_sdb_RelationDesign_idl__
  32
  33 #ifndef __com_sun_star_frame_XController_idl__
  34 #include <com/sun/star/frame/XController.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_XInitialization_idl__
  37 #include <com/sun/star/lang/XInitialization.idl>
  38 #endif
  39 #ifndef __com_sun_star_frame_XDispatchProvider_idl__
  40 #include <com/sun/star/frame/XDispatchProvider.idl>
  41 #endif
  42 #ifndef __com_sun_star_form_FormController_idl__
  43 #include <com/sun/star/form/FormController.idl>
  44 #endif
  45
  46 module com {  module sun {  module star {  module sdb {
  47
  48 //=============================================================================
  49 /** implements a component which allows the creation of relation.
  50
  51     <p>This service implements a user interface for relations through a graphical design interface.</p>
  52
  53     <p>The design view of the RelationDesign is identical to the first part of @see QueryDesign. It contains all tables
  54     which are already connected through a relation.</p>
  55
  56     @see com::sun::star::sdb::ContentLoader
  57     @see com::sun::star::frame::XDispatch
  58     @see com::sun::star::frame::XDispatchProviderInterceptor
  59
  60     @since OOo 1.1.2
  61 */
  62
  63 published service RelationDesign
  64 {
  65     /** allows the component to be plugged into frames.
  66     */
  67     interface com::sun::star::frame::XController;
  68
  69     /** is used to initialize the RelationDesign.
  70
  71         <p>Parameters (passed to the method
  72         <member scope="com::sun::star::lang">XInitialization::initialize</member>)
  73         have to be instances of <type scope="com::sun::star::beans">PropertyValue</type>, where the
  74         <member scope="com::sun::star::beans">PropertyValue::Name</member> member specifies what the parameter controls,
  75         with the <member scope="com::sun::star::beans">PropertyValue::Value</member> member containing the value
  76         to be used.<br>
  77         Recognized parameters are:
  78         <ul>
  79             <li><b>Frame</b><br>
  80             has to be an <type scope="com::sun::star::frame">XFrame</type> interface specifying the frame to plug the
  81             RelationDesign component into.
  82             </li>
  83             <li><b>DataSourceName</b><br>
  84             The name of the globally registered <type>DataSource</type> to be used for initial display. It is only
  85             meaningful together with the other parameters specifying the object to display.
  86             </li>
  87         </ul>
  88         </p>
  89     */
  90     interface com::sun::star::lang::XInitialization;
  91 };
  92
  93 //=============================================================================
  94 }; }; }; };
  95
  96 #endif