office-gobmx/offapi/com/sun/star/sdb/RelationDesign.idl
Rüdiger Timm 80e1ced876 INTEGRATION: CWS sdk01 (1.1.4.1.38); FILE MERGED
2003/04/07 09:10:18 mi 1.1.4.1.38.1: #107627# new idls marked with @since
2003-04-17 09:09:22 +00:00

127 lines
4.9 KiB
Text

/*************************************************************************
*
* $RCSfile: RelationDesign.idl,v $
*
* $Revision: 1.4 $
*
* last change: $Author: rt $ $Date: 2003-04-17 10:09:13 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the License); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an AS IS basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_sdb_RelationDesign_idl__
#define __com_sun_star_sdb_RelationDesign_idl__
#ifndef __com_sun_star_frame_XController_idl__
#include <com/sun/star/frame/XController.idl>
#endif
#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif
#ifndef __com_sun_star_frame_XDispatchProvider_idl__
#include <com/sun/star/frame/XDispatchProvider.idl>
#endif
#ifndef __com_sun_star_form_FormController_idl__
#include <com/sun/star/form/FormController.idl>
#endif
module com { module sun { module star { module sdb {
//=============================================================================
/** implements a component which allows the creation of relation.
<p>This service implements a user interface for relations through a graphical design interface.</p>
<p>The design view of the RelationDesign is identical to the first part of @see QueryDesign. It contains all tables
which are already connected through a relation.</p>
@see com::sun::star::sdb::ContentLoader
@see com::sun::star::frame::XDispatch
@see com::sun::star::frame::XDispatchProviderInterceptor
@since #107627#
*/
service RelationDesign
{
/** allows the component to be plugged into frames.
*/
interface com::sun::star::frame::XController;
/** is used to initialize the RelationDesign.
<p>Parameters (passed to the method
<member scope="com::sun::star::lang">XInitialization::initialize</member>)
have to be instances of <type scope="com::sun::star::beans">PropertyValue</type>, where the
<member scope="com::sun::star::beans">PropertyValue::Name</member> member specifies what the parameter controls,
with the <member scope="com::sun::star::beans">PropertyValue::Value</member> member containing the value
to be used.<br>
Recognized parameters are:
<ul>
<li><b>Frame</b><br>
has to be an <type scope="com::sun::star::frame">XFrame</type> interface specifying the frame to plug the
RelationDesign component into.
</li>
<li><b>DataSourceName</b><br>
The name of the globally registered <service>DataSource</service> to be used for initial display. It is only
meaningful together with the other parameters specifying the object to display.
</li>
</ul>
</p>
*/
interface com::sun::star::lang::XInitialization;
};
//=============================================================================
}; }; }; };
#endif