offapi/com/sun/star/xforms/Binding.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 xforms {
  22
  23 interface XSubmission;
  24
  25
  26 /** represent a binding to one or more nodes in the DOM tree of an XModel.
  27  */
  28 service Binding
  29 {
  30     /** allows the binding to act as value supplier for a form component
  31
  32     @see com::sun::star::form::binding::BindableControlModel
  33     */
  34     service com::sun::star::form::binding::ValueBinding;
  35
  36     /** allows external instances to observe the value represented by the binding
  37
  38         <p>This interface is an optional part of the
  39         com::sun::star::form::binding::ValueBinding service, but loses
  40         its optionality here.</p>
  41     */
  42     interface com::sun::star::util::XModifyBroadcaster;
  43
  44     /** allows the binding to act as source for list entries of form controls
  45
  46         <p>If a binding is associated with more than one node in a DOM tree, it
  47         does not represent a single value, but a list of values. Using this interface,
  48         this list can be displayed in form control list and combo boxes.</p>
  49     */
  50     service com::sun::star::form::binding::ListEntrySource;
  51
  52     /** allows the binding to act as validator for a form component
  53
  54     @see com::sun::star::form::binding::ValidatableControlModel
  55     */
  56     interface com::sun::star::form::validation::XValidator;
  57
  58     /** among other properties, there is this one
  59
  60         <p>It is unclear to me whether this is an implementation detail
  61         or a supported interface.</p>
  62         <p>The value supports the service
  63             com::sun::star::xml::NamespaceContainer</p>
  64
  65         @see com::sun::star::xml::NamespaceContainer
  66      */
  67     [optional, property] com::sun::star::container::XNameContainer
  68         BindingNamespaces;
  69 };
  70
  71
  72 }; }; }; };
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */