offapi/com/sun/star/form/XBoundComponent.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 /** specifies a (form) component which is bound to a data source.
  26
  27     <p>The interface provides the possibility of committing its respective
  28     data to a data source it is bound to. A commit() will be
  29     performed by the environment (usually, a FormController).<br/>
  30     For example, suppose you have a data-bound control that is connected
  31     to a database field. Each time the control loses its focus, the
  32     model (component) of the control is triggered by the environment
  33     to store its value in the database field.</p>
  34
  35     <p>A commit may fail if an XUpdateListener vetoes the it.</p>
  36
  37     @see com::sun::star::form::XUpdateListener
  38  */
  39 published interface XBoundComponent: com::sun::star::form::XUpdateBroadcaster
  40 {
  41
  42     /** commits the content of the component into the data source it is bound to.
  43
  44         @returns
  45             `TRUE` when the commitment was successful, otherwise `FALSE`.
  46      */
  47     boolean commit();
  48
  49 };
  50
  51
  52 }; }; }; };
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */