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