offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.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.
  26
  27     <p>The handler introduces new properties to choose a com::sun::star::xforms::XModel
  28     and a com::sun::star::xforms::Binding within this model. Additionally,
  29     it introduces properties which reflect the different facets of the binding (e.g.
  30     com::sun::star::xforms::Binding::BindingExpression), so they can be changed
  31     directly in the com::sun::star::inspection::ObjectInspector as if they were a
  32     property of the form component which is being inspected.</p>
  33
  34     <p>The handler expects a value named "ContextDocument" in the context in which it is created.
  35     That is, the com::sun::star::uno::XComponentContext used for creating the
  36     CellBindingPropertyHandler is examined for a value with this name. If the object in this
  37     value denotes a XML form document (indicated by supporting the com::sun::star::xforms::XFormsSupplier
  38     interface), this document is used to do XML binding related work.</p>
  39
  40     @see com::sun::star::inspection::XPropertyHandler
  41     @see com::sun::star::form::binding::BindableControlModel
  42     @see com::sun::star::form::binding::ValueBinding
  43     @see com::sun::star::xforms::Binding
  44     @see com::sun::star::uno::XComponentContext::getValueByName
  45 */
  46 service XMLFormsPropertyHandler
  47 {
  48     interface com::sun::star::inspection::XPropertyHandler;
  49 };
  50
  51
  52 }; }; }; }; };
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */