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

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