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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: FormFeature.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_runtime_FormFeature_idl__
  32 #define __com_sun_star_form_runtime_FormFeature_idl__
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module form { module runtime {
  37
  38 //=============================================================================
  39
  40 /** specifies the operations on a user interface form, as supported by the
  41     <type>XFormOperations</type> interface.
  42
  43     @since OpenOffice.org 2.2.0
  44 */
  45 constants FormFeature
  46 {
  47     /** moves the form to a record given by absolute position.
  48
  49         <p>This operation cannot be executed without arguments. When executing it (i.e.
  50         when calling <member scope="com::sun::star::form::runtime">XFormOperations::executeWithArguments</member>),
  51         you need to specify a parameter named <em>Position</em> of type <code>long</code>, which
  52         denotes the position to move the form to.</p>
  53     */
  54     const short MoveAbsolute        = 1;
  55
  56     /** determines the number of total records in the form,
  57         including the potentially active insertion row.
  58
  59         <p>This is not strictly an operation you can do on a form, but rather a
  60         state you can retrieve (and display to the user) using the <type>XFormOperations</type>'
  61         respective methods.</p>
  62
  63         <p>The state obtained here is a string, not a number. This is because in an UI
  64         form, the fact that the current record count is not yet known (since not all
  65         records have been visited, yet) is indicated by an asterik (<code>*</code>) besides
  66         the record count.</p>
  67     */
  68     const short TotalRecords        = 2;
  69
  70     /// moves the form to the first record
  71     const short MoveToFirst         = 3;
  72
  73     /// moves the form to the record before the current record, if there is any
  74     const short MoveToPrevious      = 4;
  75
  76     /// moves the form to the record after the current record, if there is any
  77     const short MoveToNext          = 5;
  78
  79     /// moves the form to the last record
  80     const short MoveToLast          = 6;
  81
  82     /// moves the form to the insertion row, if privileges allow
  83     const short MoveToInsertRow     = 7;
  84
  85     /** saves all changes in the form's current record, including changes in the current
  86         control which had not yet been committed to the form
  87     */
  88     const short SaveRecordChanges   = 8;
  89
  90     /** revertsall changes in the form's current record, including changes in the current
  91         control which had not yet been committed to the form
  92     */
  93     const short UndoRecordChanges   = 9;
  94
  95     /** deletes the current record, while honoring any registered
  96         <type scope="com::sun::star::form">XConfirmDeleteListener</type>s
  97     */
  98     const short DeleteRecord        = 10;
  99
 100     /// reloads the form content
 101     const short ReloadForm          = 11;
 102
 103     /// sorts the form ascending by the field which the active form control is bound to.
 104     const short SortAscending       = 12;
 105
 106     /// sorts the form descending by the field which the active form control is bound to.
 107     const short SortDescending      = 13;
 108
 109     /// opens a dialog which allows the user to interactively specify a form sorting order
 110     const short InteractiveSort     = 14;
 111
 112     /** adds a filter to the form, which is defined by the active form control and its
 113         current value
 114
 115         <p>For instance, if the currently active form control is bound to a table field
 116         named <code>Price</code>, and currently has a value of <code>100</code>, then invoking
 117         the <code>AutoFilter</code> operation will put an additional filter <code>Price = 100</code>
 118         on the form.</p>
 119     */
 120     const short AutoFilter          = 15;
 121
 122     /// opens a dialog which allows the user to interactively specify a form filter
 123     const short InteractiveFilter   = 16;
 124
 125     /** toggles the <member scope="com::sun::star::sdb">RowSet::ApplyFilter</member> property
 126         of a the form.
 127     */
 128     const short ToggleApplyFilter   = 17;
 129
 130     /** removes all filter and sort criterions put on the form.
 131
 132         <p>Note that this does not apply to criterios which are part of the form's
 133         data source. That is, if you bind the form to the SQL command <code>SELECT * FROM
 134         Articles WHERE Price &gt; 100</code>, then the <code>Price &gt; 100</code> filter
 135         will not be removed.</p>
 136
 137         <p>Effectively, this operation resets the <member scope="com::sun::star::sdb">RowSet::Filter</member>
 138         and <member scope="com::sun::star::sdb">RowSet::Order</member> properties of the form.</p>
 139     */
 140     const short RemoveFilterAndSort = 18;
 141
 142     /** refreshs the current control
 143
 144         <p>Basically, this means calling XRefreshable::refresh on the current control, if it supports
 145         this interface.</p>
 146
 147         @since OOo 3.1
 148     */
 149     const short RefreshCurrentControl = 19;
 150 };
 151
 152 //=============================================================================
 153
 154 }; }; }; }; };
 155
 156 //=============================================================================
 157
 158 #endif