summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/NumberingRules.idl
blob: c92fe8a7740ce6a1fea20b0eb90cb5c2d6afa6a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_text_NumberingRules_idl__
#define __com_sun_star_text_NumberingRules_idl__

#include <com/sun/star/container/XIndexReplace.idl>
#include <com/sun/star/beans/XPropertySet.idl>

module com {  module sun {  module star {  module text {

/** provides access to the numbering rules.
    <p> Numbering rules may be set at a Paragraph object.  The numbering rules are
    levels of property values. Each level contains equal properties.

    </p>
 */
published service NumberingRules
{
    /** provides access to the levels of the numbering rule.

                <p>The numbering rules are levels of property values. Each
                level contains equal properties.</p>
                @see NumberingLevel;@see NumberingLevel;
     */
        interface com::sun::star::container::XIndexReplace;

    [optional] interface com::sun::star::beans::XPropertySet;

    /** determines if the margins are absolute or relative
        to the preceding numbering level.
     */
    [optional, property] boolean  IsAbsoluteMargins;

    /** determines if the numbering rules are automatically created
        as opposed to numbering rules that are part of a numbering style.
     */
    [optional, property] boolean IsAutomatic;

    /** determines if the numbering levels are counted continuously  or if
        each numbering level is counted separately.
     */
    [optional, property] boolean IsContinuousNumbering;

    /** contains the name of the numbering rules. It is used to identify a certain
        numbering rules property
     */
    [optional, readonly, property] string Name;

    /** This numbering is used in the outline of the document (e.g. headings).
     */
    [optional, property] boolean    NumberingIsOutline;

    /** the type of numbering (Arabic, characters, roman numbers, etc.).
     */
    [optional, property] short    NumberingType;

    /** id of default list for the numbering rules instance
     */
    [optional, readonly, property] string DefaultListId;
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */