1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24#ifndef __com_sun_star_sheet_FunctionDescription_idl__ 25#define __com_sun_star_sheet_FunctionDescription_idl__ 26 27#ifndef __com_sun_star_sheet_FunctionArgument_idl__ 28#include <com/sun/star/sheet/FunctionArgument.idl> 29#endif 30 31//============================================================================= 32 33module com { module sun { module star { module sheet { 34 35//============================================================================= 36 37/** collects all properties used to describe a function. 38 39 @see com::sun::star::sheet::FunctionDescriptions 40 */ 41published service FunctionDescription 42{ 43 //------------------------------------------------------------------------- 44 45 /** returns the function's unique identifier. 46 47 @see com::sun::star::sheet::XFunctionDescriptions 48 */ 49 [readonly, property] long Id; 50 51 //------------------------------------------------------------------------- 52 53 /** returns the function's category. 54 55 @see com::sun::star::sheet::FunctionCategory 56 */ 57 [readonly, property] long Category; 58 59 //------------------------------------------------------------------------- 60 61 /** returns the localized function's name. 62 */ 63 [readonly, property] string Name; 64 65 //------------------------------------------------------------------------- 66 67 /** returns a localized description of the function. 68 */ 69 [readonly, property] string Description; 70 71 //------------------------------------------------------------------------- 72 73 /** returns a sequence of localized descriptions of the function's 74 arguments (in the order specified by the function). 75 */ 76 [readonly, property] sequence< com::sun::star::sheet::FunctionArgument > Arguments; 77 78}; 79 80//============================================================================= 81 82}; }; }; }; 83 84#endif 85 86