offapi/com/sun/star/text/DocumentIndexLevelFormat.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DocumentIndexLevelFormat.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_DocumentIndex_idl__
  31 #define __com_sun_star_text_DocumentIndex_idl__
  32
  33 #ifndef _com_sun_star_container_XIndexReplace_idl__
  34 #include <com/sun/star/container/XIndexReplace.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module text {
  41
  42 //=============================================================================
  43
  44 // DocMerge from xml: service com::sun::star::text::DocumentIndexLevelFormat
  45 /** This service provides access to the structure of the levels of document indexes.
  46
  47
  48     <p>
  49     The element type is Sequence&lt; PropertyValues &gt;. Each element in this sequence represents
  50     a member of an index line. The following properties are part of such an element.
  51     </p>
  52     <ul>
  53     <li>
  54     <p>TokenType</p>
  55     <p>Values:</p>
  56     <ul>
  57     <li>
  58     <p>TokenEntryNumber - chapter number, used in content indexes
  59     only</p>
  60     </li>
  61     <li>
  62     <p>TokenEntryText  - text of the entry
  63     </p>
  64     </li>
  65     <li>
  66     <p>TokenTabStop - tab stop
  67     </p>
  68     </li>
  69     <li>
  70     <p>TokenText - user defined text
  71     </p>
  72     </li>
  73     <li>
  74     <p>TokenPageNumber - page number
  75     </p>
  76     </li>
  77     <li>
  78     <p>TokenChapterInfo - chapter info, in illustration indexes,
  79     table indexes, user indexes, table of objects and alphabetical indexes
  80     only</p>
  81     </li>
  82     <li>
  83     <p>TokenHyperlinkStart - start of a hyperlink</p>
  84     </li>
  85     <li>
  86     <p>TokenHyperlinkEnd - end of a hyperlink</p>
  87     </li>
  88     <li>
  89     <p>TokenBibliographyDataField - bibliographic data field
  90     </p>
  91     </li>
  92     </ul>
  93     </li>
  94     <li>
  95     <p>CharacterStyleName</p>
  96     <p>Name of the character style applied to the element. Invalid in tab stops.</p>
  97     </li>
  98     <li>
  99     <p>TabStopRightAligned</p>
 100     <p>Tab stop is right aligned. Only valid for tab stops.</p>
 101     </li>
 102     <li>
 103     <p>TabStopPosition</p>
 104     <p>Position of the tab stop. Only valid for tab stops.</p>
 105     </li>
 106     <li>
 107     <p>TabStopFillCharacter</p>
 108     <p>Fill character in tab stops. Only valid for tab stops.</p>
 109     </li>
 110     <li>
 111     <p>WithTab</p>
 112     <p>If true insert tab character.</p>
 113     </li>
 114     <li>
 115     <p>Text</p>
 116     <p>Text. Only valid in user defined text.</p>
 117     </li>
 118     <li>
 119     <p>ChapterFormat</p>
 120     <p>Valid in chapter info and entry number only. See <type>ChapterFormat</type>.</p>
 121     <p>Other information.</p>
 122     <ul>
 123     <li>
 124     <p>In chapter info only com.sun.star.text.ChapterFormat.NUMBER, com.sun.star.text.ChapterFormat.NAME, and
 125     com.sun.star.text.ChapterFormat.NAME_NUMBER constants are allowed.</p>
 126     </li>
 127     <li>
 128     <p>In entry number only com.sun.star.text.ChapterFormat.NUMBER and com.sun.star.text.ChapterFormat.DIGIT constants are allowed.</p>
 129     </li>
 130     </ul>
 131     </li>
 132     <li>
 133     <p>ChapterLevel</p>
 134     <p>Valid in chapter info and entry number only.  Denotes the level up to which
 135     the chapter information is given. Values permitted 1 to 10 inclusive.</p>
 136     </li>
 137     </ul>
 138  */
 139 published service DocumentIndexLevelFormat
 140 {
 141     // DocMerge: empty anyway
 142     interface com::sun::star::container::XIndexReplace;
 143
 144     //-------------------------------------------------------------------------
 145
 146 };
 147
 148 //=============================================================================
 149
 150 }; }; }; };
 151
 152 #endif
 153
 154
 155
 156
 157
 158
 159