LibreOffice 24.2 SDK API Reference
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
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 .
18  */
22 module com { module sun { module star { module text {
27 published service DocumentIndex
28 {
33  [optional, property] boolean UseAlphabeticalSeparators;
37  [optional, property] boolean UseKeyAsEntry;
41  [optional, property] boolean UseCombinedEntries;
45  [optional, property] boolean IsCaseSensitive;
49  [optional, property] boolean UsePP;
53  [optional, property] boolean UseDash;
57  [optional, property] boolean UseUpperCase;
62  [optional, property] string MainEntryCharacterStyleName;
67  [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
75  [property] string SortAlgorithm;
76 };
79 }; }; }; };
81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
boolean UseUpperCase
determines if all entries start with a capital letter.
Definition: DocumentIndex.idl:57
boolean UseDash
determines if following page numbers are displayed using a dash.
Definition: DocumentIndex.idl:53
com::sun::star::lang::Locale Locale
contains the locale of the index.
Definition: DocumentIndex.idl:71
Definition: Ambiguous.idl:20
boolean UseKeyAsEntry
determines if an index entry is generated for each primary/secondary key.
Definition: DocumentIndex.idl:37
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:33
sequence< com::sun::star::text::XDocumentIndexMark > DocumentIndexMarks
contains all index marks that are related to this index.
Definition: DocumentIndex.idl:67
boolean UsePP
determines if following page numbers are displayed using a "pp.".
Definition: DocumentIndex.idl:49
boolean IsCaseSensitive
determines if the similarity of index entries is checked case sensitively.
Definition: DocumentIndex.idl:45
specifies the basic service of different indexes within a document.
Definition: BaseIndex.idl:29
specifies service of content indexes within a document.
Definition: DocumentIndex.idl:27
boolean UseCombinedEntries
determines if same entries on different pages are combined into one index entry.
Definition: DocumentIndex.idl:41
string SortAlgorithm
contains the name of the sort algorithm that is used to sort the entries.
Definition: DocumentIndex.idl:75
boolean UseAlphabeticalSeparators
determines if alphabetical separators are generated.
Definition: DocumentIndex.idl:29
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:62