xref: /aoo41x/main/offapi/com/sun/star/sheet/XNamedRange.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_XNamedRange_idl__
#define __com_sun_star_sheet_XNamedRange_idl__

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

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

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

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

/** provides access to the settings of a named range in a spreadsheet
	document.

	@see com::sun::star::sheet::NamedRange
 */
published interface XNamedRange: com::sun::star::container::XNamed
{
	//-------------------------------------------------------------------------

	/** returns the content of the named range.

		<p>The content can be a reference to a cell or cell range
		or any formula expression.</p>
	 */
	string getContent();

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

	/** sets the content of the named range.

		<p>The content can be a reference to a cell or cell range
		or any formula expression.</p>
	 */
	void setContent( [in] string aContent );

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

	/** returns the position in the document which is used as a
		base for relative references in the content.
	 */
	com::sun::star::table::CellAddress getReferencePosition();

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

	/** sets the position in the document which is used as a
		base for relative references in the content.
	 */
	void setReferencePosition(
			[in] com::sun::star::table::CellAddress aReferencePosition );

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

	/** returns the type of the named range.

		<p>This is a combination of flags as defined in
		<type>NamedRangeFlag</type>.</p>
	 */
	long getType();

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

	/** sets the type of the named range.

		@param nType
			a combination of flags that specify the type of a named range,
			as defined in <type>NamedRangeFlag</type>.
	 */
	void setType( [in] long nType );

};

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

}; }; }; };

#endif