offapi/com/sun/star/text/XDocumentIndex.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XDocumentIndex_idl__
  28 #define __com_sun_star_text_XDocumentIndex_idl__
  29
  30 #ifndef __com_sun_star_text_XTextContent_idl__
  31 #include <com/sun/star/text/XTextContent.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module text {
  38
  39 //=============================================================================
  40
  41 // DocMerge from xml: interface com::sun::star::text::XDocumentIndex
  42 /** This is the main interface for a document index.
  43
  44
  45
  46     <p>Use <type scope="com::sun::star::util">XRefreshable</type> and
  47     <type scope="com::sun::star::lang">XServiceInfo</type> instead, if available.
  48
  49     </p>
  50
  51
  52
  53
  54
  55
  56     @deprecated
  57     @see com::sun::star::util::XRefreshable
  58     @see com::sun::star::lang::XServiceInfo
  59  */
  60 published interface XDocumentIndex: com::sun::star::text::XTextContent
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     // DocMerge from xml: method com::sun::star::text::XDocumentIndex::getServiceName
  65     /** returns the service name that was used to create this document index type.
  66      */
  67     string getServiceName();
  68
  69     //-------------------------------------------------------------------------
  70
  71     // DocMerge from xml: method com::sun::star::text::XDocumentIndex::update
  72     /** initiates an upate to the document index.
  73      */
  74     void update();
  75
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 #endif