offapi/com/sun/star/sheet/FunctionDescription.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: FunctionDescription.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_FunctionDescription_idl__
  32 #define __com_sun_star_sheet_FunctionDescription_idl__
  33
  34 #ifndef __com_sun_star_sheet_FunctionArgument_idl__
  35 #include <com/sun/star/sheet/FunctionArgument.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** collects all properties used to describe a function.
  45
  46     @see com::sun::star::sheet::FunctionDescriptions
  47  */
  48 published service FunctionDescription
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** returns the function's unique identifier.
  53
  54         @see com::sun::star::sheet::XFunctionDescriptions
  55      */
  56     [readonly, property] long Id;
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** returns the function's category.
  61
  62         @see com::sun::star::sheet::FunctionCategory
  63      */
  64     [readonly, property] long Category;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** returns the localized function's name.
  69      */
  70     [readonly, property] string Name;
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** returns a localized description of the function.
  75      */
  76     [readonly, property] string Description;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** returns a sequence of localized descriptions of the function's
  81         arguments (in the order specified by the function).
  82      */
  83     [readonly, property] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
  84
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 #endif
  92