LibreOffice
LibreOffice 7.3 SDK API Reference
DocumentIndex.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21#ifndef __com_sun_star_text_DocumentIndex_idl__
22#define __com_sun_star_text_DocumentIndex_idl__
23
26
27
28module com { module sun { module star { module text {
29
30
33published service DocumentIndex
34{
36
39 [optional, property] boolean UseAlphabeticalSeparators;
40
43 [optional, property] boolean UseKeyAsEntry;
44
47 [optional, property] boolean UseCombinedEntries;
48
51 [optional, property] boolean IsCaseSensitive;
52
55 [optional, property] boolean UsePP;
56
59 [optional, property] boolean UseDash;
60
63 [optional, property] boolean UseUpperCase;
64
68 [optional, property] string MainEntryCharacterStyleName;
69
73 [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
74
78
81 [property] string SortAlgorithm;
82};
83
84
85}; }; }; };
86
87#endif
88
89/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Definition: Ambiguous.idl:22
specifies the basic service of different indexes within a document.
Definition: BaseIndex.idl:43
specifies service of content indexes within a document.
Definition: DocumentIndex.idl:34
boolean UseDash
determines if following page numbers are displayed using a dash.
Definition: DocumentIndex.idl:59
boolean UseKeyAsEntry
determines if an index entry is generated for each primary/secondary key.
Definition: DocumentIndex.idl:43
string SortAlgorithm
contains the name of the sort algorithm that is used to sort the entries.
Definition: DocumentIndex.idl:81
boolean UseUpperCase
determines if all entries start with a capital letter.
Definition: DocumentIndex.idl:63
boolean UsePP
determines if following page numbers are displayed using a "pp.".
Definition: DocumentIndex.idl:55
boolean IsCaseSensitive
determines if the similarity of index entries is checked case sensitively.
Definition: DocumentIndex.idl:51
boolean UseCombinedEntries
determines if same entries on different pages are combined into one index entry.
Definition: DocumentIndex.idl:47
string MainEntryCharacterStyleName
determines the name of the character style that is applied to the number of a page where main index e...
Definition: DocumentIndex.idl:68
com::sun::star::lang::Locale Locale
contains the locale of the index.
Definition: DocumentIndex.idl:77
boolean UseAlphabeticalSeparators
determines if alphabetical separators are generated.
Definition: DocumentIndex.idl:39
sequence< com::sun::star::text::XDocumentIndexMark > DocumentIndexMarks
contains all index marks that are related to this index.
Definition: DocumentIndex.idl:73
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:38