summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/DocumentIndex.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/text/DocumentIndex.idl
parentInitial commit. (diff)
downloadlibreoffice-upstream.tar.xz
libreoffice-upstream.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/text/DocumentIndex.idl89
1 files changed, 89 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/DocumentIndex.idl b/offapi/com/sun/star/text/DocumentIndex.idl
new file mode 100644
index 000000000..0d3a0bd8f
--- /dev/null
+++ b/offapi/com/sun/star/text/DocumentIndex.idl
@@ -0,0 +1,89 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
+ */
+
+
+#ifndef __com_sun_star_text_DocumentIndex_idl__
+#define __com_sun_star_text_DocumentIndex_idl__
+
+#include <com/sun/star/text/BaseIndex.idl>
+#include <com/sun/star/text/XDocumentIndexMark.idl>
+
+
+module com { module sun { module star { module text {
+
+
+/** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex
+ */
+published service DocumentIndex
+{
+ service com::sun::star::text::BaseIndex;
+
+ /** determines if alphabetical separators are generated.
+ */
+ [optional, property] boolean UseAlphabeticalSeparators;
+
+ /** determines if an index entry is generated for each primary/secondary key.
+ */
+ [optional, property] boolean UseKeyAsEntry;
+
+ /** determines if same entries on different pages are combined into one index entry.
+ */
+ [optional, property] boolean UseCombinedEntries;
+
+ /** determines if the similarity of index entries is checked case sensitively.
+ */
+ [optional, property] boolean IsCaseSensitive;
+
+ /** determines if following page numbers are displayed using a "pp.".
+ */
+ [optional, property] boolean UsePP;
+
+ /** determines if following page numbers are displayed using a dash.
+ */
+ [optional, property] boolean UseDash;
+
+ /** determines if all entries start with a capital letter.
+ */
+ [optional, property] boolean UseUpperCase;
+
+ /** determines the name of the character style that is applied to the number
+ of a page where main index entry is located.
+ */
+ [optional, property] string MainEntryCharacterStyleName;
+
+ /**
+ contains all index marks that are related to this index.
+ */
+ [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
+
+ /** contains the locale of the index.
+ */
+ [property] com::sun::star::lang::Locale Locale;
+
+ /** contains the name of the sort algorithm that is used to sort the entries.
+ */
+ [property] string SortAlgorithm;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */