summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/DocumentIndexFormat.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/DocumentIndexFormat.idl')
-rw-r--r--offapi/com/sun/star/text/DocumentIndexFormat.idl86
1 files changed, 86 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/DocumentIndexFormat.idl b/offapi/com/sun/star/text/DocumentIndexFormat.idl
new file mode 100644
index 000000000000..3f4d305bfe17
--- /dev/null
+++ b/offapi/com/sun/star/text/DocumentIndexFormat.idl
@@ -0,0 +1,86 @@
+/*************************************************************************
+ *
+ * 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_DocumentIndexFormat_idl__
+#define __com_sun_star_text_DocumentIndexFormat_idl__
+
+
+//=============================================================================
+
+module com { module sun { module star { module text {
+
+//=============================================================================
+/** specifies the formatting of document indexes.
+
+ @deprecated
+ the service was never implemented, none of it's properties do exist.
+
+*/
+published service DocumentIndexFormat
+{
+ //-------------------------------------------------------------------------
+ /** This property contains the name of the paragraph style that is
+ used for the index title.
+
+ */
+ [property] string TitleStyle;
+
+ //-------------------------------------------------------------------------
+ /** This property contains the name of the paragraph style that is
+ used for the separator. This entry is ignored for user indexes
+ and content indexes.
+
+ */
+ [property] string SeparatorStyle;
+
+ //-------------------------------------------------------------------------
+ /** contains the number of levels in the document index.
+ */
+ [readonly, property] short LevelCount;
+
+ //-------------------------------------------------------------------------
+ /** This sequence contains the names of the paragraph styles that are
+ applied to the level corresponding to the position in the sequence.
+ */
+ [property] sequence<string> LevelStyles;
+
+ //-------------------------------------------------------------------------
+ /** This method specifies whether the form supports hyperlinks.
+ */
+ [readonly, property] boolean HasHyperlinks;
+
+ //-------------------------------------------------------------------------
+ /** return an object that provides the service "com.sun.star.text.DocumentIndexLevelFormat"
+ @see com.sun.star.text.DocumentIndexLevelFormat
+ */
+ [property] sequence<string> LevelFormat;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif