/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XDocumentIndexMark.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 06:39:44 $
 *
 *  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_XDocumentIndexMark_idl__
#define __com_sun_star_text_XDocumentIndexMark_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::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
