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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_DocumentIndexLevelFormat_idl__
  20 #define __com_sun_star_text_DocumentIndexLevelFormat_idl__
  21
  22 #include <com/sun/star/container/XIndexReplace.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module text {
  27
  28 /** This service provides access to the structure of the levels of document indexes.
  29
  30
  31     <p>
  32     The element type is Sequence&lt; PropertyValues &gt;. Each element in this sequence represents
  33     a member of an index line. The following properties are part of such an element.
  34     </p>
  35     <ul>
  36     <li>
  37     <p>TokenType</p>
  38     <p>Values:</p>
  39     <ul>
  40     <li>
  41     <p>TokenEntryNumber - chapter number, used in content indexes
  42     only</p>
  43     </li>
  44     <li>
  45     <p>TokenEntryText  - text of the entry
  46     </p>
  47     </li>
  48     <li>
  49     <p>TokenTabStop - tab stop
  50     </p>
  51     </li>
  52     <li>
  53     <p>TokenText - user defined text
  54     </p>
  55     </li>
  56     <li>
  57     <p>TokenPageNumber - page number
  58     </p>
  59     </li>
  60     <li>
  61     <p>TokenChapterInfo - chapter info, in illustration indexes,
  62     table indexes, user indexes, table of objects and alphabetical indexes
  63     only</p>
  64     </li>
  65     <li>
  66     <p>TokenHyperlinkStart - start of a hyperlink</p>
  67     </li>
  68     <li>
  69     <p>TokenHyperlinkEnd - end of a hyperlink</p>
  70     </li>
  71     <li>
  72     <p>TokenBibliographyDataField - bibliographic data field
  73     </p>
  74     </li>
  75     </ul>
  76     </li>
  77     <li>
  78     <p>CharacterStyleName</p>
  79     <p>Name of the character style applied to the element. Invalid in tab stops.</p>
  80     </li>
  81     <li>
  82     <p>TabStopRightAligned</p>
  83     <p>Tab stop is right aligned. Only valid for tab stops.</p>
  84     </li>
  85     <li>
  86     <p>TabStopPosition</p>
  87     <p>Position of the tab stop. Only valid for tab stops.</p>
  88     </li>
  89     <li>
  90     <p>TabStopFillCharacter</p>
  91     <p>Fill character in tab stops. Only valid for tab stops.</p>
  92     </li>
  93     <li>
  94     <p>WithTab</p>
  95     <p>If true insert tab character.</p>
  96     </li>
  97     <li>
  98     <p>Text</p>
  99     <p>Text. Only valid in user defined text.</p>
 100     </li>
 101     <li>
 102     <p>ChapterFormat</p>
 103     <p>Valid in chapter info and entry number only. See ChapterFormat.</p>
 104     <p>Other information.</p>
 105     <ul>
 106     <li>
 107     <p>In chapter info only com.sun.star.text.ChapterFormat.NUMBER, com.sun.star.text.ChapterFormat.NAME, and
 108     com.sun.star.text.ChapterFormat.NAME_NUMBER constants are allowed.</p>
 109     </li>
 110     <li>
 111     <p>In entry number only com.sun.star.text.ChapterFormat.NUMBER and com.sun.star.text.ChapterFormat.DIGIT constants are allowed.</p>
 112     </li>
 113     </ul>
 114     </li>
 115     <li>
 116     <p>ChapterLevel</p>
 117     <p>Valid in chapter info and entry number only.  Denotes the level up to which
 118     the chapter information is given. Values permitted 1 to 10 inclusive.</p>
 119     </li>
 120     </ul>
 121  */
 122 published service DocumentIndexLevelFormat
 123 {
 124     interface com::sun::star::container::XIndexReplace;
 125
 126
 127 };
 128
 129
 130 }; }; }; };
 131
 132 #endif
 133
 134
 135
 136
 137
 138
 139
 140 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */