xref: /aoo41x/main/offapi/com/sun/star/chart/XAxisYSupplier.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_chart_XAxisYSupplier_idl__
#define __com_sun_star_chart_XAxisYSupplier_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_drawing_XShape_idl__
#include <com/sun/star/drawing/XShape.idl>
#endif

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


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

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

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

/** gives access to the <i>y</i>-axis of a chart.

    <p>Note that not all diagrams are capable of displaying a
    <i>y</i>-axis, e.g., the <type>PieDiagram</type>.</p>

    @see XDiagram
 */
published interface XAxisYSupplier: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** @returns
			the <i>y</i>-axis title shape.

		@see ChartTitle
	 */
	com::sun::star::drawing::XShape getYAxisTitle();

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

	/** @returns
			the properties of the <i>y</i>-axis of the diagram.

        <p>The returned property set contains scaling properties as
        well as formatting properties.</p>

		@see ChartAxis
	 */
	com::sun::star::beans::XPropertySet getYAxis();

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

	/** @returns
			the properties of the help grid (minor grid) of the
            <i>y</i>-axis of the diagram.

		@see ChartGrid
	 */
	com::sun::star::beans::XPropertySet getYHelpGrid();

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

	/** @returns
			the properties of the main grid (major grid) of the
            <i>y</i>-axis of the diagram.

        @see ChartGrid
	 */
	com::sun::star::beans::XPropertySet getYMainGrid();

};

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

}; }; }; };

#endif