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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents a collection of function descriptions for all built-in
  25     functions as well as add-in functions available in the spreadsheet
  26     application.
  27
  28     <p>All container access methods return a sequence of
  29     com::sun::star::beans::PropertyValue structs.
  30     The properties contained in the sequence are collected in the
  31     service FunctionDescription.</p>
  32  */
  33 published service FunctionDescriptions
  34 {
  35
  36     /** provides access to the property sequence of a function description
  37         via function index or identifier.
  38      */
  39     interface com::sun::star::sheet::XFunctionDescriptions;
  40
  41
  42     /** provides access to the property sequence of a function description
  43         via function name.
  44
  45         <p>The localized uppercase name of the function has to be used
  46         here.</p>
  47      */
  48     interface com::sun::star::container::XNameAccess;
  49
  50
  51     /** creates an enumeration of all function descriptions.
  52
  53         @see com::sun::star::sheet::FunctionDescriptionEnumeration
  54      */
  55     interface com::sun::star::container::XEnumerationAccess;
  56
  57 };
  58
  59
  60 }; }; }; };
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */