xref: /AOO41X/main/offapi/com/sun/star/form/component/Form.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_form_component_Form_idl__
28#define __com_sun_star_form_component_Form_idl__
29
30#ifndef __com_sun_star_form_FormComponent_idl__
31#include <com/sun/star/form/FormComponent.idl>
32#endif
33
34#ifndef __com_sun_star_form_FormComponents_idl__
35#include <com/sun/star/form/FormComponents.idl>
36#endif
37
38#ifndef __com_sun_star_form_XForm_idl__
39#include <com/sun/star/form/XForm.idl>
40#endif
41
42#ifndef __com_sun_star_awt_XTabControllerModel_idl__
43#include <com/sun/star/awt/XTabControllerModel.idl>
44#endif
45
46#ifndef __com_sun_star_script_XEventAttacherManager_idl__
47#include <com/sun/star/script/XEventAttacherManager.idl>
48#endif
49
50
51//=============================================================================
52
53 module com {  module sun {  module star {  module form {  module component {
54
55//=============================================================================
56
57/** This service specifies a form which is a group of FormComponents.
58
59	<p>A form fulfills several tasks, like storing the structure of its
60	form components, storing the information concerning tab ordering
61	and control grouping, and last but not least, it provides the
62	event environment for its contained elements.</p>
63
64	<p>A form acts on the one hand like a container of FormComponents
65	and on the other hand like a FormComponent. This generic
66	construction allows the definition of hierarchies of forms and their
67	dependent subforms.</p>
68
69	@see com::sun::star::form::FormControlModel
70 */
71published service Form
72{
73	service com::sun::star::form::FormComponent;
74
75	service com::sun::star::form::FormComponents;
76
77	/** identifies a component as form.
78	 */
79	interface com::sun::star::form::XForm;
80
81
82	/** This interface has to be implemented to supply the information for tab ordering and component grouping.
83
84		@see com::sun::star::form::FormControlModel::TabIndex
85	 */
86	interface com::sun::star::awt::XTabControllerModel;
87};
88
89//=============================================================================
90
91}; }; }; }; };
92
93#endif
94