summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/fieldmaster
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/fieldmaster')
-rw-r--r--offapi/com/sun/star/text/fieldmaster/Bibliography.idl100
-rw-r--r--offapi/com/sun/star/text/fieldmaster/DDE.idl73
-rw-r--r--offapi/com/sun/star/text/fieldmaster/Database.idl96
-rw-r--r--offapi/com/sun/star/text/fieldmaster/SetExpression.idl67
-rw-r--r--offapi/com/sun/star/text/fieldmaster/User.idl65
-rw-r--r--offapi/com/sun/star/text/fieldmaster/makefile.mk50
6 files changed, 451 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/fieldmaster/Bibliography.idl b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl
new file mode 100644
index 000000000000..844b01785500
--- /dev/null
+++ b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl
@@ -0,0 +1,100 @@
+/*************************************************************************
+ *
+ * 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_Bibliography_idl_
+#define __com_sun_star_text_fieldmaster_Bibliography_idl_
+
+#include <com/sun/star/text/TextFieldMaster.idl>
+#include <com/sun/star/beans/PropertyValues.idl>
+#include <com/sun/star/lang/Locale.idl>
+
+//=============================================================================
+
+module com { module sun { module star { module text { module fieldmaster {
+
+//=============================================================================
+/** specifies service of a Bibliography field master.
+ @see com::sun::star::text::TextField
+*/
+published service Bibliography
+{
+ service com::sun::star::text::TextFieldMaster;
+
+ //------------------------------------------------------------------------
+ /** determins whether the bibiliography text fields are numbered. If <FALSE/> the
+ short name of the bibliography entry is displayed instead.
+ */
+ [property] boolean IsNumberEntries;
+ //------------------------------------------------------------------------
+ /** determins whether the bibliography entries in a bibliography index are sorted
+ by the document position. If <FALSE/> the SortKey property determins the
+ sorting of the entries.
+ */
+ [property] boolean IsSortByPosition;
+ //------------------------------------------------------------------------
+ /** determins the opening bracket used to display the bibliography text fields.
+ */
+ [property] string BracketBefore;
+ //------------------------------------------------------------------------
+ /** determins the closing bracket used to display the bibliography text fields.
+ */
+ [property] string BracketAfter;
+ //------------------------------------------------------------------------
+ /** determins the sorting of the bibliography entries in a bibliography index.
+ This property is used if the property IsSortByPosition is not set.
+ Each contained element of the sequence is a sequence of the following
+ two properties:
+ <UL>
+ <LI><P>[property] short SortKey;</P>
+ <UL>
+ <LI><P>Determins the bibliography field that is used to sort by.</P>
+ </UL>
+ <LI><P>[property] boolean IsSortAscending;</P>
+ <UL>
+ <LI><P>Determins wheter the sorting is ascending or descending.
+ It uses the type <type scope="com::sun::star::text">BibliographyDataField</type></P>
+ </UL>
+ </UL>
+ */
+ [property] sequence< com::sun::star::beans::PropertyValues > SortKeys;
+ //------------------------------------------------------------------------
+ /** contains the locale of the field master
+ */
+ [property] com::sun::star::lang::Locale Locale;
+ //------------------------------------------------------------------------
+ /** contains the name of the sort algorithm that is used to sort the text fields.
+ */
+ [property] string SortAlgorithm;
+
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/text/fieldmaster/DDE.idl b/offapi/com/sun/star/text/fieldmaster/DDE.idl
new file mode 100644
index 000000000000..1f33ef5dac1d
--- /dev/null
+++ b/offapi/com/sun/star/text/fieldmaster/DDE.idl
@@ -0,0 +1,73 @@
+/*************************************************************************
+ *
+ * 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_DDE_idl_
+#define __com_sun_star_text_fieldmaster_DDE_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 DDE field master.
+ @see com::sun::star::text::TextField
+*/
+published service DDE
+{
+ service com::sun::star::text::TextFieldMaster;
+
+ //------------------------------------------------------------------------
+ /** contains the element string of the DDE command.
+ */
+ [property] string DDECommandElement;
+ //------------------------------------------------------------------------
+ /** contains the file string of the DDE command.
+ */
+ [property] string DDECommandFile;
+ //------------------------------------------------------------------------
+ /** contains the type string of the DDE command.
+ */
+ [property] string DDECommandType;
+ //------------------------------------------------------------------------
+ /** determins whether DDE link is updated automatically.
+ */
+ [property] boolean IsAutomaticUpdate;
+ //------------------------------------------------------------------------
+ /** contains the content.
+ */
+ [optional, property] string Content;
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+#endif
+
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
+
diff --git a/offapi/com/sun/star/text/fieldmaster/SetExpression.idl b/offapi/com/sun/star/text/fieldmaster/SetExpression.idl
new file mode 100644
index 000000000000..1c6276205f3b
--- /dev/null
+++ b/offapi/com/sun/star/text/fieldmaster/SetExpression.idl
@@ -0,0 +1,67 @@
+/*************************************************************************
+ *
+ * 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_SetExpression_idl_
+#define __com_sun_star_text_fieldmaster_SetExpression_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 the service of a set expression field master.
+ @see com::sun::star::text::TextFieldMaster
+*/
+published service SetExpression
+{
+ service com::sun::star::text::TextFieldMaster;
+
+ //------------------------------------------------------------------------
+ /** determins the number of the chapter. This values is used if the field master
+ is set as number sequence.
+ */
+ [property] byte ChapterNumberingLevel;
+ //------------------------------------------------------------------------
+ /** determins the numbering separator string if the field master
+ is set as number sequence.
+ */
+ [property] string NumberingSeparator;
+ //------------------------------------------------------------------------
+ /** determins the type of the field as <type scope="com::sun::star::text"SetVariableType</type>
+ */
+ [property] short SubType;
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/text/fieldmaster/User.idl b/offapi/com/sun/star/text/fieldmaster/User.idl
new file mode 100644
index 000000000000..555e93cfb0d1
--- /dev/null
+++ b/offapi/com/sun/star/text/fieldmaster/User.idl
@@ -0,0 +1,65 @@
+/*************************************************************************
+ *
+ * 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_ConditionalText_idl_
+#define __com_sun_star_text_fieldmaster_ConditionalText_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 the service of a user field master.
+ @see com::sun::star::text::TextFieldMaster
+*/
+published service User
+{
+ service com::sun::star::text::TextFieldMaster;
+
+ //------------------------------------------------------------------------
+ /** determins whether the field contains an expression.
+ */
+ [property] boolean IsExpression;
+ //------------------------------------------------------------------------
+ /** contains the value.
+ */
+ [property] double Value;
+ //------------------------------------------------------------------------
+ /** contains the content.
+ */
+ [property] string Content;
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/text/fieldmaster/makefile.mk b/offapi/com/sun/star/text/fieldmaster/makefile.mk
new file mode 100644
index 000000000000..ad0a5d8af18c
--- /dev/null
+++ b/offapi/com/sun/star/text/fieldmaster/makefile.mk
@@ -0,0 +1,50 @@
+#*************************************************************************
+#
+# 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.
+#
+#*************************************************************************
+
+PRJ=..$/..$/..$/..$/..
+
+PRJNAME=offapi
+
+TARGET=cssfieldmaster
+PACKAGE=com$/sun$/star$/text$/fieldmaster
+
+# --- Settings -----------------------------------------------------
+.INCLUDE : $(PRJ)$/util$/makefile.pmk
+
+# ------------------------------------------------------------------------
+
+IDLFILES=\
+ Database.idl\
+ DDE.idl\
+ Bibliography.idl\
+ SetExpression.idl\
+ User.idl\
+
+# ------------------------------------------------------------------
+
+.INCLUDE : target.mk
+.INCLUDE : $(PRJ)$/util$/target.pmk