xref: /AOO41X/main/offapi/com/sun/star/form/component/Form.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_form_component_Form_idl__
24cdf0e10cSrcweir#define __com_sun_star_form_component_Form_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_form_FormComponent_idl__
27cdf0e10cSrcweir#include <com/sun/star/form/FormComponent.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_form_FormComponents_idl__
31cdf0e10cSrcweir#include <com/sun/star/form/FormComponents.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_form_XForm_idl__
35cdf0e10cSrcweir#include <com/sun/star/form/XForm.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_awt_XTabControllerModel_idl__
39cdf0e10cSrcweir#include <com/sun/star/awt/XTabControllerModel.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir#ifndef __com_sun_star_script_XEventAttacherManager_idl__
43cdf0e10cSrcweir#include <com/sun/star/script/XEventAttacherManager.idl>
44cdf0e10cSrcweir#endif
45cdf0e10cSrcweir
46cdf0e10cSrcweir
47cdf0e10cSrcweir//=============================================================================
48cdf0e10cSrcweir
49cdf0e10cSrcweir module com {  module sun {  module star {  module form {  module component {
50cdf0e10cSrcweir
51cdf0e10cSrcweir//=============================================================================
52cdf0e10cSrcweir
53cdf0e10cSrcweir/** This service specifies a form which is a group of FormComponents.
54cdf0e10cSrcweir
55cdf0e10cSrcweir	<p>A form fulfills several tasks, like storing the structure of its
56cdf0e10cSrcweir	form components, storing the information concerning tab ordering
57cdf0e10cSrcweir	and control grouping, and last but not least, it provides the
58cdf0e10cSrcweir	event environment for its contained elements.</p>
59cdf0e10cSrcweir
60cdf0e10cSrcweir	<p>A form acts on the one hand like a container of FormComponents
61cdf0e10cSrcweir	and on the other hand like a FormComponent. This generic
62cdf0e10cSrcweir	construction allows the definition of hierarchies of forms and their
63cdf0e10cSrcweir	dependent subforms.</p>
64cdf0e10cSrcweir
65cdf0e10cSrcweir	@see com::sun::star::form::FormControlModel
66cdf0e10cSrcweir */
67cdf0e10cSrcweirpublished service Form
68cdf0e10cSrcweir{
69cdf0e10cSrcweir	service com::sun::star::form::FormComponent;
70cdf0e10cSrcweir
71cdf0e10cSrcweir	service com::sun::star::form::FormComponents;
72cdf0e10cSrcweir
73cdf0e10cSrcweir	/** identifies a component as form.
74cdf0e10cSrcweir	 */
75cdf0e10cSrcweir	interface com::sun::star::form::XForm;
76cdf0e10cSrcweir
77cdf0e10cSrcweir
78cdf0e10cSrcweir	/** This interface has to be implemented to supply the information for tab ordering and component grouping.
79cdf0e10cSrcweir
80cdf0e10cSrcweir		@see com::sun::star::form::FormControlModel::TabIndex
81cdf0e10cSrcweir	 */
82cdf0e10cSrcweir	interface com::sun::star::awt::XTabControllerModel;
83cdf0e10cSrcweir};
84cdf0e10cSrcweir
85cdf0e10cSrcweir//=============================================================================
86cdf0e10cSrcweir
87cdf0e10cSrcweir}; }; }; }; };
88cdf0e10cSrcweir
89cdf0e10cSrcweir#endif
90