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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_text_NumberingLevel_idl__
#define __com_sun_star_text_NumberingLevel_idl__
#include <com/sun/star/util/Color.idl>
#include <com/sun/star/awt/Size.idl>
#include <com/sun/star/awt/FontDescriptor.idl>
#include <com/sun/star/awt/XBitmap.idl>
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
/** provides access to a numbering level as part of the Numbering Rules.
*/
published service NumberingLevel
{
//-------------------------------------------------------------------------
/** adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)
<p>
</p>
*/
[property] short Adjust;
//-------------------------------------------------------------------------
/** number of upper levels that are included in the current numbering symbol.
*/
[optional, property] short ParentNumbering;
//-------------------------------------------------------------------------
/** the prefix of the numbering symbol.
*/
[property] string Prefix;
//-------------------------------------------------------------------------
/** the suffix of the numbering symbol.
*/
[property] string Suffix;
//-------------------------------------------------------------------------
/** Name of the character style that is used for the numbering symbol.
*/
[optional, property] string CharStyleName;
//-------------------------------------------------------------------------
/** the ID of the symbol in the given font. This is only valid if the
numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
@deprecated
*/
[optional, property] short BulletId;
//-------------------------------------------------------------------------
/** contains the symbol in the given font. This is only valid if the
numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
*/
[property] string BulletChar;
//-------------------------------------------------------------------------
/** the name of the font for the symbol. This is only valid if the
numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
*/
[property] string BulletFontName;
//-------------------------------------------------------------------------
/** the font used to paint the bullet.
*/
[optional, property] com::sun::star::awt::FontDescriptor BulletFont;
//-------------------------------------------------------------------------
/** the URL of the graphic file that is used as the numbering symbol.
<p> This is only valid if the numbering type is
<const scope="com::sun::star::style">NumberingType::BITMAP</const>.</p>
*/
[property] string GraphicURL;
//-------------------------------------------------------------------------
/** the bitmap containing the bullet.
*/
[optional, property] com::sun::star::awt::XBitmap GraphicBitmap;
//-------------------------------------------------------------------------
/** size of the graphic that is used as bullet.
*/
[optional, property] com::sun::star::awt::Size GraphicSize;
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
/** contains the vertical orientation of a graphic.
<p> It is set using com::sun::star::text::VertOrientation.</p>
*/
[optional, property] short VertOrient;
//-------------------------------------------------------------------------
/** specifies the start value for the numbering.
<p>This property is only valid if the numbering type is not
<const scope="com::sun::star::style">NumberingType::BITMAP</const> or
<const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.</p>
*/
[optional, property] short StartWith;
//-------------------------------------------------------------------------
/** specifies the left margin of the numbering
*/
[property] long LeftMargin;
//-------------------------------------------------------------------------
/** specifies the distance between the numbering symbol and the text of
the paragraph.
*/
[optional, property] long SymbolTextDistance;
//-------------------------------------------------------------------------
/** specifies the offset between the beginning of the first line and
the beginning of the following lines of the paragraph.
*/
[property] long FirstLineOffset;
//-------------------------------------------------------------------------
/** specifies the type of numbering.
*/
[property] short NumberingType;
//-------------------------------------------------------------------------
/** contains the name of the paragraph style that is interpreted as the
header of this level. It is only contained in the levels of
chapter numbering rules.
*/
[property] string HeadingStyleName;
/** contains the color for the symbol. This is only valid if the
numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
*/
[optional, property] com::sun::star::util::Color BulletColor;
/** contains the size of the symbol relative to the high of the paragraph. This is only valid if the
numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
*/
[optional, property] short BulletRelSize;
/** position and space mode
<p>
Specifies the position and space mode of the numbering level.
For valid values see com::sun::star::text::PositionAndSpaceMode.
If it equals LABEL_WIDTH_AND_POSITION, properties Adjust,
LeftMargin, SymbolTextDistance and FirstLineOffset are used.
If it equals LABEL_ALIGNMENT, properties Adjust, LabelFollowedBy,
ListtabStopPosition, FirstLineIndent, IndentAt are used.
</p>
@since OOo 3.0
*/
[optional, property] short PositionAndSpaceMode;
/** character following the list label
<p>
Specifies the character following the list label.
For valid values see com::sun::star::text::LabelFollow.
Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
</p>
@since OOo 3.0
*/
[optional, property] short LabelFollowedBy;
/** list tab position
<p>
Specifies the position of the list tab stop - only non-negative
values are allowed.
Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT
and LabelFollowedBy equal LABELFOLLOW_LISTTAB
</p>
@since OOo 3.0
*/
[optional, property] long ListtabStopPosition;
/** additional line indent for the first text line
<p>
Specifies the first line indent.
Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
</p>
@since OOo 3.0
*/
[optional, property] long FirstLineIndent;
/** indentation of the text lines
<p>
Specifies the indent of the text lines
Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
</p>
@since OOo 3.0
*/
[optional, property] long IndentAt;
};
//=============================================================================
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
