/* -*- 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 { module runtime { interface XFeatureInvalidation; /** encapsulates operations on a database form.
This instance allows for operations on a user interface form, by saving its clients from various tedious and error-prone operations.
As an example, imagine you have a database form, displayed in some user
interface, which you want to move to the next record.
It is as easy as calling com::sun::star::sdbc::XResultSet::next()
on this form, right? Wrong. First, you need to care for saving the current
record, so the user doesn't lose her input. So you need to call
com::sun::star::sdbc::XResultSetUpdate::updateRow() or
com::sun::star::sdbc::XResultSetUpdate::insertRow(), depending
on the form's com::sun::star::sdb::RowSet::IsNew property.
But then you're done, right? Wrong, again.
When the user just entered some data into one of the form fields, but did not yet
leave this field, then the data is not yet committed to the form, not to talk
about being committed to the underlying database. So, before everything else,
you would need to obtain the active control of the form, and commit it.
Now you're done ...
As another example, consider that you want to delete the current record from the form. You have to take into account any com::sun::star::form::XConfirmDeleteListeners registered at the com::sun::star::form::FormController or the com::sun::star::form::component::DataForm.
If you agree that this is ugly to do and maintain, then XFormOperations
is for you. It provides an execute() method, which will do all of the above
for you; plus some similar convenient wrappers for similar functionality.
Note that it is possible to operate on a user interface form without actually having access to the form controller instance. However, in this case some functionality will not be available. In particular, every feature which relies on the active control of the controller might be of limited use.
*/ [attribute, readonly] ::com::sun::star::form::runtime::XFormController Controller; /** retrieves the current state of the given featureYou would usually use this to update some user interface to reflect this state.
For instance, you could imagine a toolbar button which is associated with a given feature.
This button would be enabled if and only if the respective feature is currently
available, and be checked if and only if the feature state is a boolean
evaluating to `TRUE`.
@param Feature
the feature whose state is to be determined. Must be one of the FormFeature
constants.
An invalid value here will be silently ignored, and simply return a FeatureState
indicating disabled with a `NULL` state.
Calling this is equivalent to calling getState(), and evaluating the FeatureState::Enabled member.
@param Feature the feature whose state is to be determined. Must be one of the FormFeature constants.This is a convenience method only. Calling it is equivalent to examining the com::sun::star::sdb::RowSet::IsNew property of the form.
@throws ::com::sun::star::lang::WrappedTargetException if an error occurs obtaining the form property */ boolean isInsertionRow( ) raises ( ::com::sun::star::lang::WrappedTargetException ); /** determines whether the current row of the form is modifiedThis is a convenience method only. Calling it is equivalent to examining the com::sun::star::sdb::RowSet::IsModified property of the form.
@throws ::com::sun::star::lang::WrappedTargetException if an error occurs obtaining the form property */ boolean isModifiedRow( ) raises ( ::com::sun::star::lang::WrappedTargetException ); /** denotes the instance which should be notified about features whose state might have changed.If this attribute is not `NULL`, the instance which it denotes will be notified whenever the state of any supported feature might have changed.
For instance, imagine a form whose current row has just been moved to another record, using the execute() method. This means that potentially, the state of all movement-related features might have changed.
Note that the instance does not actually notify changes in the feature states, but only potential changes: It's up to the callee to react on this appropriately. This is since OpenOffice.org's application framework features own mechanisms to cache and invalidate feature states, so we do not burden this implementation here with such mechanisms.
@see FormFeature */ [attribute] XFeatureInvalidation FeatureInvalidation; }; }; }; }; }; }; /* vim:set shiftwidth=4 softtabstop=4 expandtab: */