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