1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__ 29#define __com_sun_star_sheet_XFunctionDescriptions_idl__ 30 31#ifndef __com_sun_star_container_XIndexAccess_idl__ 32#include <com/sun/star/container/XIndexAccess.idl> 33#endif 34 35#ifndef __com_sun_star_beans_PropertyValue_idl__ 36#include <com/sun/star/beans/PropertyValue.idl> 37#endif 38 39#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 40#include <com/sun/star/lang/IllegalArgumentException.idl> 41#endif 42 43//============================================================================= 44 45module com { module sun { module star { module sheet { 46 47//============================================================================= 48 49/** provides access to the property sequence of a function description 50 via function index or identifier. 51 52 <p>The container access methods return a sequence of 53 <type scope="com::sun::star::beans">PropertyValue</type> structs. 54 The properties contained in the sequence are collected in the service 55 <type>FunctionDescription</type>.</p> 56 57 @see com::sun::star::sheet::FunctionDescriptions 58 */ 59published interface XFunctionDescriptions: com::sun::star::container::XIndexAccess 60{ 61 //------------------------------------------------------------------------- 62 63 /** finds a function description by the identifier of the function. 64 65 @param nId 66 is the identifier of the function description (the same that 67 is used in the service <type>RecentFunctions</type>.</p> 68 69 @returns 70 the sequence of property values (described in 71 <type>FunctionDescription</type>). 72 */ 73 sequence< com::sun::star::beans::PropertyValue > getById( [in] long nId ) 74 raises( com::sun::star::lang::IllegalArgumentException ); 75 76}; 77 78//============================================================================= 79 80}; }; }; }; 81 82#endif 83 84