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