AOO410/main/offapi/com/sun/star/sheet/XLabelRanges.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_sheet_XLabelRanges_idl__
#define __com_sun_star_sheet_XLabelRanges_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif

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

module com {  module sun {  module star {  module sheet {

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

/** provides methods to access the members of a label range collection
	and to insert and remove them.

	@see com::sun::star::sheet::LabelRanges
	@see com::sun::star::sheet::LabelRange
 */
published interface XLabelRanges: com::sun::star::container::XIndexAccess
{
	//-------------------------------------------------------------------------

	/** adds a new label range to the collection.

		@param aLabelArea
			the cell range containing the titles of the label range.

		@param aDataArea
			the cell range containing the values of the label range.
	 */
	void addNew(
			[in] com::sun::star::table::CellRangeAddress aLabelArea,
			[in] com::sun::star::table::CellRangeAddress aDataArea );

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

	/** removes a label range from the collection.
	 */
	void removeByIndex( [in] long nIndex );

};

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

}; }; }; };

#endif