1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_form_inspection_XSDValidationPropertyHandler_idl__
25#define __com_sun_star_form_inspection_XSDValidationPropertyHandler_idl__
26
27#ifndef __com_sun_star_inspection_XPropertyHandler_idl__
28#include <com/sun/star/inspection/XPropertyHandler.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module form { module inspection {
34
35//=============================================================================
36
37/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
38    which provides properties related to binding form control models to XForm bindings and validating
39    the form control content.
40
41    <p>By using an <type>XMLFormsPropertyHandler</type>, an <type scope="com::sun::star::inspection">ObjectInspector</type>
42    can be used to bind form components to <type scope="com::sun::star::xforms">Binding</type> instances.
43    Since those instances also support validating form control content (by supporting an
44    <type scope="com::sun::star::form::validation">XValidator</type> interface), it seems reasonable to
45    edit those validate-related properties (like the XSD data type to validate against) in the
46    <type scope="com::sun::star::inspection">ObjectInspector</type>, too. This is what an <type>XSDValidationPropertyHandler</type>
47    is good for.</p>
48
49    <p>The handler expects a value named "ContextDocument" in the context in which it is created.
50    That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the
51    <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this
52    value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type>
53    interface), this document is used to do XML binding related work.</p>
54
55    @see com::sun::star::inspection::XPropertyHandler
56    @see com::sun::star::form::binding::BindableControlModel
57    @see com::sun::star::form::binding::ValueBinding
58    @see com::sun::star::forms::validation::ValidatableControlModel
59    @see com::sun::star::xforms::Binding
60    @see com::sun::star::xsd::XDataType
61    @see com::sun::star::uno::XComponentContext::getValueByName
62*/
63service XSDValidationPropertyHandler
64{
65    interface com::sun::star::inspection::XPropertyHandler;
66};
67
68//=============================================================================
69
70}; }; }; }; };
71
72#endif
73
74