summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/component/Form.idl
blob: ab177f6c9575014570232ed78f8f1a12f0fc0a4a (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_component_Form_idl__
#define __com_sun_star_form_component_Form_idl__

#include <com/sun/star/form/FormComponent.idl>
#include <com/sun/star/form/FormComponents.idl>
#include <com/sun/star/form/XForm.idl>
#include <com/sun/star/awt/XTabControllerModel.idl>
#include <com/sun/star/script/XEventAttacherManager.idl>


//=============================================================================

 module com {  module sun {  module star {  module form {  module component {

//=============================================================================

/** This service specifies a form which is a group of FormComponents.

    <p>A form fulfills several tasks, like storing the structure of its
    form components, storing the information concerning tab ordering
    and control grouping, and last but not least, it provides the
    event environment for its contained elements.</p>

    <p>A form acts on the one hand like a container of FormComponents
    and on the other hand like a FormComponent. This generic
    construction allows the definition of hierarchies of forms and their
    dependent subforms.</p>

    @see com::sun::star::form::FormControlModel
 */
published service Form
{
    service com::sun::star::form::FormComponent;

    service com::sun::star::form::FormComponents;

    /** identifies a component as form.
     */
    interface com::sun::star::form::XForm;


    /** This interface has to be implemented to supply the information for tab ordering and component grouping.

        @see com::sun::star::form::FormControlModel::TabIndex
     */
    interface com::sun::star::awt::XTabControllerModel;
};

//=============================================================================

}; }; }; }; };

#endif

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