offapi/com/sun/star/form/DataAwareControlModel.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_form_DataAwareControlModel_idl__
  28 #define __com_sun_star_form_DataAwareControlModel_idl__
  29
  30 #ifndef __com_sun_star_form_FormControlModel_idl__
  31 #include <com/sun/star/form/FormControlModel.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_form_XBoundComponent_idl__
  35 #include <com/sun/star/form/XBoundComponent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_XLoadListener_idl__
  39 #include <com/sun/star/form/XLoadListener.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_form_XReset_idl__
  43 #include <com/sun/star/form/XReset.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_beans_XPropertySet_idl__
  47 #include <com/sun/star/beans/XPropertySet.idl>
  48 #endif
  49
  50
  51 //=============================================================================
  52
  53  module com {  module sun {  module star {  module form {
  54
  55 //=============================================================================
  56
  57 /** is an abstract service for specialized <type>FormControlModel</type>s
  58     which are data aware and thus can be bound to a data source.
  59
  60     <p>The connection between a data-aware control model and a form which's data the
  61     control should display is made by parentship relations. The parent of a data-aware
  62     control model (see <type scope="com::sun::star::container">XChild</type>, inherited
  63     via the <type>FormControlModel</type> and <type>FormComponent</type> services) has
  64     always to be a <type scope="com::sun::star::form::component">DataForm</type>.</p>
  65  */
  66 published service DataAwareControlModel
  67 {
  68     service com::sun::star::form::FormControlModel;
  69
  70     /** makes it possible to transfer the data of the model to the connected data field.
  71         <p>
  72         This interface is optional, if a component doesn't support it, it has to forward
  73         the changes of it's value to the field it is connected to immediately (means whenever a user
  74         interaction changes it's content).
  75         </p>
  76      */
  77     [optional] interface com::sun::star::form::XBoundComponent;
  78
  79
  80     /** must be implemented in order to recognize when the containing form of the model connects
  81         to its data source  (loads its data). After loading the form, the model may bind to its
  82         related field source.<br/>
  83         This interface will seldom be used directly from outside.
  84      */
  85     interface com::sun::star::form::XLoadListener;
  86
  87
  88     /** Each <type>DataAwareControlModel</type> should be resettable for setting default values.
  89
  90         <p>In the context of a control model which is data-aware, the semantics of <em>default value</em>
  91         (see <type>XReset</type>) is as follows:<br/>
  92         If (and only if) the control is valid bound to a column of it's <typee scope="com::sun::star::form::component">DataForm</type>, and the form
  93         is not positioned on a new record (see <member scope="com::sun::star::sdb">RowSet::IsNew</member>), then
  94         <member>XReset::reset</member> does not reset the model's value to it's default value, but uses the
  95         underlying column value.<br/>
  96         In all other cases, the model is reset to the default value as specified by the respective property.</p>
  97
  98         <p>For an example, have a look at the <type scope="com::sun::star::form::component">TextField</type>. It inherites
  99         the <member scope="com::sun::star::awt">UnoControlEditModel::Text</member> property from the underlying
 100         service, and additionally specifies the <member scope="com::sun::star::form::component">TextField::DefaultText</member>.
 101         </p>
 102
 103         <p>In the context of a <type scope="com::sun::star::form::component">DataForm</type>, controls are
 104         automatically reset when one of the following applies
 105         <ul><li>The form is reset by invoking it's <type>XReset</type> interface.</li>
 106             <li>The form moves to a new record.</li>
 107             <li>The changes in the current record of the form are undone</li>
 108         </ul>
 109         </p>
 110     */
 111     interface com::sun::star::form::XReset;
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** specifies the name of the bound database field.
 116
 117         <p>This property makes sense in the <em>context</em> of the control model only. Normally, a control model
 118         is a child of a <type scope="com::sun::star::form::component">DataForm</type>, which is bound
 119         to a higher level object such as a table or query - more general, a result set.<br/>
 120         This member here describes the column of this result set which the control should act for.</p>
 121
 122         <p>Not every control model can be bound to every database column. Usually, super services of the
 123         <type>DataAwareControlModel</type> restrict the column types they can be used with.</p>
 124
 125         @see DataAwareControlModel::BoundField
 126      */
 127     [property] string DataField;
 128
 129     /** determines whether or not input into this field is required, when it is actually bound to a database field.
 130
 131         <p>If this property is set to <FALSE/>, then the form runtime will not check the control/model for
 132         <NULL/> values before submitting data to the database. Usually, if a control model is bound to
 133         a database field which cannot be <NULL/>, and the model itself does not have a value, then the database
 134         update is prevented, showing an error message to the user. To disable this behavior on a per-control
 135         basis, use the <code>InputRequired</code> property.</p>
 136
 137         @since OOo 3.1
 138     */
 139     [optional, property] boolean InputRequired;
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** references to the cursor field to which the control is bound.
 144         <p>Applies only if the form the control model belongs to is loaded and the control is valid bound.
 145         The referenced field supports the <type scope="com::sun::star::sdb">Column</type> service.
 146         </p>
 147         @see DataAwareControlModel::DataField
 148      */
 149     [readonly, property] com::sun::star::beans::XPropertySet BoundField;
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** references to a control model within the same document which should be used as a label.
 154         <p>Any user interface action which needs to refer to the control is assumed to use this
 155         property. <br/>
 156         A very common design method for forms is to group a data aware control with a label control,
 157         with the latter describing the content of the former. For instance, you may have a
 158         <type scope="com::sun::star::form::component">TextField</type>, which is bound to the e-mail
 159         column of your data source. Then you will probably add a
 160         <type scope="com::sun::star::form::component">FixedText</type> which's label is "E-Mail",
 161         and associate it with the TextField by setting it as <member>LabelControl</member>.<br/>
 162         Now if you imagine a component offering data search in a form, this component will examine
 163         the <member>LabelControl</member> property, find the <type scope="com::sun::star::form::component">FixedText</type>,
 164         examine it's label, and use this label to refer to the <type scope="com::sun::star::form::component">TextField</type>.
 165         </p>
 166         <p>When setting the property, a number of constraints apply:
 167         <ul>
 168             <li>The object which is to be set has to support the following interfaces
 169                 <ul><li><type scope="com::sun::star::awt">XControlModel</type></li>
 170                     <li><type scope="com::sun::star::lang">XServiceInfo</type></li>
 171                     <li><type scope="com::sun::star::beans">XPropertySet</type></li>
 172                     <li><type scope="com::sun::star::container">XChild</type></li>
 173                 </ul>
 174             </il>
 175             <li>It has to be a part of the same document as the model who's property is to be modified.</il>
 176             <li>Additionally, the support of a special service, indicating that the model is of the right type,
 177                 is required. Which kind of service is in the request depends on the type of the control model.<br/>
 178
 179                 For instance, text fields (<type scope="com::sun::star::form::component">TextField</type>) can be
 180                 labelled by label controls only (<type scope="com::sun::star::form::component">FixedText</type>),
 181                 and radio buttons (<type scope="com::sun::star::form::component">RadioButton</type>) can be labelled
 182                 by group boxes (<type scope="com::sun::star::form::component">GroupBox</type>) only.
 183             </li>
 184         </ul>
 185         </p>
 186      */
 187     [property] com::sun::star::beans::XPropertySet LabelControl;
 188
 189 };
 190
 191 //=============================================================================
 192
 193 }; }; }; };
 194
 195 #endif