xref: /AOO41X/main/offapi/com/sun/star/text/ChapterNumberingRule.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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#ifndef __com_sun_star_text_ChapterNumberingRule_idl__
24#define __com_sun_star_text_ChapterNumberingRule_idl__
25
26#ifndef __com_sun_star_style_NumberingRule_idl__
27#include <com/sun/star/style/NumberingRule.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module text {
34
35//=============================================================================
36
37// DocMerge from xml: service com::sun::star::text::ChapterNumberingRule
38/** describes the rules for chapter numbering in a text document.
39
40
41
42    <p>Some of the properties that are available in the interface are
43    ignored here.
44
45    </p>
46    <p>The type of numbering can only be:
47    NUM_CHARS_UPPER_LETTER, NUM_CHARS_LOWER_LETTER, NUM_ROMAN_UPPER,
48    NUM_ROMAN_LOWER, NUM_ARABIC, or NUM_NUMBER_NONE
49
50    </p>
51    <p>In the <type scope="com::sun::star::style">NumberingAlignment</type> only the field
52    <member scope="com::sun::star::style">NumberingAlignment::Alignment</member> is applied.
53
54    </p>
55    <p>Depending on the numbering types, the parameters for bullets or bit maps
56    may be ignored.  The character style name for the numbering symbol is
57    also ignored.</p>
58 */
59published service ChapterNumberingRule
60{
61    // DocMerge: empty anyway
62    service com::sun::star::style::NumberingRule;
63
64    //-------------------------------------------------------------------------
65
66    // DocMerge from xml: property com::sun::star::text::ChapterNumberingRule::HeadingStyleName
67    /** contains the name of the paragraph style that marks this heading
68        level.
69
70
71
72        <p>It is necessary that each style name appears only
73        once in the sequence of numbering rules.</p>
74     */
75    [property] string HeadingStyleName;
76
77};
78
79//=============================================================================
80
81}; }; }; };
82
83#endif
84