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_UserDefinedIndex_idl__ 26#define __com_sun_star_text_UserDefinedIndex_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 user defined indexes within a document.@see com::sun::star::text::BaseIndex 40 */ 41published service UserDefinedIndex 42{ 43 service com::sun::star::text::BaseIndex; 44 45 /** contains the interface to access the paragraph style names that are included 46 in this index. 47 @see DocumentIndexParagraphStyles 48 */ 49 [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles; 50 51 /** determins if the document index marks are included in this index. 52 */ 53 [optional, property] boolean CreateFromMarks; 54 55 /** determins if the outline level of the location of the indexed object is 56 used as index level of the index entry.*/ 57 [optional, property] boolean UseLevelFromSource; 58 59 /** determins if tables are included in the index. 60 */ 61 [optional, property] boolean CreateFromTables; 62 63 /** determins if text frames are included in the index. 64 */ 65 [optional, property] boolean CreateFromTextFrames; 66 67 /** determins if graphic objects are included in the index. 68 */ 69 [optional, property] boolean CreateFromGraphicObjects; 70 71 /** determins if embedded objects are included in the index. 72 */ 73 [optional, property] boolean CreateFromEmbeddedObjects; 74 75 /** 76 contains all index marks that are related to this index. 77 */ 78 [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks; 79}; 80 81//============================================================================= 82 83}; }; }; }; 84#endif 85 86