/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at
http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at
http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module form {
/** specifies a (form) component which is bound to a data source.
<p>The interface provides the possibility of committing its respective
data to a data source it is bound to. A commit() will be
performed by the environment (usually, a FormController).<br/>
For example, suppose you have a data-bound control that is connected
to a database field. Each time the control loses its focus, the
model (component) of the control is triggered by the environment
to store its value in the database field.</p>
<p>A commit may fail if an XUpdateListener vetoes the it.</p>
@see com::sun::star::form::XUpdateListener
*/
published interface XBoundComponent: com::sun::star::form::XUpdateBroadcaster
{
/** commits the content of the component into the data source it is bound to.
@returns
`TRUE` when the commitment was successful, otherwise `FALSE`.
*/
boolean commit();
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
