1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24
25#ifndef __com_sun_star_text_DocumentIndex_idl__
26#define __com_sun_star_text_DocumentIndex_idl__
27
28#include <com/sun/star/text/BaseIndex.idl>
29#ifndef __com_sun_star_text_XDocumentIndexMark_idl__
30#include <com/sun/star/text/XDocumentIndexMark.idl>
31#endif
32
33//=============================================================================
34
35module com {  module sun {  module star {  module text {
36
37//=============================================================================
38
39/** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex
40 */
41published service DocumentIndex
42{
43	service  com::sun::star::text::BaseIndex;
44
45	/** determines if alphabetical separators are genererated.
46	 */
47	[optional, property] boolean UseAlphabeticalSeparators;
48
49	/** determines if a index entry is generated for each primary/secondary key.
50	 */
51	[optional, property] boolean UseKeyAsEntry;
52
53	/** determines if same entries on different pages are combined into one index entry.
54	 */
55	[optional, property] boolean UseCombinedEntries;
56
57	/** determines if the similarity of index entries is checked case sensitively.
58	 */
59	[optional, property] boolean IsCaseSensitive;
60
61	/** determines if following page numbers are displayed using a 'pp.'.
62	 */
63	[optional, property] boolean UsePP;
64
65	/** determines if if following page numbers are displayed using a dash.
66	 */
67	[optional, property] boolean UseDash;
68
69	/** determines if all entries start with a capital letter.
70	 */
71	[optional, property] boolean UseUpperCase;
72
73	/** determines the name of the character style that is applied to the number
74	 of a page where main index entry is located.
75	 */
76	[optional, property] string MainEntryCharacterStyleName;
77
78	/**
79	 contains all index marks that are related to this index.
80	 */
81    [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
82
83    //------------------------------------------------------------------------
84    /** contains the locale of the index.
85     */
86    [property] com::sun::star::lang::Locale  Locale;
87
88    //------------------------------------------------------------------------
89    /** contains the name of the sort algorithm that is used to sort the entries.
90     */
91    [property] string SortAlgorithm;
92};
93
94//=============================================================================
95
96}; }; }; };
97
98#endif
99