/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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
