summaryrefslogtreecommitdiff
path: root/offapi/drafts/com/sun/star/form/XBindableValue.idl
blob: de4a617f20f4391a104e284ee12bd3185f527fb5 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*************************************************************************
 *
 *  $RCSfile: XBindableValue.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2004-04-02 10:42:50 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __drafts_com_sun_star_form_XBindableValue_idl__
#define __drafts_com_sun_star_form_XBindableValue_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __drafts_com_sun_star_form_IncompatibleTypesException_idl__
#include <drafts/com/sun/star/form/IncompatibleTypesException.idl>
#endif

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

module drafts { module com {  module sun {  module star {  module form {

interface XValueBinding;

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

/** specifies support for being bound to an external value

    @see XValueBinding

    @deprecated
        This interface is superseeded by <type scope="com::sun::star::form::binding">XBindableValue</type>
*/
interface XBindableValue : com::sun::star::uno::XInterface
{
    /** sets an external instance which controls the value of the component

        <p>Any previously active binding will be revoked. There can be only one!</p>

        @param XValueBinding
            the new binding which is to be used by the component. May be <NULL/>,
            in this case only the current binding is revoked.

        @throws <type>IncompatibleTypesException</type>
            if the new binding (provided it's not <NULL/>) supports only types
            which are incompatible with the types of the bindable component.
     */
    void    setValueBinding( [in] XValueBinding aBinding )
                raises ( IncompatibleTypesException );

    /** retrieves the external instance which currently controls the value of the
        component
    */
    XValueBinding
            getValueBinding( );
};

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

}; }; }; }; };

#endif