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_XDocumentIndex_idl__ 24#define __com_sun_star_text_XDocumentIndex_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::XDocumentIndex 38/** This is the main interface for a document index. 39 40 41 42 <p>Use <type scope="com::sun::star::util">XRefreshable</type> and 43 <type scope="com::sun::star::lang">XServiceInfo</type> instead, if available. 44 45 </p> 46 47 48 49 50 51 52 @deprecated 53 @see com::sun::star::util::XRefreshable 54 @see com::sun::star::lang::XServiceInfo 55 */ 56published interface XDocumentIndex: com::sun::star::text::XTextContent 57{ 58 //------------------------------------------------------------------------- 59 60 // DocMerge from xml: method com::sun::star::text::XDocumentIndex::getServiceName 61 /** returns the service name that was used to create this document index type. 62 */ 63 string getServiceName(); 64 65 //------------------------------------------------------------------------- 66 67 // DocMerge from xml: method com::sun::star::text::XDocumentIndex::update 68 /** initiates an upate to the document index. 69 */ 70 void update(); 71 72}; 73 74//============================================================================= 75 76}; }; }; }; 77 78#endif 79