offapi/com/sun/star/text/ChapterNumberingRule.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
  20
  21
  22  module com {  module sun {  module star {  module text {
  23
  24 /** describes the rules for chapter numbering in a text document.
  25
  26
  27
  28     <p>Some of the properties that are available in the interface are
  29     ignored here.
  30
  31     </p>
  32     <p>The type of numbering can only be:
  33     NUM_CHARS_UPPER_LETTER, NUM_CHARS_LOWER_LETTER, NUM_ROMAN_UPPER,
  34     NUM_ROMAN_LOWER, NUM_ARABIC, or NUM_NUMBER_NONE
  35
  36     </p>
  37     <p>In the com::sun::star::style::NumberingAlignment only the field
  38     com::sun::star::style::NumberingAlignment::Alignment is applied.
  39
  40     </p>
  41     <p>Depending on the numbering types, the parameters for bullets or bit maps
  42     may be ignored.  The character style name for the numbering symbol is
  43     also ignored.</p>
  44  */
  45 published service ChapterNumberingRule
  46 {
  47     service com::sun::star::style::NumberingRule;
  48
  49     /** contains the name of the paragraph style that marks this heading
  50         level.
  51
  52
  53
  54         <p>It is necessary that each style name appears only
  55         once in the sequence of numbering rules.</p>
  56      */
  57     [property] string HeadingStyleName;
  58
  59 };
  60
  61
  62 }; }; }; };
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */