offapi/com/sun/star/text/NumberingRules.idl

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