summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/runtime/FormOperations.idl
blob: c9390ac259182a1debfc08ea0ad3d04166a3e49e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: FormOperations.idl,v $
 * $Revision: 1.4 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#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.0
 */
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