summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/component/DataForm.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/form/component/DataForm.idl')
-rw-r--r--offapi/com/sun/star/form/component/DataForm.idl156
1 files changed, 156 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/component/DataForm.idl b/offapi/com/sun/star/form/component/DataForm.idl
new file mode 100644
index 000000000000..6ba986c2e1d5
--- /dev/null
+++ b/offapi/com/sun/star/form/component/DataForm.idl
@@ -0,0 +1,156 @@
+/*************************************************************************
+ *
+ * $RCSfile: DataForm.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2000-11-06 09:21:42 $
+ *
+ * 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