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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: NumberingRules.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_NumberingRules_idl__
  31 #define __com_sun_star_text_NumberingRules_idl__
  32
  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
  39
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module text {
  44
  45 //=============================================================================
  46
  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.
  50
  51     </p>
  52  */
  53 published service NumberingRules
  54 {
  55     /** provides access to the levels of the numbering rule.
  56
  57                 <p>The numbering rules are levels of property values. Each
  58                 level contains equal properties.</p>
  59                 @see NumberingLevel;@see NumberingLevel;
  60      */
  61         interface com::sun::star::container::XIndexReplace;
  62
  63     [optional] interface com::sun::star::beans::XPropertySet;
  64     //-------------------------------------------------------------------------
  65
  66     /** determins if the margins are absolute or relative
  67         to the preceeding numbering level.
  68      */
  69     [optional, property] boolean  IsAbsoluteMargins;
  70     //-------------------------------------------------------------------------
  71
  72     /** determins if the numbering rules are automatically created
  73         as opposed to numbering rules that are part of a numbering style.
  74      */
  75     [optional, property] boolean IsAutomatic;
  76     //-------------------------------------------------------------------------
  77
  78     /** determins if the numbering levels are counted coninuously  or if
  79         each numbering level is counted separately.
  80      */
  81     [optional, property] boolean IsContinuousNumbering;
  82     //-------------------------------------------------------------------------
  83
  84     /** contains the name of the numbering rules. It is used to identify a certain
  85         numbering rules property
  86      */
  87     [optional, readonly, property] string Name;
  88         //-------------------------------------------------------------------------
  89
  90         /** This numbering is used in the outline of the document (e.g. headings).
  91          */
  92         [optional, property] boolean    NumberingIsOutline;
  93         //-------------------------------------------------------------------------
  94
  95         /** the type of numbering (arabic, characters, roman numbers, etc.).
  96          */
  97         [optional, property] short    NumberingType;
  98         //-------------------------------------------------------------------------
  99
 100         /** id of default list for the numbering rules instance
 101          */
 102         [optional, readonly, property] string DefaultListId;
 103         //-------------------------------------------------------------------------
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; };
 109
 110 #endif