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