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
28#ifndef __com_sun_star_text_NumberingLevel_idl__
29#define __com_sun_star_text_NumberingLevel_idl__
30
31#ifndef __com_sun_star_util_Color_idl__
32#include <com/sun/star/util/Color.idl>
33#endif
34
35#ifndef __com_sun_star_awt_Size_idl__
36#include <com/sun/star/awt/Size.idl>
37#endif
38
39#ifndef __com_sun_star_awt_FontDescriptor_idl__
40#include <com/sun/star/awt/FontDescriptor.idl>
41#endif
42
43#ifndef __com_sun_star_awt_XBitmap_idl__
44#include <com/sun/star/awt/XBitmap.idl>
45#endif
46
47//=============================================================================
48
49 module com {  module sun {  module star {  module text {
50
51//=============================================================================
52
53/** provides access to a numbering level as part of the Numbering Rules.
54 */
55published service NumberingLevel
56{
57	//-------------------------------------------------------------------------
58
59	/** adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)
60
61		<p>
62		</p>
63	 */
64	[property] short Adjust;
65
66	//-------------------------------------------------------------------------
67
68	/** number of upper levels that are included in the current numbering symbol.
69	 */
70	[optional, property] short ParentNumbering;
71
72	//-------------------------------------------------------------------------
73
74	/** the prefix of the numbering symbol.
75	 */
76	[property] string Prefix;
77
78	//-------------------------------------------------------------------------
79
80	/** the suffix of the numbering symbol.
81	 */
82	[property] string Suffix;
83
84	//-------------------------------------------------------------------------
85
86	/** Name of the character style that is used for the numbering symbol.
87	 */
88	[optional, property] string CharStyleName;
89
90	//-------------------------------------------------------------------------
91
92	/** the ID of the symbol in the given font. This is only valid if the
93		numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
94	  	@deprecated
95	 */
96	[optional, property] short BulletId;
97	//-------------------------------------------------------------------------
98
99    /** contains the symbol in the given font. This is only valid if the
100		numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
101	 */
102	[property] string BulletChar;
103	//-------------------------------------------------------------------------
104
105	/** the name of the font for the symbol. This is only valid if the
106		numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
107	 */
108	[property] string BulletFontName;
109
110	//-------------------------------------------------------------------------
111
112    /** the font used to paint the bullet.
113     */
114    [optional, property] com::sun::star::awt::FontDescriptor BulletFont;
115
116    //-------------------------------------------------------------------------
117
118	/** the URL of the graphic file that is used as the numbering symbol.
119
120		<p> This is only valid if the numbering type is
121		<const scope="com::sun::star::style">NumberingType::BITMAP</const>.</p>
122	 */
123	[property] string GraphicURL;
124
125	//-------------------------------------------------------------------------
126
127    /** the bitmap containing the bullet.
128     */
129    [optional, property] com::sun::star::awt::XBitmap GraphicBitmap;
130
131    //-------------------------------------------------------------------------
132
133    /** size of the graphic that is used as bullet.
134     */
135    [optional, property] com::sun::star::awt::Size    GraphicSize;
136    //-------------------------------------------------------------------------
137
138    //-------------------------------------------------------------------------
139
140	/** contains the vertical orientation of a graphic.
141
142		<p> It is set using com::sun::star::text::VertOrientation.</p>
143	 */
144	[optional, property] short VertOrient;
145	//-------------------------------------------------------------------------
146
147	/** specifies the start value for the numbering.
148
149		<p>This property is only valid if the numbering type is not
150		<const scope="com::sun::star::style">NumberingType::BITMAP</const> or
151		<const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.</p>
152	 */
153	[optional, property] short StartWith;
154
155	//-------------------------------------------------------------------------
156
157	/** specifies the left margin of the numbering
158	 */
159	[property] long LeftMargin;
160
161	//-------------------------------------------------------------------------
162
163	/** specifies the distance between the numbering symbol and the text of
164		the paragraph.
165	 */
166	[optional, property] long SymbolTextDistance;
167
168	//-------------------------------------------------------------------------
169
170	/** specifies the offset between the beginning of the first line and
171		the beginning of the following lines of the paragraph.
172	 */
173	[property] long FirstLineOffset;
174
175	//-------------------------------------------------------------------------
176
177	/** specifies the type of numbering.
178	 */
179	[property] short NumberingType;
180
181	//-------------------------------------------------------------------------
182
183	/** contains the name of the paragraph style that is interpreted as the
184		header of this level. It is only contained in the levels of
185		chapter numbering rules.
186	 */
187	[property] string HeadingStyleName;
188
189	/** contains the color for the symbol. This is only valid if the
190		numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
191	*/
192	[optional, property] com::sun::star::util::Color BulletColor;
193
194	/** contains the size of the symbol relative to the high of the paragraph. This is only valid if the
195		numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
196	*/
197	[optional, property] short BulletRelSize;
198
199        /** position and space mode
200
201                <p>
202                Specifies the position and space mode of the numbering level.
203                For valid values see com::sun::star::text::PositionAndSpaceMode.
204                If it equals LABEL_WIDTH_AND_POSITION, properties Adjust,
205                LeftMargin, SymbolTextDistance and FirstLineOffset are used.
206                If it equals LABEL_ALIGNMENT, properties Adjust, LabelFollowedBy,
207                ListtabStopPosition, FirstLineIndent, IndentAt are used.
208                </p>
209
210                @since OOo 3.0
211        */
212        [optional, property] short PositionAndSpaceMode;
213
214        /** character following the list label
215
216                <p>
217                Specifies the character following the list label.
218                For valid values see com::sun::star::text::LabelFollow.
219                Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
220                </p>
221
222                @since OOo 3.0
223        */
224        [optional, property] short LabelFollowedBy;
225
226        /** list tab position
227
228                <p>
229                Specifies the position of the list tab stop - only non-negative
230                values are allowed.
231                Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT
232                and LabelFollowedBy equal LABELFOLLOW_LISTTAB
233                </p>
234
235                @since OOo 3.0
236        */
237        [optional, property] long ListtabStopPosition;
238
239        /** additional line indent for the first text line
240
241                <p>
242                Specifies the first line indent.
243                Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
244                </p>
245
246                @since OOo 3.0
247        */
248        [optional, property] long FirstLineIndent;
249
250        /** indentation of the text lines
251
252                <p>
253                Specifies the indent of the text lines
254                Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
255                </p>
256
257                @since OOo 3.0
258        */
259        [optional, property] long IndentAt;
260};
261
262//=============================================================================
263
264}; }; }; };
265
266#endif
267
268