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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_FunctionDescriptions_idl__
  21 #define __com_sun_star_sheet_FunctionDescriptions_idl__
  22
  23 #include <com/sun/star/sheet/XFunctionDescriptions.idl>
  24 #include <com/sun/star/container/XNameAccess.idl>
  25 #include <com/sun/star/container/XEnumerationAccess.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** represents a collection of function descriptions for all built-in
  32     functions as well as add-in functions available in the spreadsheet
  33     application.
  34
  35     <p>All container access methods return a sequence of
  36     com::sun::star::beans::PropertyValue structs.
  37     The properties contained in the sequence are collected in the
  38     service FunctionDescription.</p>
  39  */
  40 published service FunctionDescriptions
  41 {
  42
  43     /** provides access to the property sequence of a function description
  44         via function index or identifier.
  45      */
  46     interface com::sun::star::sheet::XFunctionDescriptions;
  47
  48
  49     /** provides access to the property sequence of a function description
  50         via function name.
  51
  52         <p>The localized uppercase name of the function has to be used
  53         here.</p>
  54      */
  55     interface com::sun::star::container::XNameAccess;
  56
  57
  58     /** creates an enumeration of all function descriptions.
  59
  60         @see com::sun::star::sheet::FunctionDescriptionEnumeration
  61      */
  62     interface com::sun::star::container::XEnumerationAccess;
  63
  64 };
  65
  66
  67 }; }; }; };
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */