offapi/com/sun/star/text/ChapterNumberingRule.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_ChapterNumberingRule_idl__
  28 #define __com_sun_star_text_ChapterNumberingRule_idl__
  29
  30 #ifndef __com_sun_star_style_NumberingRule_idl__
  31 #include <com/sun/star/style/NumberingRule.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module text {
  38
  39 //=============================================================================
  40
  41 // DocMerge from xml: service com::sun::star::text::ChapterNumberingRule
  42 /** describes the rules for chapter numbering in a text document.
  43
  44
  45
  46     <p>Some of the properties that are available in the interface are
  47     ignored here.
  48
  49     </p>
  50     <p>The type of numbering can only be:
  51     NUM_CHARS_UPPER_LETTER, NUM_CHARS_LOWER_LETTER, NUM_ROMAN_UPPER,
  52     NUM_ROMAN_LOWER, NUM_ARABIC, or NUM_NUMBER_NONE
  53
  54     </p>
  55     <p>In the <type scope="com::sun::star::style">NumberingAlignment</type> only the field
  56     <member scope="com::sun::star::style">NumberingAlignment::Alignment</member> is applied.
  57
  58     </p>
  59     <p>Depending on the numbering types, the parameters for bullets or bit maps
  60     may be ignored.  The character style name for the numbering symbol is
  61     also ignored.</p>
  62  */
  63 published service ChapterNumberingRule
  64 {
  65     // DocMerge: empty anyway
  66     service com::sun::star::style::NumberingRule;
  67
  68     //-------------------------------------------------------------------------
  69
  70     // DocMerge from xml: property com::sun::star::text::ChapterNumberingRule::HeadingStyleName
  71     /** contains the name of the paragraph style that marks this heading
  72         level.
  73
  74
  75
  76         <p>It is necessary that each style name appears only
  77         once in the sequence of numbering rules.</p>
  78      */
  79     [property] string HeadingStyleName;
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif