xref: /trunk/main/offapi/com/sun/star/sheet/XLabelRanges.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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