summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/component/DataForm.idl
blob: bb345386eeb29fe1a298973c38d19a470462b62f (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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/*************************************************************************
 *
 *  $RCSfile: DataForm.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:15:34 $
 *
 *  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_form_component_DataForm_idl__
#define __com_sun_star_form_component_DataForm_idl__

#ifndef __com_sun_star_form_component_Form_idl__
#include <com/sun/star/form/component/Form.idl>
#endif

#ifndef __com_sun_star_sdb_RowSet_idl__
#include <com/sun/star/sdb/RowSet.idl>
#endif

#ifndef __com_sun_star_form_TabulatorCycle_idl__
#include <com/sun/star/form/TabulatorCycle.idl>
#endif

#ifndef __com_sun_star_form_NavigationBarMode_idl__
#include <com/sun/star/form/NavigationBarMode.idl>
#endif


//=============================================================================

module com { module sun { module star { module form {

interface XReset;

module component {
//=============================================================================
/** This service specifies a form which is connected to a database and
    displays the results of SQL queries. It provides the possiblity of
    adding new data records, modifying existing ones, or deleting them.

    <p>A database form is a special kind of enhanced database row set
    which provides all information for displaying the data and has more
    possibilities for configuring the data manipulation.

*/
service DatabaseForm
{
    service com::sun::star::form::component::Form;
    service com::sun::star::sdb::RowSet;
    /** is used to initialize a data row which should be inserted.
    */
    interface com::sun::star::form::XReset;

    //-------------------------------------------------------------------------
    // DOCUMENTATION CHANGED FOR DatabaseForm::MasterFields
    /**is used for subforms and contains the names of columns of the parent form.
       <p> These columns are typically the foreign key fields of the parent form.
       The values of theses columns are used to identify the data for the subform.
       Each time the parent form changes it's current row, the subform requeries
       it's data based on the values of the master fields.
    */
    [property] sequence<string> MasterFields;

    //-------------------------------------------------------------------------
    // DOCUMENTATION CHANGED FOR DatabaseForm::DetailFields
    /**is used for subforms and contains the names of the columns of the subform
       which are related to the master fields of the parent form.
       <p> These columns represent typically a part of the primary key fields or their aliases
       of the detail form and are used as parameters in a database query to retrieve
       the details for an according master form.
    */
    [property] sequence<string> DetailFields;

    //-------------------------------------------------------------------------
    /** returns the kind of tabulator controlling.
    */
    [property] com::sun::star::form::TabulatorCycle Cycle;

    //-------------------------------------------------------------------------
    /** How to use a NavigationBar?
    */
    [property] com::sun::star::form::NavigationBarMode NavigationBarMode;

    //-------------------------------------------------------------------------
    /** Are insertions of new records allowed?
    */
    [property] boolean AllowInserts;

    //-------------------------------------------------------------------------
    /** Are modifications of the current record allowed?
    */
    [property] boolean AllowUpdates;

    //-------------------------------------------------------------------------
    /** Are deletions of records allowed?
    */
    [property] boolean AllowDeletes;
};

//=============================================================================

}; }; }; }; };

#endif