summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/component/DatabaseFormattedField.idl
blob: ae8b7ff1aa3027a183063e4e22e35cd39b7224b2 (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
/*************************************************************************
 *
 * 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: DatabaseFormattedField.idl,v $
 * $Revision: 1.8 $
 *
 * 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_form_component_DatabaseFormattedField_idl__
#define __com_sun_star_form_component_DatabaseFormattedField_idl__

#ifndef __com_sun_star_form_component_FormattedField_idl__
#include <com/sun/star/form/component/FormattedField.idl>
#endif

#ifndef __com_sun_star_form_DataAwareControlModel_idl__
#include <com/sun/star/form/DataAwareControlModel.idl>
#endif


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

 module com {  module sun {  module star {  module form {  module component {

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

/** This service specifies a formatted field model which is data-aware, and can be bound to a database field.
 */
published service DatabaseFormattedField
{
    service com::sun::star::form::component::FormattedField;

    service com::sun::star::form::DataAwareControlModel;

    //-------------------------------------------------------------------------

    /** determines if an empty text should be treated as a <NULL/> value.

        <p>When the user enters text into a formatted field control, and after this, the control
        content is to be committed into the database field the control is bound to,
        a decision must be made how to deal with empty strings.<br/>
        This is controlled by <member>ConvertEmptyToNull</member>.</p>

        <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is
        converted into <NULL/>, else it is written as empty string.</p>
     */
    [property] boolean ConvertEmptyToNull;

};

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

}; }; }; }; };

#endif