/* -*- 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 . */ #ifndef __com_sun_star_form_runtime_FormFeature_idl__ #define __com_sun_star_form_runtime_FormFeature_idl__ module com { module sun { module star { module form { module runtime { /** specifies the operations on a user interface form, as supported by the XFormOperations interface. @since OOo 2.2 */ constants FormFeature { /** moves the form to a record given by absolute position.
This operation cannot be executed without arguments. When executing it (i.e.
when calling com::sun::star::form::runtime::XFormOperations::executeWithArguments()),
you need to specify a parameter named Position of type long
, which
denotes the position to move the form to.
This is not strictly an operation you can do on a form, but rather a state you can retrieve (and display to the user) using the XFormOperations's respective methods.
The state obtained here is a string, not a number. This is because in an UI
form, the fact that the current record count is not yet known (since not all
records have been visited, yet) is indicated by an asterisk (*
) besides
the record count.
For instance, if the currently active form control is bound to a table field
named Price
, and currently has a value of 100
, then invoking
the AutoFilter
operation will put an additional filter Price = 100
on the form.
Note that this does not apply to criteria which are part of the form's
data source. That is, if you bind the form to the SQL command SELECT * FROM
Articles WHERE Price > 100
, then the Price > 100
filter
will not be removed.
Effectively, this operation resets the com::sun::star::sdb::RowSet::Filter and com::sun::star::sdb::RowSet::Order properties of the form.
*/ const short RemoveFilterAndSort = 18; /** refreshes the current controlBasically, this means calling XRefreshable::refresh on the current control, if it supports this interface.
@since OOo 3.1 */ const short RefreshCurrentControl = 19; }; }; }; }; }; }; #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */