offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module form { module inspection {
  22
  23
  24 /** implements a property handler for use with a com::sun::star::inspection::ObjectInspector
  25     which provides properties related to binding form control models to XForm bindings and validating
  26     the form control content.
  27
  28     <p>By using an XMLFormsPropertyHandler, a com::sun::star::inspection::ObjectInspector
  29     can be used to bind form components to com::sun::star::xforms::Binding instances.
  30     Since those instances also support validating form control content (by supporting an
  31     com::sun::star::form::validation::XValidator interface), it seems reasonable to
  32     edit those validate-related properties (like the XSD data type to validate against) in the
  33     com::sun::star::inspection::ObjectInspector, too. This is what an XSDValidationPropertyHandler
  34     is good for.</p>
  35
  36     <p>The handler expects a value named "ContextDocument" in the context in which it is created.
  37     That is, the com::sun::star::uno::XComponentContext used for creating the
  38     CellBindingPropertyHandler is examined for a value with this name. If the object in this
  39     value denotes a XML form document (indicated by supporting the com::sun::star::xforms::XFormsSupplier
  40     interface), this document is used to do XML binding related work.</p>
  41
  42     @see com::sun::star::inspection::XPropertyHandler
  43     @see com::sun::star::form::binding::BindableControlModel
  44     @see com::sun::star::form::binding::ValueBinding
  45     @see com::sun::star::forms::validation::ValidatableControlModel
  46     @see com::sun::star::xforms::Binding
  47     @see com::sun::star::xsd::XDataType
  48     @see com::sun::star::uno::XComponentContext::getValueByName
  49 */
  50 service XSDValidationPropertyHandler
  51 {
  52     interface com::sun::star::inspection::XPropertyHandler;
  53 };
  54
  55
  56 }; }; }; }; };
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */