LibreOffice LibreOffice 25.8 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
21module com { module sun { module star { module form { module runtime {
22
23 interface XFeatureInvalidation;
24
25
59 interface XFormOperations : ::com::sun::star::lang::XComponent
60{
63 [attribute, readonly] ::com::sun::star::sdbc::XRowSet Cursor;
64
67 [attribute, readonly] ::com::sun::star::sdbc::XResultSetUpdate UpdateCursor;
68
76 [attribute, readonly] ::com::sun::star::form::runtime::XFormController Controller;
77
92 FeatureState getState(
93 [in] short Feature
94 );
95
106 boolean isEnabled(
107 [in] short Feature
108 );
109
129 void execute(
130 [in] short Feature
131 )
132 raises ( ::com::sun::star::lang::IllegalArgumentException
133 , ::com::sun::star::sdbc::SQLException
134 , ::com::sun::star::lang::WrappedTargetException
135 );
136
160 void executeWithArguments(
161 [in] short Feature,
162 [in] sequence< ::com::sun::star::beans::NamedValue > Arguments
163 )
164 raises ( ::com::sun::star::lang::IllegalArgumentException
165 , ::com::sun::star::sdbc::SQLException
166 , ::com::sun::star::lang::WrappedTargetException
167 );
168
182 boolean commitCurrentRecord(
183 [out] boolean RecordInserted
184 )
185 raises ( ::com::sun::star::sdbc::SQLException );
186
192 boolean commitCurrentControl(
193 )
194 raises ( ::com::sun::star::sdbc::SQLException );
195
204 boolean isInsertionRow(
205 )
206 raises ( ::com::sun::star::lang::WrappedTargetException );
207
216 boolean isModifiedRow(
217 )
218 raises ( ::com::sun::star::lang::WrappedTargetException );
219
236 [attribute] XFeatureInvalidation FeatureInvalidation;
237};
238
239
240}; }; }; }; };
241
242
243/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::lang::WrappedTargetException
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:34
com::sun::star::sdbc::SQLException
is an exception that provides information on a database access error.
Definition: SQLException.idl:41
com::sun::star::form::runtime::XFeatureInvalidation
implements a callback for a XFormOperations instance, which is called when the state of one or more F...
Definition: XFeatureInvalidation.idl:32
com::sun::star::form::runtime::XFormController
specifies a component controlling the interaction between the user and form functionality.
Definition: XFormController.idl:225
com::sun::star::form::runtime::XFormOperations
encapsulates operations on a database form.
Definition: XFormOperations.idl:60
com::sun::star::form::runtime::XFormOperations::getState
FeatureState getState([in] short Feature)
retrieves the current state of the given feature
com::sun::star::form::runtime::XFormOperations::Cursor
::com::sun::star::sdbc::XRowSet Cursor
provides access to the cursor of the form the instance is operating on.
Definition: XFormOperations.idl:63
com::sun::star::form::runtime::XFormOperations::UpdateCursor
::com::sun::star::sdbc::XResultSetUpdate UpdateCursor
provides access to the update cursor of the form the instance is operating on.
Definition: XFormOperations.idl:67
com::sun::star::form::runtime::XFormOperations::isEnabled
boolean isEnabled([in] short Feature)
determines whether a feature is currently enabled.
com::sun::star::form::runtime::XFormOperations::execute
void execute([in] short Feature)
executes the operation associated with the given feature
com::sun::star::form::runtime::XFormOperations::commitCurrentRecord
boolean commitCurrentRecord([out] boolean RecordInserted)
commits the current record of the form
com::sun::star::form::runtime::XFormOperations::Controller
::com::sun::star::form::runtime::XFormController Controller
provides access to the form controller which the instance is operating on.
Definition: XFormOperations.idl:76
com::sun::star::form::runtime::XFormOperations::commitCurrentControl
boolean commitCurrentControl()
commits the current control of our controller
com::sun::star::form::runtime::XFormOperations::executeWithArguments
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
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:39
com::sun::star::sdbc::XResultSetUpdate
provides the possibility to write changes made on a result set back to database.
Definition: XResultSetUpdate.idl:27
com::sun::star::sdbc::XRowSet
enhances the functionality of a result set.
Definition: XRowSet.idl:39
com
Definition: Ambiguous.idl:20
com::sun::star::form::runtime::FeatureState
encapsulates the state of a FormFeature
Definition: FeatureState.idl:31