summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/form/runtime/FormOperations.idl
blob: 032042d4b08af63177ae6ab54fd14737bc93b0cc (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
/* -*- 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_FormOperations_idl__
#define __com_sun_star_form_runtime_FormOperations_idl__

#include <com/sun/star/form/runtime/XFormOperations.idl>
#include <com/sun/star/form/runtime/XFormController.idl>
#include <com/sun/star/form/XForm.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>


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 OOo 2.2
 */
service FormOperations : XFormOperations
{
    /** creates a <code>FormOperations</code> instance which works on a com::sun::star::form::FormController
        instance.
        @throws IllegalArgumentException
            if the given form controller is `NULL`, or does not have a model denoting a valid
            com::sun::star::form::component::DataForm instance.
    */
    createWithFormController(
        [in] XFormController Controller
    )
    raises(
        ::com::sun::star::lang::IllegalArgumentException
    );

    /** creates a <code>FormOperations</code> instance which works on a com::sun::star::form::component::DataForm
        instance.

        @throws IllegalArgumentException
            if the given form is `NULL`, or does not support the com::sun::star::form::component::DataForm
            service.
    */
    createWithForm(
        [in] XForm Form
    )
    raises(
        ::com::sun::star::lang::IllegalArgumentException
    );
};


}; }; }; }; };


#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */