offapi/com/sun/star/form/runtime/FormFeature.idl

   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
  21 module com { module sun { module star { module form { module runtime {
  22
  23
  24 /** specifies the operations on a user interface form, as supported by the
  25     XFormOperations interface.
  26
  27     @since OOo 2.2
  28 */
  29 constants FormFeature
  30 {
  31     /** moves the form to a record given by absolute position.
  32
  33         <p>This operation cannot be executed without arguments. When executing it (i.e.
  34         when calling com::sun::star::form::runtime::XFormOperations::executeWithArguments()),
  35         you need to specify a parameter named <em>Position</em> of type <code>long</code>, which
  36         denotes the position to move the form to.</p>
  37     */
  38     const short MoveAbsolute        = 1;
  39
  40     /** determines the number of total records in the form,
  41         including the potentially active insertion row.
  42
  43         <p>This is not strictly an operation you can do on a form, but rather a
  44         state you can retrieve (and display to the user) using the XFormOperations's
  45         respective methods.</p>
  46
  47         <p>The state obtained here is a string, not a number. This is because in an UI
  48         form, the fact that the current record count is not yet known (since not all
  49         records have been visited, yet) is indicated by an asterisk (<code>*</code>) besides
  50         the record count.</p>
  51     */
  52     const short TotalRecords        = 2;
  53
  54     /// moves the form to the first record
  55     const short MoveToFirst         = 3;
  56
  57     /// moves the form to the record before the current record, if there is any
  58     const short MoveToPrevious      = 4;
  59
  60     /// moves the form to the record after the current record, if there is any
  61     const short MoveToNext          = 5;
  62
  63     /// moves the form to the last record
  64     const short MoveToLast          = 6;
  65
  66     /// moves the form to the insertion row, if privileges allow
  67     const short MoveToInsertRow     = 7;
  68
  69     /** saves all changes in the form's current record, including changes in the current
  70         control which had not yet been committed to the form
  71     */
  72     const short SaveRecordChanges   = 8;
  73
  74     /** reverts all changes in the form's current record, including changes in the current
  75         control which had not yet been committed to the form
  76     */
  77     const short UndoRecordChanges   = 9;
  78
  79     /** deletes the current record, while honoring any registered
  80         com::sun::star::form::XConfirmDeleteListeners
  81     */
  82     const short DeleteRecord        = 10;
  83
  84     /// reloads the form content
  85     const short ReloadForm          = 11;
  86
  87     /// sorts the form ascending by the field which the active form control is bound to.
  88     const short SortAscending       = 12;
  89
  90     /// sorts the form descending by the field which the active form control is bound to.
  91     const short SortDescending      = 13;
  92
  93     /// opens a dialog which allows the user to interactively specify a form sorting order
  94     const short InteractiveSort     = 14;
  95
  96     /** adds a filter to the form, which is defined by the active form control and its
  97         current value
  98
  99         <p>For instance, if the currently active form control is bound to a table field
 100         named <code>Price</code>, and currently has a value of <code>100</code>, then invoking
 101         the <code>AutoFilter</code> operation will put an additional filter <code>Price = 100</code>
 102         on the form.</p>
 103     */
 104     const short AutoFilter          = 15;
 105
 106     /// opens a dialog which allows the user to interactively specify a form filter
 107     const short InteractiveFilter   = 16;
 108
 109     /** toggles the com::sun::star::sdb::RowSet::ApplyFilter property
 110         of the form.
 111     */
 112     const short ToggleApplyFilter   = 17;
 113
 114     /** removes all filter and sort criteria put on the form.
 115
 116         <p>Note that this does not apply to criteria which are part of the form's
 117         data source. That is, if you bind the form to the SQL command <code>SELECT * FROM
 118         Articles WHERE Price &gt; 100</code>, then the <code>Price &gt; 100</code> filter
 119         will not be removed.</p>
 120
 121         <p>Effectively, this operation resets the com::sun::star::sdb::RowSet::Filter
 122         and com::sun::star::sdb::RowSet::Order properties of the form.</p>
 123     */
 124     const short RemoveFilterAndSort = 18;
 125
 126     /** refreshes the current control
 127
 128         <p>Basically, this means calling XRefreshable::refresh on the current control, if it supports
 129         this interface.</p>
 130
 131         @since OOo 3.1
 132     */
 133     const short RefreshCurrentControl = 19;
 134 };
 135
 136
 137 }; }; }; }; };
 138
 139
 140 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */