/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XDocumentIndex.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 06:39:30 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XDocumentIndex_idl__
#define __com_sun_star_text_XDocumentIndex_idl__

#ifndef __com_sun_star_text_XTextContent_idl__
#include <com/sun/star/text/XTextContent.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

// DocMerge from xml: interface com::sun::star::text::XDocumentIndex
/** This is the main interface for a document index.



    <p>Use <type scope="com::sun::star::util">XRefreshable</type> and
    <type scope="com::sun::star::lang">XServiceInfo</type> instead, if available.

    </p>






    @deprecated
    @see com::sun::star::util::XRefreshable
    @see com::sun::star::lang::XServiceInfo
 */
published interface XDocumentIndex: com::sun::star::text::XTextContent
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XDocumentIndex::getServiceName
    /** returns the service name that was used to create this document index type.
     */
    string getServiceName();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XDocumentIndex::update
    /** initiates an upate to the document index.
     */
    void update();

};

//=============================================================================

}; }; }; };

#endif
