/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DocumentIndexLevelFormat.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 06:10:09 $
 *
 *  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_DocumentIndex_idl__
#define __com_sun_star_text_DocumentIndex_idl__

#ifndef _com_sun_star_container_XIndexReplace_idl__
#include <com/sun/star/container/XIndexReplace.idl>
#endif


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

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

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

// DocMerge from xml: service com::sun::star::text::DocumentIndexLevelFormat
/** This service provides access to the structure of the levels of document indexes.


    <p>
    The element type is Sequence&amp;lt;PropertyValues &amp;gt;. Each element in this sequence represents
    a member of an index line. The following properties are part of such an element.
    </p>
    <ul>
    <li>
    <p>TokenType</p>
    <p>Values:</p>
    <ul>
    <li>
    <p>TokenEntryNumber - chapter number, used in content indexes
    only</p>
    </li>
    <li>
    <p>TokenEntryText  - text of the entry
    </p>
    </li>
    <li>
    <p>TokenTabStop - tab stop
    </p>
    </li>
    <li>
    <p>TokenText - user defined text
    </p>
    </li>
    <li>
    <p>TokenPageNumber - page number
    </p>
    </li>
    <li>
    <p>TokenChapterInfo - chapter info, in alphabetical indexes
    only</p>
    </li>
    <li>
    <p>TokenHyperlinkStart - start of a hyperlink</p>
    </li>
    <li>
    <p>TokenHyperlinkEnd - end of a hyperlink</p>
    </li>
    <li>
    <p>TokenBibliographyDataField - bibliographic data field
    </p>
    </li>
    </ul>
    </li>
    <li>
    <p>CharacterStyleName</p>
    <p>Name of the character style applied to the element. Invalid in tab stops.</p>
    </li>
    <li>
    <p>TabStopRightAligned</p>
    <p>Tab stop is right aligned. Only valid for tab stops.</p>
    </li>
    <li>
    <p>TabStopPosition</p>
    <p>Position of the tab stop. Only valid for tab stops.</p>
    </li>
    <li>
    <p>TabStopFillCharacter</p>
    <p>Fill character in tab stops.</p>
    </li>
    <li>
    <p>WithTab</p>
    <p>If true insert tab character.</p>
    </li>
    <li>
    <p>Text</p>
    <p>Text. Only valid in user defined text.</p>
    </li>
    <li>
    <p>ChapterFormat</p>
    <p>Valid in chapter info only. see <type>ChapterFormat</type>
    </p>
    </li>
    </ul>
 */
published service DocumentIndexLevelFormat
{
    // DocMerge: empty anyway
    interface com::sun::star::container::XIndexReplace;

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

};

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

}; }; }; };

#endif







