xref: /aoo41x/main/offapi/com/sun/star/sheet/FunctionDescriptions.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_FunctionDescriptions_idl__
#define __com_sun_star_sheet_FunctionDescriptions_idl__

#ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__
#include <com/sun/star/sheet/XFunctionDescriptions.idl>
#endif

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif
#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif

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

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

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

/** represents a collection of function descriptions for all built-in
	functions as well as add-in functions available in the spreadsheet
	application.

	<p>All container access methods return a sequence of
	<type scope="com::sun::star::beans">PropertyValue</type> structs.
	The properties contained in the sequence are collected in the
	service <type>FunctionDescription</type>.</p>
 */
published service FunctionDescriptions
{
	//-------------------------------------------------------------------------

	/** provides access to the property sequence of a function description
		via function index or identifier.
	 */
	interface com::sun::star::sheet::XFunctionDescriptions;

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

	/** provides access to the property sequence of a function description
		via function name.

		<p>The localized uppercase name of the function has to be used
		here.</p>
	 */
	interface com::sun::star::container::XNameAccess;

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

	/** creates an enumeration of all function descriptions.

		@see com::sun::star::sheet::FunctionDescriptionEnumeration
	 */
	interface com::sun::star::container::XEnumerationAccess;

};

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

}; }; }; };

#endif