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