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