/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: NumberingRules.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: tl $ $Date: 2006-06-19 10:05:47 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_text_NumberingRules_idl__
#define __com_sun_star_text_NumberingRules_idl__

#ifndef __com_sun_star_container_XIndexReplace_idl__
#include <com/sun/star/container/XIndexReplace.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

/** provides access to the numbering rules.
    <p> Numbering rules may be set at a <type>Paragraph</type> object.  The numbering rules are
    levels of property values. Each level contains equal properties.

    </p>
 */
published service NumberingRules
{
    /** provides access to the levels of the numbering rule.

                <p>The numbering rules are levels of property values. Each
                level contains equal properties.</p>
                @see NumberingLevel;@see NumberingLevel;
     */
        interface com::sun::star::container::XIndexReplace;

    [optional] interface com::sun::star::beans::XPropertySet;
    //-------------------------------------------------------------------------

    /** determins if the margins are absolute or relative
        to the preceeding numbering level.
     */
    [optional, property] boolean  IsAbsoluteMargins;
    //-------------------------------------------------------------------------

    /** determins if the numbering rules are automatically created
        as opposed to numbering rules that are part of a numbering style.
     */
    [optional, property] boolean IsAutomatic;
    //-------------------------------------------------------------------------

    /** determins if the numbering levels are counted coninuously  or if
        each numbering level is counted separately.
     */
    [optional, property] boolean IsContinuousNumbering;
    //-------------------------------------------------------------------------

    /** contains the name of the numbering rules. It is used to identify a certain
        numbering rules property
     */
    [optional, readonly, property] string Name;
    //-------------------------------------------------------------------------

    /** This numbering is used in the outline of the document (e.g. headings).
     */
    [optional, property] boolean    NumberingIsOutline;
    //-------------------------------------------------------------------------

    /** the type of numbering (arabic, characters, roman numbers, etc.).
     */
    [optional, property] short    NumberingType;
    //-------------------------------------------------------------------------
};

//=============================================================================

}; }; }; };

#endif
