INTEGRATION: CWS dba22a (1.1.2); FILE ADDED

2006/11/22 15:00:48 fs 1.1.2.1: #i71860#

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

+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: FormFeature.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2006-12-01 17:05:50 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#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
+    <type>XFormOperations</type> interface.
+
+    @since OpenOffice.org 2.2
+*/
+constants FormFeature
+{
+    /** moves the form to a record given by absolute position.
+
+        <p>This operation cannot be executed without arguments. When executing it (i.e.
+        when calling <member scope="com::sun::star::form::runtime">XFormOperations::executeWithArguments</member>),
+        you need to specify a parameter named <em>Position</em> of type <code>long</code>, which
+        denotes the position to move the form to.</p>
+    */
+    const short MoveAbsolute        = 1;
+
+    /** determines the number of total records in the form,
+        including the potentially active insertion row.
+
+        <p>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 <type>XFormOperations</type>'
+        respective methods.</p>
+
+        <p>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 asterik (<code>*</code>) besides
+        the record count.</p>
+    */
+    const short TotalRecords        = 2;
+
+    /// moves the form to the first record
+    const short MoveToFirst         = 3;
+
+    /// moves the form to the record before the current record, if there is any
+    const short MoveToPrevious      = 4;
+
+    /// moves the form to the record after the current record, if there is any
+    const short MoveToNext          = 5;
+
+    /// moves the form to the last record
+    const short MoveToLast          = 6;
+
+    /// moves the form to the insertion row, if privileges allow
+    const short MoveToInsertRow     = 7;
+
+    /** saves all changes in the form's current record, including changes in the current
+        control which had not yet been committed to the form
+    */
+    const short SaveRecordChanges   = 8;
+
+    /** revertsall changes in the form's current record, including changes in the current
+        control which had not yet been committed to the form
+    */
+    const short UndoRecordChanges   = 9;
+
+    /** deletes the current record, while honoring any registered
+        <type scope="com::sun::star::form">XConfirmDeleteListener</type>s
+    */
+    const short DeleteRecord        = 10;
+
+    /// reloads the form content
+    const short ReloadForm          = 11;
+
+    /// sorts the form ascending by the field which the active form control is bound to.
+    const short SortAscending       = 12;
+
+    /// sorts the form descending by the field which the active form control is bound to.
+    const short SortDescending      = 13;
+
+    /// opens a dialog which allows the user to interactively specify a form sorting order
+    const short InteractiveSort     = 14;
+
+    /** adds a filter to the form, which is defined by the active form control and its
+        current value
+
+        <p>For instance, if the currently active form control is bound to a table field
+        named <code>Price</code>, and currently has a value of <code>100</code>, then invoking
+        the <code>AutoFilter</code> operation will put an additional filter <code>Price = 100</code>
+        on the form.</p>
+    */
+    const short AutoFilter          = 15;
+
+    /// opens a dialog which allows the user to interactively specify a form filter
+    const short InteractiveFilter   = 16;
+
+    /** toggles the <member scope="com::sun::star::sdb">RowSet::ApplyFilter</member> property
+        of a the form.
+    */
+    const short ToggleApplyFilter   = 17;
+
+    /** removes all filter and sort criterions put on the form.
+
+        <p>Note that this does not apply to criterios which are part of the form's
+        data source. That is, if you bind the form to the SQL command <code>SELECT * FROM
+        Articles WHERE Price &gt; 100</code>, then the <code>Price &gt; 100</code> filter
+        will not be removed.</p>
+
+        <p>Effectively, this operation resets the <member scope="com::sun::star::sdb">RowSet::Filter</member>
+        and <member scope="com::sun::star::sdb">RowSet::Order</member> properties of the form.</p>
+    */
+    const short RemoveFilterAndSort = 18;
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+//=============================================================================
+
+#endif

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

+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: FormOperations.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2006-12-01 17:06:00 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_form_runtime_FormOperations_idl__
+#define __com_sun_star_form_runtime_FormOperations_idl__
+
+#ifndef __com_sun_star_form_runtime_XFormOperations_idl__
+#include <com/sun/star/form/runtime/XFormOperations.idl>
+#endif
+#ifndef __com_sun_star_form_XFormController_idl__
+#include <com/sun/star/form/XFormController.idl>
+#endif
+#ifndef __com_sun_star_form_XForm_idl__
+#include <com/sun/star/form/XForm.idl>
+#endif
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module form { module runtime {
+
+//=============================================================================
+
+/** encapsulates operations on a database form which has a UI representation,
+    and is interacting with the user.
+
+    @since OpenOffice.org 2.2
+ */
+service FormOperations : XFormOperations
+{
+    /** creates a <code>FormOperations</code> instance which works on a <type scope="com::sun::star::form">FormController</type>
+        instance.
+        @throws IllegalArgumentException
+            if the given form controller is <NULL/>, or does not have a model denoting a valid
+            <type scope="com::sun::star::form::component">DataForm</type> instance.
+    */
+    createWithFormController(
+        [in] XFormController Controller
+    )
+    raises(
+        ::com::sun::star::lang::IllegalArgumentException
+    );
+
+    /** creates a <code>FormOperations</code> instance which works on a <type scope="com::sun::star::form::component">DataForm</type>
+        instance.
+
+        @throws IllegalArgumentException
+            if the given form is <NULL/>, or does not support the <type scope="com::sun::star::form::component">DataForm</type>
+            service.
+    */
+    createWithForm(
+        [in] XForm Form
+    )
+    raises(
+        ::com::sun::star::lang::IllegalArgumentException
+    );
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+//=============================================================================
+
+#endif

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

+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XFeatureInvalidation.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2006-12-01 17:06:10 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_form_runtime_XFeatureInvalidation_idl__
+#define __com_sun_star_form_runtime_XFeatureInvalidation_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module form { module runtime {
+
+//=============================================================================
+
+/** implements a callback for a <type>XFormOperations</type> instance, which is called
+    when the state of one or more <type>FormFeature</type>s might have changed.
+
+    @see XFormOperations
+
+    @since OpenOffice.org 2.2
+*/
+interface XFeatureInvalidation
+{
+    /** invalidates the given <type>FormFeature</type>s
+
+        <p>Invalidation means that any user interface representation (such as toolbox buttons), or
+        any dispatches associated with the features in question are potentially out-of-date, and
+        need to be updated.</p>
+
+        @param Features
+            The set of features whose state might have changed.
+    */
+    void    invalidateFeatures( [in] sequence< short > Features );
+
+    /** invalidates all features
+
+        <p>This method is used of it cannot be exactly and reliably determined
+        which features might actually have changed their state. In this case, the callee
+        should assume all features it is interested in must be requeried.</p>
+    */
+    void    invalidateAllFeatures();
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+//=============================================================================
+
+#endif