office-gobmx/offapi/com/sun/star/text/ChapterNumberingRule.idl
2011-04-02 00:08:53 +02:00

85 lines
2.9 KiB
Text

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_text_ChapterNumberingRule_idl__
#define __com_sun_star_text_ChapterNumberingRule_idl__
#include <com/sun/star/style/NumberingRule.idl>
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
// DocMerge from xml: service com::sun::star::text::ChapterNumberingRule
/** describes the rules for chapter numbering in a text document.
<p>Some of the properties that are available in the interface are
ignored here.
</p>
<p>The type of numbering can only be:
NUM_CHARS_UPPER_LETTER, NUM_CHARS_LOWER_LETTER, NUM_ROMAN_UPPER,
NUM_ROMAN_LOWER, NUM_ARABIC, or NUM_NUMBER_NONE
</p>
<p>In the <type scope="com::sun::star::style">NumberingAlignment</type> only the field
<member scope="com::sun::star::style">NumberingAlignment::Alignment</member> is applied.
</p>
<p>Depending on the numbering types, the parameters for bullets or bit maps
may be ignored. The character style name for the numbering symbol is
also ignored.</p>
*/
published service ChapterNumberingRule
{
// DocMerge: empty anyway
service com::sun::star::style::NumberingRule;
//-------------------------------------------------------------------------
// DocMerge from xml: property com::sun::star::text::ChapterNumberingRule::HeadingStyleName
/** contains the name of the paragraph style that marks this heading
level.
<p>It is necessary that each style name appears only
once in the sequence of numbering rules.</p>
*/
[property] string HeadingStyleName;
};
//=============================================================================
}; }; }; };
#endif