summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdb/RelationDesign.idl
blob: e394917d4f6128a19b2a1d1fab24539c382b14ec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_sdb_RelationDesign_idl__
#define __com_sun_star_sdb_RelationDesign_idl__

#include <com/sun/star/frame/XController.idl>
#include <com/sun/star/lang/XInitialization.idl>
#include <com/sun/star/frame/XDispatchProvider.idl>
#include <com/sun/star/form/FormController.idl>

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 OOo 1.1.2
*/

published 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
        com::sun::star::lang::XInitialization::initialize())
        have to be instances of com::sun::star::beans::PropertyValue, where the
        com::sun::star::beans::PropertyValue::Name member specifies what the parameter controls,
        with the com::sun::star::beans::PropertyValue::Value member containing the value
        to be used.<br>
        Recognized parameters are:
        <ul>
            <li><b>Frame</b><br>
            has to be a com::sun::star::frame::XFrame interface specifying the frame to plug the
            RelationDesign component into.
            </li>
            <li><b>DataSourceName</b><br>
            The name of the globally registered DataSource 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */