xref: /trunk/main/offapi/com/sun/star/text/NumberingRules.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_text_NumberingRules_idl__
24cdf0e10cSrcweir#define __com_sun_star_text_NumberingRules_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexReplace_idl__
27cdf0e10cSrcweir#include <com/sun/star/container/XIndexReplace.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__
30cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl>
31cdf0e10cSrcweir#endif
32cdf0e10cSrcweir
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir
36cdf0e10cSrcweir module com {  module sun {  module star {  module text {
37cdf0e10cSrcweir
38cdf0e10cSrcweir//=============================================================================
39cdf0e10cSrcweir
40cdf0e10cSrcweir/** provides access to the numbering rules.
41cdf0e10cSrcweir    <p> Numbering rules may be set at a <type>Paragraph</type> object.  The numbering rules are
42cdf0e10cSrcweir    levels of property values. Each level contains equal properties.
43cdf0e10cSrcweir
44cdf0e10cSrcweir    </p>
45cdf0e10cSrcweir */
46cdf0e10cSrcweirpublished service NumberingRules
47cdf0e10cSrcweir{
48cdf0e10cSrcweir    /** provides access to the levels of the numbering rule.
49cdf0e10cSrcweir
50cdf0e10cSrcweir                <p>The numbering rules are levels of property values. Each
51cdf0e10cSrcweir                level contains equal properties.</p>
52cdf0e10cSrcweir                @see NumberingLevel;@see NumberingLevel;
53cdf0e10cSrcweir     */
54cdf0e10cSrcweir        interface com::sun::star::container::XIndexReplace;
55cdf0e10cSrcweir
56cdf0e10cSrcweir    [optional] interface com::sun::star::beans::XPropertySet;
57cdf0e10cSrcweir    //-------------------------------------------------------------------------
58cdf0e10cSrcweir
59*d8faddccSMatthias Seidel    /** determines if the margins are absolute or relative
60a893be29SPedro Giffuni        to the preceding numbering level.
61cdf0e10cSrcweir     */
62cdf0e10cSrcweir    [optional, property] boolean  IsAbsoluteMargins;
63cdf0e10cSrcweir    //-------------------------------------------------------------------------
64cdf0e10cSrcweir
65*d8faddccSMatthias Seidel    /** determines if the numbering rules are automatically created
66cdf0e10cSrcweir        as opposed to numbering rules that are part of a numbering style.
67cdf0e10cSrcweir     */
68cdf0e10cSrcweir    [optional, property] boolean IsAutomatic;
69cdf0e10cSrcweir    //-------------------------------------------------------------------------
70cdf0e10cSrcweir
71*d8faddccSMatthias Seidel    /** determines if the numbering levels are counted coninuously  or if
72cdf0e10cSrcweir        each numbering level is counted separately.
73cdf0e10cSrcweir     */
74cdf0e10cSrcweir    [optional, property] boolean IsContinuousNumbering;
75cdf0e10cSrcweir    //-------------------------------------------------------------------------
76cdf0e10cSrcweir
77cdf0e10cSrcweir    /** contains the name of the numbering rules. It is used to identify a certain
78cdf0e10cSrcweir        numbering rules property
79cdf0e10cSrcweir     */
80cdf0e10cSrcweir    [optional, readonly, property] string Name;
81cdf0e10cSrcweir        //-------------------------------------------------------------------------
82cdf0e10cSrcweir
83cdf0e10cSrcweir        /** This numbering is used in the outline of the document (e.g. headings).
84cdf0e10cSrcweir         */
85cdf0e10cSrcweir        [optional, property] boolean    NumberingIsOutline;
86cdf0e10cSrcweir        //-------------------------------------------------------------------------
87cdf0e10cSrcweir
88cdf0e10cSrcweir        /** the type of numbering (arabic, characters, roman numbers, etc.).
89cdf0e10cSrcweir         */
90cdf0e10cSrcweir        [optional, property] short    NumberingType;
91cdf0e10cSrcweir        //-------------------------------------------------------------------------
92cdf0e10cSrcweir
93cdf0e10cSrcweir        /** id of default list for the numbering rules instance
94cdf0e10cSrcweir         */
95cdf0e10cSrcweir        [optional, readonly, property] string DefaultListId;
96cdf0e10cSrcweir        //-------------------------------------------------------------------------
97cdf0e10cSrcweir};
98cdf0e10cSrcweir
99cdf0e10cSrcweir//=============================================================================
100cdf0e10cSrcweir
101cdf0e10cSrcweir}; }; }; };
102cdf0e10cSrcweir
103cdf0e10cSrcweir#endif
104