offapi/com/sun/star/sheet/XFunctionDescriptions.idl

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