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

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