/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * 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_XDocumentIndexMark_idl__
#define __com_sun_star_text_XDocumentIndexMark_idl__

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


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

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

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

// DocMerge from xml: interface com::sun::star::text::XDocumentIndexMark
/** gives access to the mark of a document index entry.@see DocumentIndexMark
 */
published interface XDocumentIndexMark: com::sun::star::text::XTextContent
{
    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::text::XDocumentIndexMark::getMarkEntry
    /** @returns
                the explicitly set string for the index mark.

         @see setMarkEntry
     */
    string getMarkEntry();

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

    // DocMerge from xml: method com::sun::star::text::XDocumentIndexMark::setMarkEntry
    /** sets an explicit string for this index mark to use
        in the index.



        <p>If empty, the string of the <type>TextRange</type> to which
        the <type>TextContent</type> refers is used in the index.</p>
     */
    void setMarkEntry( [in] string aIndexEntry );

};

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

}; }; }; };


#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
