Update ooo320-m1
[ooovba.git] / offapi / com / sun / star / text / NumberingRules.idl
blob5edbe06e637fd9099841ec2995675bfbf0ade79b
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: NumberingRules.idl,v $
10 * $Revision: 1.12 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_text_NumberingRules_idl__
31 #define __com_sun_star_text_NumberingRules_idl__
33 #ifndef __com_sun_star_container_XIndexReplace_idl__
34 #include <com/sun/star/container/XIndexReplace.idl>
35 #endif
36 #ifndef __com_sun_star_beans_XPropertySet_idl__
37 #include <com/sun/star/beans/XPropertySet.idl>
38 #endif
41 //=============================================================================
43 module com { module sun { module star { module text {
45 //=============================================================================
47 /** provides access to the numbering rules.
48 <p> Numbering rules may be set at a <type>Paragraph</type> object. The numbering rules are
49 levels of property values. Each level contains equal properties.
51 </p>
53 published service NumberingRules
55 /** provides access to the levels of the numbering rule.
57 <p>The numbering rules are levels of property values. Each
58 level contains equal properties.</p>
59 @see NumberingLevel;@see NumberingLevel;
61 interface com::sun::star::container::XIndexReplace;
63 [optional] interface com::sun::star::beans::XPropertySet;
64 //-------------------------------------------------------------------------
66 /** determins if the margins are absolute or relative
67 to the preceeding numbering level.
69 [optional, property] boolean IsAbsoluteMargins;
70 //-------------------------------------------------------------------------
72 /** determins if the numbering rules are automatically created
73 as opposed to numbering rules that are part of a numbering style.
75 [optional, property] boolean IsAutomatic;
76 //-------------------------------------------------------------------------
78 /** determins if the numbering levels are counted coninuously or if
79 each numbering level is counted separately.
81 [optional, property] boolean IsContinuousNumbering;
82 //-------------------------------------------------------------------------
84 /** contains the name of the numbering rules. It is used to identify a certain
85 numbering rules property
87 [optional, readonly, property] string Name;
88 //-------------------------------------------------------------------------
90 /** This numbering is used in the outline of the document (e.g. headings).
92 [optional, property] boolean NumberingIsOutline;
93 //-------------------------------------------------------------------------
95 /** the type of numbering (arabic, characters, roman numbers, etc.).
97 [optional, property] short NumberingType;
98 //-------------------------------------------------------------------------
100 /** id of default list for the numbering rules instance
102 [optional, readonly, property] string DefaultListId;
103 //-------------------------------------------------------------------------
106 //=============================================================================
108 }; }; }; };
110 #endif