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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_NumberingRules_idl__
  20 #define __com_sun_star_text_NumberingRules_idl__
  21
  22 #include <com/sun/star/container/XIndexReplace.idl>
  23 #include <com/sun/star/beans/XPropertySet.idl>
  24
  25
  26
  27  module com {  module sun {  module star {  module text {
  28
  29
  30 /** provides access to the numbering rules.
  31     <p> Numbering rules may be set at a Paragraph object.  The numbering rules are
  32     levels of property values. Each level contains equal properties.
  33
  34     </p>
  35  */
  36 published service NumberingRules
  37 {
  38     /** provides access to the levels of the numbering rule.
  39
  40                 <p>The numbering rules are levels of property values. Each
  41                 level contains equal properties.</p>
  42                 @see NumberingLevel;@see NumberingLevel;
  43      */
  44         interface com::sun::star::container::XIndexReplace;
  45
  46     [optional] interface com::sun::star::beans::XPropertySet;
  47
  48     /** determines if the margins are absolute or relative
  49         to the preceding numbering level.
  50      */
  51     [optional, property] boolean  IsAbsoluteMargins;
  52
  53     /** determines if the numbering rules are automatically created
  54         as opposed to numbering rules that are part of a numbering style.
  55      */
  56     [optional, property] boolean IsAutomatic;
  57
  58     /** determines if the numbering levels are counted continuously  or if
  59         each numbering level is counted separately.
  60      */
  61     [optional, property] boolean IsContinuousNumbering;
  62
  63     /** contains the name of the numbering rules. It is used to identify a certain
  64         numbering rules property
  65      */
  66     [optional, readonly, property] string Name;
  67
  68         /** This numbering is used in the outline of the document (e.g. headings).
  69          */
  70         [optional, property] boolean    NumberingIsOutline;
  71
  72         /** the type of numbering (Arabic, characters, roman numbers, etc.).
  73          */
  74         [optional, property] short    NumberingType;
  75
  76         /** id of default list for the numbering rules instance
  77          */
  78         [optional, readonly, property] string DefaultListId;
  79 };
  80
  81
  82 }; }; }; };
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */