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