AOO410/main/offapi/com/sun/star/chart/XDiagram.idl

/**************************************************************
 * 
 * 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_XDiagram_idl__ 
#define __com_sun_star_chart_XDiagram_idl__ 
 
#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 
 
#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 
#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 
#endif 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module chart {  
 
//============================================================================= 
 
/** manages the diagram of the chart document.

    @see XChartDocument
 */
published interface XDiagram: com::sun::star::drawing::XShape
{ 
	//------------------------------------------------------------------------- 
	 
	/** @returns 
        	a string representing the diagram type. This string
			contains the fully qualified name of the corresponding
			service.
	 */
	string getDiagramType(); 
 
	//------------------------------------------------------------------------- 
	 
	/** @returns 
			the properties of the specified data row (series).

        @param nRow
        	the index of the series (0-based)

        @see ChartDataRowProperties
	 */
	com::sun::star::beans::XPropertySet getDataRowProperties( [in] long nRow ) 
		raises( com::sun::star::lang::IndexOutOfBoundsException ); 
 
	//------------------------------------------------------------------------- 
	 
	/** @returns 
			the properties of the specified data point. 

        @param nCol
        	the index of the data point of a series (0-based).
        @param nRow
        	the index of a series (0-based).
            
		@see ChartDataPointProperties
	 */
	com::sun::star::beans::XPropertySet getDataPointProperties( [in] long nCol, 
																[in] long nRow ) 
		raises( com::sun::star::lang::IndexOutOfBoundsException ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif