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