summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/NumberingRules.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/NumberingRules.idl')
-rw-r--r--offapi/com/sun/star/text/NumberingRules.idl107
1 files changed, 107 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/NumberingRules.idl b/offapi/com/sun/star/text/NumberingRules.idl
new file mode 100644
index 000000000000..352c58d2cf40
--- /dev/null
+++ b/offapi/com/sun/star/text/NumberingRules.idl
@@ -0,0 +1,107 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_text_NumberingRules_idl__
+#define __com_sun_star_text_NumberingRules_idl__
+
+#ifndef __com_sun_star_container_XIndexReplace_idl__
+#include <com/sun/star/container/XIndexReplace.idl>
+#endif
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module text {
+
+//=============================================================================
+
+/** provides access to the numbering rules.
+ <p> Numbering rules may be set at a <type>Paragraph</type> 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;
+ //-------------------------------------------------------------------------
+
+ /** determins if the margins are absolute or relative
+ to the preceeding numbering level.
+ */
+ [optional, property] boolean IsAbsoluteMargins;
+ //-------------------------------------------------------------------------
+
+ /** determins if the numbering rules are automatically created
+ as opposed to numbering rules that are part of a numbering style.
+ */
+ [optional, property] boolean IsAutomatic;
+ //-------------------------------------------------------------------------
+
+ /** determins if the numbering levels are counted coninuously 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