xref: /AOO41X/main/offapi/com/sun/star/text/NumberingRules.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_NumberingRules_idl__
24#define __com_sun_star_text_NumberingRules_idl__
25
26#ifndef __com_sun_star_container_XIndexReplace_idl__
27#include <com/sun/star/container/XIndexReplace.idl>
28#endif
29#ifndef __com_sun_star_beans_XPropertySet_idl__
30#include <com/sun/star/beans/XPropertySet.idl>
31#endif
32
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module text {
37
38//=============================================================================
39
40/** provides access to the numbering rules.
41    <p> Numbering rules may be set at a <type>Paragraph</type> object.  The numbering rules are
42    levels of property values. Each level contains equal properties.
43
44    </p>
45 */
46published service NumberingRules
47{
48    /** provides access to the levels of the numbering rule.
49
50                <p>The numbering rules are levels of property values. Each
51                level contains equal properties.</p>
52                @see NumberingLevel;@see NumberingLevel;
53     */
54        interface com::sun::star::container::XIndexReplace;
55
56    [optional] interface com::sun::star::beans::XPropertySet;
57    //-------------------------------------------------------------------------
58
59    /** determins if the margins are absolute or relative
60        to the preceeding numbering level.
61     */
62    [optional, property] boolean  IsAbsoluteMargins;
63    //-------------------------------------------------------------------------
64
65    /** determins if the numbering rules are automatically created
66        as opposed to numbering rules that are part of a numbering style.
67     */
68    [optional, property] boolean IsAutomatic;
69    //-------------------------------------------------------------------------
70
71    /** determins if the numbering levels are counted coninuously  or if
72        each numbering level is counted separately.
73     */
74    [optional, property] boolean IsContinuousNumbering;
75    //-------------------------------------------------------------------------
76
77    /** contains the name of the numbering rules. It is used to identify a certain
78        numbering rules property
79     */
80    [optional, readonly, property] string Name;
81        //-------------------------------------------------------------------------
82
83        /** This numbering is used in the outline of the document (e.g. headings).
84         */
85        [optional, property] boolean    NumberingIsOutline;
86        //-------------------------------------------------------------------------
87
88        /** the type of numbering (arabic, characters, roman numbers, etc.).
89         */
90        [optional, property] short    NumberingType;
91        //-------------------------------------------------------------------------
92
93        /** id of default list for the numbering rules instance
94         */
95        [optional, readonly, property] string DefaultListId;
96        //-------------------------------------------------------------------------
97};
98
99//=============================================================================
100
101}; }; }; };
102
103#endif
104