offapi/com/sun/star/sheet/XFunctionDescriptions.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 /** provides access to the property sequence of a function description
  25     via function index or identifier.
  26
  27     <p>The container access methods return a sequence of
  28     com::sun::star::beans::PropertyValue structs.
  29     The properties contained in the sequence are collected in the service
  30     FunctionDescription.</p>
  31
  32     @see com::sun::star::sheet::FunctionDescriptions
  33  */
  34 published interface XFunctionDescriptions: com::sun::star::container::XIndexAccess
  35 {
  36
  37     /** finds a function description by the identifier of the function.
  38
  39         @param nId
  40             is the identifier of the function description (the same that
  41             is used in the service RecentFunctions.</p>
  42
  43         @returns
  44             the sequence of property values (described in
  45             FunctionDescription).
  46      */
  47     sequence< com::sun::star::beans::PropertyValue > getById( [in] long nId )
  48         raises( com::sun::star::lang::IllegalArgumentException );
  49
  50 };
  51
  52
  53 }; }; }; };
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */