offapi/com/sun/star/sheet/FunctionDescriptions.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: FunctionDescriptions.idl,v $
  10  * $Revision: 1.7 $
  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_FunctionDescriptions_idl__
  32 #define __com_sun_star_sheet_FunctionDescriptions_idl__
  33
  34 #ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__
  35 #include <com/sun/star/sheet/XFunctionDescriptions.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XNameAccess_idl__
  39 #include <com/sun/star/container/XNameAccess.idl>
  40 #endif
  41 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  42 #include <com/sun/star/container/XEnumerationAccess.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module sheet {
  48
  49 //=============================================================================
  50
  51 /** represents a collection of function descriptions for all built-in
  52     functions as well as add-in functions available in the spreadsheet
  53     application.
  54
  55     <p>All 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
  58     service <type>FunctionDescription</type>.</p>
  59  */
  60 published service FunctionDescriptions
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** provides access to the property sequence of a function description
  65         via function index or identifier.
  66      */
  67     interface com::sun::star::sheet::XFunctionDescriptions;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** provides access to the property sequence of a function description
  72         via function name.
  73
  74         <p>The localized uppercase name of the function has to be used
  75         here.</p>
  76      */
  77     interface com::sun::star::container::XNameAccess;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** creates an enumeration of all function descriptions.
  82
  83         @see com::sun::star::sheet::FunctionDescriptionEnumeration
  84      */
  85     interface com::sun::star::container::XEnumerationAccess;
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif
  94