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#ifndef __com_sun_star_text_UserIndex_idl__ 25#define __com_sun_star_text_UserIndex_idl__ 26 27#include <com/sun/star/text/BaseIndex.idl> 28 29//============================================================================= 30 31module com { module sun { module star { module text { 32 33//============================================================================= 34/** specifies service of user defined indexes within a document. 35 @see com::sun::star::text::BaseIndex 36*/ 37published service UserIndex 38{ 39 service com::sun::star::text::BaseIndex; 40 41 /** contains the interface to access the paragraph style names that are included 42 in this index. 43 @see DocumentIndexParagraphStyles 44 */ 45 [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles; 46 47 /** determins if the document index marks are included in this index. 48 */ 49 [optional, property] boolean CreateFromMarks; 50 51 /** determins if the outline level of the location of the indexed object is 52 used as index level of the index entry.*/ 53 [optional, property] boolean UseLevelFromSource; 54 55 /** determins if tables are included in the index. 56 */ 57 [optional, property] boolean CreateFromTables; 58 59 /** determins if text frames are included in the index. 60 */ 61 [optional, property] boolean CreateFromTextFrames; 62 63 /** determins if graphic objects are included in the index. 64 */ 65 [optional, property] boolean CreateFromGraphicObjects; 66 67 /** determins if embedded objects are included in the index. 68 */ 69 [optional, property] boolean CreateFromEmbeddedObjects; 70 /** contains the name of the user index. 71 */ 72 [property] string UserIndexName; 73}; 74 75//============================================================================= 76 77}; }; }; }; 78 79#endif 80 81