summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/fieldmaster/Database.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/fieldmaster/Database.idl')
-rw-r--r--offapi/com/sun/star/text/fieldmaster/Database.idl96
1 files changed, 96 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/fieldmaster/Database.idl b/offapi/com/sun/star/text/fieldmaster/Database.idl
new file mode 100644
index 000000000000..f37e3d5e2fbf
--- /dev/null
+++ b/offapi/com/sun/star/text/fieldmaster/Database.idl
@@ -0,0 +1,96 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org 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 version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_text_fieldmaster_Database_idl_
+#define __com_sun_star_text_fieldmaster_Database_idl_
+
+#include <com/sun/star/text/TextFieldMaster.idl>
+#include <com/sun/star/beans/PropertyValues.idl>
+
+//=============================================================================
+
+module com { module sun { module star { module text { module fieldmaster {
+
+//=============================================================================
+/** specifies service of a Database field master.
+ @see com::sun::star::text::TextField
+
+ Only one of the properties <member>DataBaseName</member>,
+ <member>DataBaseURL</member> and <member>DataBaseResource</member>
+ should be set. If more than one are set the last one will be used.
+*/
+published service Database
+{
+ service com::sun::star::text::TextFieldMaster;
+
+ //------------------------------------------------------------------------
+ /** specifies the database name.
+ */
+ [property] string DataBaseName;
+
+ //------------------------------------------------------------------------
+ /** contains the CommandType this
+ can be the name of a data base table, a data query or a statement.
+ (0 = table, 1 = query, 2 = statement)
+ */
+ [property] long CommandType;
+ //------------------------------------------------------------------------
+ /** contains the command string. Depending on the CommandType property this
+ can be the name of a data base table, a data query or a statement.
+ */
+ [property] string DataTableName;
+ //------------------------------------------------------------------------
+ /** contains the name of the data base table.
+ */
+ [property] string DataColumnName;
+
+ //------------------------------------------------------------------------
+ /** indicates the URL of a database file.
+ @since OOo 2.0
+ */
+ [optional, property] string DataBaseURL;
+
+ //------------------------------------------------------------------------
+ /** indicates a connection URL, which locates a database driver.
+ @since OOo 2.0
+ */
+ [optional, property] string DataBaseResource;
+ //------------------------------------------------------------------------
+ /** contains the DataColumnName but it enables the fieldmaster and its
+ depending fields to work without setting DataSourceName, DataTableName and CommandType
+ @since OOo 2.3
+ */
+ [optional, property] string Name;
+
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+#endif
+