Update ooo320-m1
[ooovba.git] / offapi / com / sun / star / form / component / DatabasePatternField.idl
blob23563d1795467b1fc744b70aa0f7b3dd9dc80da2
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: DatabasePatternField.idl,v $
10 * $Revision: 1.10 $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
30 #ifndef __com_sun_star_form_component_DatabasePatternField_idl__
31 #define __com_sun_star_form_component_DatabasePatternField_idl__
33 #ifndef __com_sun_star_form_component_PatternField_idl__
34 #include <com/sun/star/form/component/PatternField.idl>
35 #endif
37 #ifndef __com_sun_star_form_DataAwareControlModel_idl__
38 #include <com/sun/star/form/DataAwareControlModel.idl>
39 #endif
42 //=============================================================================
44 module com { module sun { module star { module form { module component {
46 //=============================================================================
48 /** This service specifies a data-aware control model for entering text which matches a specific
49 pattern.
51 published service DatabasePatternField
53 service com::sun::star::form::component::PatternField;
55 service com::sun::star::form::DataAwareControlModel;
57 //-------------------------------------------------------------------------
59 /** determines if an empty text should be treated as a <NULL/> value.
61 <p>When the user enters text into a pattern field, and after this, the control
62 content is to be committed into the database field the control is bound to,
63 a decision must be made how to deal with empty strings.<br/>
64 This is controlled by this property.</p>
66 <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is
67 converted into <NULL/>, else it is written as empty string.</p>
69 [property] boolean ConvertEmptyToNull;
71 };
73 //=============================================================================
75 }; }; }; }; };
77 #endif