1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_DocumentIndex_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_text_DocumentIndex_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef _com_sun_star_container_XIndexReplace_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XIndexReplace.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski//============================================================================= 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski module com { module sun { module star { module text { 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski// DocMerge from xml: service com::sun::star::text::DocumentIndexLevelFormat 38*b1cdbd2cSJim Jagielski/** This service provides access to the structure of the levels of document indexes. 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski <p> 42*b1cdbd2cSJim Jagielski The element type is Sequence< PropertyValues >. Each element in this sequence represents 43*b1cdbd2cSJim Jagielski a member of an index line. The following properties are part of such an element. 44*b1cdbd2cSJim Jagielski </p> 45*b1cdbd2cSJim Jagielski <ul> 46*b1cdbd2cSJim Jagielski <li> 47*b1cdbd2cSJim Jagielski <p>TokenType</p> 48*b1cdbd2cSJim Jagielski <p>Values:</p> 49*b1cdbd2cSJim Jagielski <ul> 50*b1cdbd2cSJim Jagielski <li> 51*b1cdbd2cSJim Jagielski <p>TokenEntryNumber - chapter number, used in content indexes 52*b1cdbd2cSJim Jagielski only</p> 53*b1cdbd2cSJim Jagielski </li> 54*b1cdbd2cSJim Jagielski <li> 55*b1cdbd2cSJim Jagielski <p>TokenEntryText - text of the entry 56*b1cdbd2cSJim Jagielski </p> 57*b1cdbd2cSJim Jagielski </li> 58*b1cdbd2cSJim Jagielski <li> 59*b1cdbd2cSJim Jagielski <p>TokenTabStop - tab stop 60*b1cdbd2cSJim Jagielski </p> 61*b1cdbd2cSJim Jagielski </li> 62*b1cdbd2cSJim Jagielski <li> 63*b1cdbd2cSJim Jagielski <p>TokenText - user defined text 64*b1cdbd2cSJim Jagielski </p> 65*b1cdbd2cSJim Jagielski </li> 66*b1cdbd2cSJim Jagielski <li> 67*b1cdbd2cSJim Jagielski <p>TokenPageNumber - page number 68*b1cdbd2cSJim Jagielski </p> 69*b1cdbd2cSJim Jagielski </li> 70*b1cdbd2cSJim Jagielski <li> 71*b1cdbd2cSJim Jagielski <p>TokenChapterInfo - chapter info, in illustration indexes, 72*b1cdbd2cSJim Jagielski table indexes, user indexes, table of objects and alphabetical indexes 73*b1cdbd2cSJim Jagielski only</p> 74*b1cdbd2cSJim Jagielski </li> 75*b1cdbd2cSJim Jagielski <li> 76*b1cdbd2cSJim Jagielski <p>TokenHyperlinkStart - start of a hyperlink</p> 77*b1cdbd2cSJim Jagielski </li> 78*b1cdbd2cSJim Jagielski <li> 79*b1cdbd2cSJim Jagielski <p>TokenHyperlinkEnd - end of a hyperlink</p> 80*b1cdbd2cSJim Jagielski </li> 81*b1cdbd2cSJim Jagielski <li> 82*b1cdbd2cSJim Jagielski <p>TokenBibliographyDataField - bibliographic data field 83*b1cdbd2cSJim Jagielski </p> 84*b1cdbd2cSJim Jagielski </li> 85*b1cdbd2cSJim Jagielski </ul> 86*b1cdbd2cSJim Jagielski </li> 87*b1cdbd2cSJim Jagielski <li> 88*b1cdbd2cSJim Jagielski <p>CharacterStyleName</p> 89*b1cdbd2cSJim Jagielski <p>Name of the character style applied to the element. Invalid in tab stops.</p> 90*b1cdbd2cSJim Jagielski </li> 91*b1cdbd2cSJim Jagielski <li> 92*b1cdbd2cSJim Jagielski <p>TabStopRightAligned</p> 93*b1cdbd2cSJim Jagielski <p>Tab stop is right aligned. Only valid for tab stops.</p> 94*b1cdbd2cSJim Jagielski </li> 95*b1cdbd2cSJim Jagielski <li> 96*b1cdbd2cSJim Jagielski <p>TabStopPosition</p> 97*b1cdbd2cSJim Jagielski <p>Position of the tab stop. Only valid for tab stops.</p> 98*b1cdbd2cSJim Jagielski </li> 99*b1cdbd2cSJim Jagielski <li> 100*b1cdbd2cSJim Jagielski <p>TabStopFillCharacter</p> 101*b1cdbd2cSJim Jagielski <p>Fill character in tab stops. Only valid for tab stops.</p> 102*b1cdbd2cSJim Jagielski </li> 103*b1cdbd2cSJim Jagielski <li> 104*b1cdbd2cSJim Jagielski <p>WithTab</p> 105*b1cdbd2cSJim Jagielski <p>If true insert tab character.</p> 106*b1cdbd2cSJim Jagielski </li> 107*b1cdbd2cSJim Jagielski <li> 108*b1cdbd2cSJim Jagielski <p>Text</p> 109*b1cdbd2cSJim Jagielski <p>Text. Only valid in user defined text.</p> 110*b1cdbd2cSJim Jagielski </li> 111*b1cdbd2cSJim Jagielski <li> 112*b1cdbd2cSJim Jagielski <p>ChapterFormat</p> 113*b1cdbd2cSJim Jagielski <p>Valid in chapter info and entry number only. See <type>ChapterFormat</type>.</p> 114*b1cdbd2cSJim Jagielski <p>Other information.</p> 115*b1cdbd2cSJim Jagielski <ul> 116*b1cdbd2cSJim Jagielski <li> 117*b1cdbd2cSJim Jagielski <p>In chapter info only com.sun.star.text.ChapterFormat.NUMBER, com.sun.star.text.ChapterFormat.NAME, and 118*b1cdbd2cSJim Jagielski com.sun.star.text.ChapterFormat.NAME_NUMBER constants are allowed.</p> 119*b1cdbd2cSJim Jagielski </li> 120*b1cdbd2cSJim Jagielski <li> 121*b1cdbd2cSJim Jagielski <p>In entry number only com.sun.star.text.ChapterFormat.NUMBER and com.sun.star.text.ChapterFormat.DIGIT constants are allowed.</p> 122*b1cdbd2cSJim Jagielski </li> 123*b1cdbd2cSJim Jagielski </ul> 124*b1cdbd2cSJim Jagielski </li> 125*b1cdbd2cSJim Jagielski <li> 126*b1cdbd2cSJim Jagielski <p>ChapterLevel</p> 127*b1cdbd2cSJim Jagielski <p>Valid in chapter info and entry number only. Denotes the level up to which 128*b1cdbd2cSJim Jagielski the chapter information is given. Values permitted 1 to 10 inclusive.</p> 129*b1cdbd2cSJim Jagielski </li> 130*b1cdbd2cSJim Jagielski </ul> 131*b1cdbd2cSJim Jagielski */ 132*b1cdbd2cSJim Jagielskipublished service DocumentIndexLevelFormat 133*b1cdbd2cSJim Jagielski{ 134*b1cdbd2cSJim Jagielski // DocMerge: empty anyway 135*b1cdbd2cSJim Jagielski interface com::sun::star::container::XIndexReplace; 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski}; 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski//============================================================================= 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski}; }; }; }; 144*b1cdbd2cSJim Jagielski 145*b1cdbd2cSJim Jagielski#endif 146*b1cdbd2cSJim Jagielski 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski 151*b1cdbd2cSJim Jagielski 152*b1cdbd2cSJim Jagielski 153