offapi/com/sun/star/sheet/FunctionDescription.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_FunctionDescription_idl__
  21 #define __com_sun_star_sheet_FunctionDescription_idl__
  22
  23 #include <com/sun/star/sheet/FunctionArgument.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** collects all properties used to describe a function.
  30
  31     @see com::sun::star::sheet::FunctionDescriptions
  32  */
  33 published service FunctionDescription
  34 {
  35
  36     /** returns the function's unique identifier.
  37
  38         @see com::sun::star::sheet::XFunctionDescriptions
  39      */
  40     [readonly, property] long Id;
  41
  42
  43     /** returns the function's category.
  44
  45         @see com::sun::star::sheet::FunctionCategory
  46      */
  47     [readonly, property] long Category;
  48
  49
  50     /** returns the localized function's name.
  51      */
  52     [readonly, property] string Name;
  53
  54
  55     /** returns a localized description of the function.
  56      */
  57     [readonly, property] string Description;
  58
  59
  60     /** returns a sequence of localized descriptions of the function's
  61         arguments (in the order specified by the function).
  62      */
  63     [readonly, property] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
  64
  65 };
  66
  67
  68 }; }; }; };
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */