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