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#ifndef __com_sun_star_text_XDocumentIndexMark_idl__ 24#define __com_sun_star_text_XDocumentIndexMark_idl__ 25 26#ifndef __com_sun_star_text_XTextContent_idl__ 27#include <com/sun/star/text/XTextContent.idl> 28#endif 29 30 31//============================================================================= 32 33 module com { module sun { module star { module text { 34 35//============================================================================= 36 37// DocMerge from xml: interface com::sun::star::text::XDocumentIndexMark 38/** gives access to the mark of a document index entry.@see DocumentIndexMark 39 */ 40published interface XDocumentIndexMark: com::sun::star::text::XTextContent 41{ 42 //------------------------------------------------------------------------- 43 44 // DocMerge from idl: method com::sun::star::text::XDocumentIndexMark::getMarkEntry 45 /** @returns 46 the explicitly set string for the index mark. 47 48 @see setMarkEntry 49 */ 50 string getMarkEntry(); 51 52 //------------------------------------------------------------------------- 53 54 // DocMerge from xml: method com::sun::star::text::XDocumentIndexMark::setMarkEntry 55 /** sets an explicit string for this index mark to use 56 in the index. 57 58 59 60 <p>If empty, the string of the <type>TextRange</type> to which 61 the <type>TextContent</type> refers is used in the index.</p> 62 */ 63 void setMarkEntry( [in] string aIndexEntry ); 64 65}; 66 67//============================================================================= 68 69}; }; }; }; 70 71 72#endif 73