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