merge the formfield patch from ooo-build
[ooovba.git] / offapi / com / sun / star / form / inspection / XSDValidationPropertyHandler.idl
blobaf875ed62969830e1b8147d4c4a80316e4a68938
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: XSDValidationPropertyHandler.idl,v $
10 * $Revision: 1.3 $
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 ************************************************************************/
31 #ifndef __com_sun_star_form_inspection_XSDValidationPropertyHandler_idl__
32 #define __com_sun_star_form_inspection_XSDValidationPropertyHandler_idl__
34 #ifndef __com_sun_star_inspection_XPropertyHandler_idl__
35 #include <com/sun/star/inspection/XPropertyHandler.idl>
36 #endif
38 //=============================================================================
40 module com { module sun { module star { module form { module inspection {
42 //=============================================================================
44 /** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
45 which provides properties related to binding form control models to XForm bindings and validating
46 the form control content.
48 <p>By using an <type>XMLFormsPropertyHandler</type>, an <type scope="com::sun::star::inspection">ObjectInspector</type>
49 can be used to bind form components to <type scope="com::sun::star::xforms">Binding</type> instances.
50 Since those instances also support validating form control content (by supporting an
51 <type scope="com::sun::star::form::validation">XValidator</type> interface), it seems reasonable to
52 edit those validate-related properties (like the XSD data type to validate against) in the
53 <type scope="com::sun::star::inspection">ObjectInspector</type>, too. This is what an <type>XSDValidationPropertyHandler</type>
54 is good for.</p>
56 <p>The handler expects a value named "ContextDocument" in the context in which it is created.
57 That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the
58 <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this
59 value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type>
60 interface), this document is used to do XML binding related work.</p>
62 @see com::sun::star::inspection::XPropertyHandler
63 @see com::sun::star::form::binding::BindableControlModel
64 @see com::sun::star::form::binding::ValueBinding
65 @see com::sun::star::forms::validation::ValidatableControlModel
66 @see com::sun::star::xforms::Binding
67 @see com::sun::star::xsd::XDataType
68 @see com::sun::star::uno::XComponentContext::getValueByName
70 service XSDValidationPropertyHandler
72 interface com::sun::star::inspection::XPropertyHandler;
75 //=============================================================================
77 }; }; }; }; };
79 #endif