offapi/com/sun/star/sheet/FunctionArgument.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: FunctionArgument.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_FunctionArgument_idl__
  32 #define __com_sun_star_sheet_FunctionArgument_idl__
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module sheet {
  37
  38 //=============================================================================
  39
  40 /** contains the description of a single argument within a spreadsheet
  41     function.
  42
  43     @see com::sun::star::sheet::FunctionDescription
  44  */
  45 published struct FunctionArgument
  46 {
  47     //-------------------------------------------------------------------------
  48
  49     /** the name of the argument.
  50      */
  51     string Name;
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** a description of the argument.
  56      */
  57     string Description;
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** determines whether the argument is optional.
  62      */
  63     boolean IsOptional;
  64
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif
  72