summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XSolverDescription.idl
blob: 6051a54c1ef6f1dc8868af024db30fa047bea817 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XSolverDescription.idl,v $
 * $Revision: 1.3 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XSolverDescription_idl__
#define __com_sun_star_sheet_XSolverDescription_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** gives access to user-visible strings for a solver.
 */
interface XSolverDescription: com::sun::star::uno::XInterface
{
    /** A user-visible name of the component.
    */
    [attribute, readonly] string ComponentDescription;

    /** returns a short description for a property in the component's
        <type scope="com::sun::star::beans">XPropertySet</type> interface.
    */
    string getPropertyDescription( [in] string aPropertyName );

    /** After calling solve, a message describing the status
        (explaining why no solution was found).
    */
    [attribute, readonly] string StatusDescription;
};

//=============================================================================

}; }; }; };

#endif