xref: /aoo41x/main/offapi/com/sun/star/sheet/XSheetCellRanges.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_sheet_XSheetCellRanges_idl__
#define __com_sun_star_sheet_XSheetCellRanges_idl__

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

#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.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 cell ranges in a collection via index and
	other helper methods.

	@see com::sun::star::sheet::SheetCellRanges
 */
published interface XSheetCellRanges: com::sun::star::container::XIndexAccess
{
	//-------------------------------------------------------------------------

	/** returns the collection of all used cells.

		@see com::sun::star::sheet::Cells
	 */
	com::sun::star::container::XEnumerationAccess getCells();

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

	/** creates a string with addresses of all contained cell ranges.

		<p>The range addresses are separated with semicolons. For instance
		the string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p>

		@returns
			a string containing the addresses of all cell ranges.
	 */
	string getRangeAddressesAsString();

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

	/** creates a sequence with addresses of all contained cell ranges.

		@returns
			a sequence with the addresses of all cell ranges.
	 */
	sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses();

};

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

}; }; }; };

#endif