summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/component/Form.idl
blob: ca13d49dc05959777e6b54325144c5b7f68bbdc7 (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_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: */