/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: NumberingLevel.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: tl $ $Date: 2006-06-19 10:05:46 $
 *
 *  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_NumberingLevel_idl__
#define __com_sun_star_text_NumberingLevel_idl__

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_awt_Size_idl__
#include <com/sun/star/awt/Size.idl>
#endif

#ifndef __com_sun_star_awt_FontDescriptor_idl__
#include <com/sun/star/awt/FontDescriptor.idl>
#endif

#ifndef __com_sun_star_awt_XBitmap_idl__
#include <com/sun/star/awt/XBitmap.idl>
#endif

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

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

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

/** provides access to a numbering level as part of the Numbering Rules.
 */
published service NumberingLevel
{
    //-------------------------------------------------------------------------

    /** adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)

        <p>
        </p>
     */
    [property] short Adjust;

    //-------------------------------------------------------------------------

    /** number of upper levels that are included in the current numbering symbol.
     */
    [optional, property] short ParentNumbering;

    //-------------------------------------------------------------------------

    /** the prefix of the numbering symbol.
     */
    [property] string Prefix;

    //-------------------------------------------------------------------------

    /** the suffix of the numbering symbol.
     */
    [property] string Suffix;

    //-------------------------------------------------------------------------

    /** Name of the character style that is used for the numbering symbol.
     */
    [optional, property] string CharStyleName;

    //-------------------------------------------------------------------------

    /** the ID of the symbol in the given font. This is only valid if the
        numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
          @deprecated
     */
    [optional, property] short BulletId;
    //-------------------------------------------------------------------------

    /** contains the symbol in the given font. This is only valid if the
        numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
     */
    [property] string BulletChar;
    //-------------------------------------------------------------------------

    /** the name of the font for the symbol. This is only valid if the
        numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
     */
    [property] string BulletFontName;

    //-------------------------------------------------------------------------

    /** the font used to paint the bullet.
     */
    [optional, property] com::sun::star::awt::FontDescriptor BulletFont;

    //-------------------------------------------------------------------------

    /** the URL of the graphic file that is used as the numbering symbol.

        <p> This is only valid if the numbering type is
        <const scope="com::sun::star::style">NumberingType::BITMAP</const>.</p>
     */
    [property] string GraphicURL;

    //-------------------------------------------------------------------------

    /** the bitmap containing the bullet.
     */
    [optional, property] com::sun::star::awt::XBitmap GraphicBitmap;

    //-------------------------------------------------------------------------

    /** size of the graphic that is used as bullet.
     */
    [optional, property] com::sun::star::awt::Size    GraphicSize;
    //-------------------------------------------------------------------------

    //-------------------------------------------------------------------------

    /** contains the vertical orientation of a graphic.

        <p> It is set using com::sun::star::text::VertOrientation.</p>
     */
    [optional, property] short VertOrient;
    //-------------------------------------------------------------------------

    /** specifies the start value for the numbering.

        <p>This property is only valid if the numbering type is not
        <const scope="com::sun::star::style">NumberingType::BITMAP</const> or
        <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.</p>
     */
    [optional, property] short StartWith;

    //-------------------------------------------------------------------------

    /** specifies the left margin of the numbering
     */
    [property] long LeftMargin;

    //-------------------------------------------------------------------------

    /** specifies the distance between the numbering symbol and the text of
        the paragraph.
     */
    [optional, property] long SymbolTextDistance;

    //-------------------------------------------------------------------------

    /** specifies the offset between the beginning of the first line and
        the beginning of the following lines of the paragraph.
     */
    [property] long FirstLineOffset;

    //-------------------------------------------------------------------------

    /** specifies the type of numbering.
     */
    [property] short NumberingType;

    //-------------------------------------------------------------------------

    /** contains the name of the paragraph style that is interpreted as the
        header of this level. It is only contained in the levels of
        chapter numbering rules.
     */
    [property] string HeadingStyleName;

    /** contains the color for the symbol. This is only valid if the
        numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
    */
    [optional, property] com::sun::star::util::Color BulletColor;

    /** contains the size of the symbol relative to the high of the paragraph. This is only valid if the
        numbering type is <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>.
    */
    [optional, property] short BulletRelSize;
};

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

}; }; }; };

#endif

