AOO410/main/offapi/com/sun/star/sheet/FunctionDescription.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_FunctionDescription_idl__
#define __com_sun_star_sheet_FunctionDescription_idl__

#ifndef __com_sun_star_sheet_FunctionArgument_idl__
#include <com/sun/star/sheet/FunctionArgument.idl>
#endif

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

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

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

/** collects all properties used to describe a function.

	@see com::sun::star::sheet::FunctionDescriptions
 */
published service FunctionDescription
{
	//-------------------------------------------------------------------------

	/** returns the function's unique identifier.

		@see com::sun::star::sheet::XFunctionDescriptions
	 */
	[readonly, property] long Id;

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

	/** returns the function's category.

		@see com::sun::star::sheet::FunctionCategory
	 */
	[readonly, property] long Category;

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

	/** returns the localized function's name.
	 */
	[readonly, property] string Name;

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

	/** returns a localized description of the function.
	 */
	[readonly, property] string Description;

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

	/** returns a sequence of localized descriptions of the function's
		arguments (in the order specified by the function).
	 */
	[readonly, property] sequence< com::sun::star::sheet::FunctionArgument > Arguments;

};

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

}; }; }; };

#endif