/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: ChartAxis.idl,v $
 *
 *  $Revision: 1.17 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 22:03:03 $
 *
 *  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_chart_ChartAxis_idl__
#define __com_sun_star_chart_ChartAxis_idl__

#ifndef __com_sun_star_drawing_LineProperties_idl__
#include <com/sun/star/drawing/LineProperties.idl>
#endif

#ifndef __com_sun_star_style_CharacterProperties_idl__
#include <com/sun/star/style/CharacterProperties.idl>
#endif

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

#ifndef __com_sun_star_chart_ChartAxisArrangeOrderType_idl__
#include <com/sun/star/chart/ChartAxisArrangeOrderType.idl>
#endif

#ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
#include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
#endif

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

 module com {  module sun {  module star {  module chart {

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

/** Specifies the axes in a diagram.

    <p>Note: The text properties correlate to all axis description
    elements, not to just a single text element.</p>
 */
published service ChartAxis
{


    /** set the properties for the entire axis line as well as for the
        tick marks.
     */
    service com::sun::star::drawing::LineProperties;

    /** set the properties for all text labels of the axis
     */
    service com::sun::star::style::CharacterProperties;

        /** If a <type>ChartAxis</type> may be stored as XML element, this
            service should be supported in order to preserve unparsed XML
            attributes.

        @since OOo 1.1.2
     */
    [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;

    interface com::sun::star::beans::XPropertySet;

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

    /** Contains the maximum value for the axis scale.
     */
    [optional, property] double Max;

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

    /** Contains the minimum value for the axis scale.
     */
    [optional, property] double Min;

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

    /** Contains the origin of the axis scale.
     */
    [optional, property] double Origin;

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

    /** Contains the distance between the main tick marks.
     */
    [optional, property] double StepMain;

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

    /** Contains the distance between the help tick marks.
 */
    [optional, property] double StepHelp;

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

    /** The maximium value of the axis scale is calculated by the chart if
        this property is <TRUE/>.
     */
    [optional, property] boolean AutoMax;

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

    /** The minimum value of the axis scale is calculated by the chart if
        this property is <TRUE/>.
     */
    [optional, property] boolean AutoMin;

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

    /** The origin is calculated by the chart if this property is <TRUE/>.
     */
    [optional, property] boolean AutoOrigin;

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

    /** The distance between the main tick marks is calculated by the chart
        if this property is <TRUE/>.
     */
    [optional, property] boolean AutoStepMain;

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

    /** The distance between the help tick marks is calculated by the
        chart if this property is <TRUE/>.
    */
    [optional, property] boolean AutoStepHelp;


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

    /** Determines if the axis is scaled logarithmically or
        not (linear).
     */
    [optional, property] boolean Logarithmic;

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

    /** Determines whether to display text at the axis or not.
     */
    [property] boolean DisplayLabels;

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

    /** Determines the rotation of the text elements
        (axis description) in 100th degrees.
     */
    [property] long TextRotation;

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

    /** Determines the position of the marks.@see ChartAxisMarks
     */
    [property] long Marks;

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

    /** Determines the position of the help marks.@see ChartAxisMarks
     */
    [property] long HelpMarks;

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

    /** Determines the overlap of the bars in a bar-type chart.

        <p>The value is given in percent of the width of the bars. The
        valid range is -100% to +100%. +100% means full overlap, -100%
        indicates a distance of one bar between 2 neighboring bars.</p>
     */
    [property] long Overlap;

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

    /** Specifies the width of the gaps between each set of data points
        in a bar chart.

        <p>The value is given in percent of the width of a bar; the
        valid range is 0 to 600%.</p>
     */
    [property] long GapWidth;

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

    /** The axis description may be arranged in a special order for a
        better placement.
     */
    [property] com::sun::star::chart::ChartAxisArrangeOrderType ArrangeOrder;

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

    /** Determines if long text is broken into multiple lines.
     */
    [property] boolean TextBreak;

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

    /** Determines if certain labels are hidden, if they would otherwise overlap.
        In this case, the value of this property must be set to <FALSE/>.
     */
    [property] boolean TextCanOverlap;

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

    /** Contains the type id for the number formatter of the axis.

        @see com::sun::star::util::XNumberFormatter
     */
    [property] long NumberFormat;

};

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

}; }; }; };

#endif
