offapi/com/sun/star/xforms/Binding.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_xforms_Binding_idl__
  28 #define __com_sun_star_xforms_Binding_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_form_binding_ValueBinding_idl__
  35 #include <com/sun/star/form/binding/ValueBinding.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_binding_ListEntrySource_idl__
  39 #include <com/sun/star/form/binding/ListEntrySource.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_form_validation_XValidator_idl__
  43 #include <com/sun/star/form/validation/XValidator.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module xforms {
  49
  50 interface XSubmission;
  51
  52 //=============================================================================
  53
  54 /** represent a binding to one or more nodes in the DOM tree of an <type>XModel</type>.
  55  */
  56 service Binding
  57 {
  58     /** allows the binding to act as value supplier for a form component
  59
  60     @see com::sun::star::form::binding::BindableControlModel
  61     */
  62     service com::sun::star::form::binding::ValueBinding;
  63
  64     /** allows external instances to observe the value represented by the binding
  65
  66         <p>This interface is an optional part of the
  67         <type scope="com::sun::star::form::binding">ValueBinding</type> servce, but loses
  68         its optionality here.</p>
  69     */
  70     interface com::sun::star::util::XModifyBroadcaster;
  71
  72     /** allows the binding to act as source for list entries of form controls
  73
  74         <p>If a binding is associated with more than one node in a DOM tree, it
  75         does not represent a single value, but a list of values. Using this interface,
  76         this list can be displayed in form control list and combo boxes.</p>
  77     */
  78     service com::sun::star::form::binding::ListEntrySource;
  79
  80     /** allows the binding to act as validator for a form component
  81
  82     @see com::sun::star::form::binding::ValidatableControlModel
  83     */
  84     interface com::sun::star::form::validation::XValidator;
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 /*=============================================================================
  92
  93 =============================================================================*/
  94 #endif