LibreOffice
LibreOffice 7.4 SDK API Reference
XFormOperations.idl
Go to the documentation of this file.
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 #ifndef __com_sun_star_form_runtime_XFormOperations_idl__
21 #define __com_sun_star_form_runtime_XFormOperations_idl__
22 
31 
32 
33 module com { module sun { module star { module form { module runtime {
34 
35 interface XFeatureInvalidation;
36 
37 
72 {
75  [attribute, readonly] ::com::sun::star::sdbc::XRowSet Cursor;
76 
80 
89 
105  [in] short Feature
106  );
107 
118  boolean isEnabled(
119  [in] short Feature
120  );
121 
141  void execute(
142  [in] short Feature
143  )
147  );
148 
173  [in] short Feature,
174  [in] sequence< ::com::sun::star::beans::NamedValue > Arguments
175  )
179  );
180 
195  [out] boolean RecordInserted
196  )
198 
205  )
206  raises ( ::com::sun::star::sdbc::SQLException );
207 
216  boolean isInsertionRow(
217  )
218  raises ( ::com::sun::star::lang::WrappedTargetException );
219 
228  boolean isModifiedRow(
229  )
230  raises ( ::com::sun::star::lang::WrappedTargetException );
231 
248  [attribute] XFeatureInvalidation FeatureInvalidation;
249 };
250 
251 
252 }; }; }; }; };
253 
254 
255 #endif
256 
257 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:38
is an exception that provides information on a database access error.
Definition: SQLException.idl:45
implements a callback for a XFormOperations instance, which is called when the state of one or more F...
Definition: XFeatureInvalidation.idl:37
specifies a component controlling the interaction between the user and form functionality.
Definition: XFormController.idl:244
encapsulates operations on a database form.
Definition: XFormOperations.idl:72
FeatureState getState([in] short Feature)
retrieves the current state of the given feature
::com::sun::star::sdbc::XRowSet Cursor
provides access to the cursor of the form the instance is operating on.
Definition: XFormOperations.idl:75
::com::sun::star::sdbc::XResultSetUpdate UpdateCursor
provides access to the update cursor of the form the instance is operating on.
Definition: XFormOperations.idl:79
boolean isEnabled([in] short Feature)
determines whether a feature is currently enabled.
void execute([in] short Feature)
executes the operation associated with the given feature
boolean commitCurrentRecord([out] boolean RecordInserted)
commits the current record of the form
::com::sun::star::form::runtime::XFormController Controller
provides access to the form controller which the instance is operating on.
Definition: XFormOperations.idl:88
boolean commitCurrentControl()
commits the current control of our controller
void executeWithArguments([in] short Feature, [in] sequence< ::com::sun::star::beans::NamedValue > Arguments)
executes the operation associated with the given feature, with passing arguments for execution
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:43
provides the possibility to write changes made on a result set back to database.
Definition: XResultSetUpdate.idl:33
enhances the functionality of a result set.
Definition: XRowSet.idl:43
Definition: Ambiguous.idl:22
encapsulates the state of a FormFeature
Definition: FeatureState.idl:33