offapi/com/sun/star/sheet/XSolverDescription.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XSolverDescription_idl__
  29 #define __com_sun_star_sheet_XSolverDescription_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module sheet {
  38
  39 //=============================================================================
  40
  41 /** gives access to user-visible strings for a solver.
  42  */
  43 interface XSolverDescription: com::sun::star::uno::XInterface
  44 {
  45     /** A user-visible name of the component.
  46     */
  47     [attribute, readonly] string ComponentDescription;
  48
  49     /** returns a short description for a property in the component's
  50         <type scope="com::sun::star::beans">XPropertySet</type> interface.
  51     */
  52     string getPropertyDescription( [in] string aPropertyName );
  53
  54     /** After calling solve, a message describing the status
  55         (explaining why no solution was found).
  56     */
  57     [attribute, readonly] string StatusDescription;
  58 };
  59
  60 //=============================================================================
  61
  62 }; }; }; };
  63
  64 #endif
  65