1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_form_FormControlModel_idl__
24#define __com_sun_star_form_FormControlModel_idl__
25
26#ifndef __com_sun_star_awt_UnoControlModel_idl__
27#include <com/sun/star/awt/UnoControlModel.idl>
28#endif
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_beans_XFastPropertySet_idl__
35#include <com/sun/star/beans/XFastPropertySet.idl>
36#endif
37
38#ifndef __com_sun_star_beans_XPropertyState_idl__
39#include <com/sun/star/beans/XPropertyState.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module form {
46
47//=============================================================================
48
49/** specifies a control model within a form.
50
51	<p>Note that the model-view-paradigm is used for form controls, too.</p>
52 */
53published service FormControlModel
54{
55	service com::sun::star::awt::UnoControlModel;
56
57	service com::sun::star::form::FormComponent;
58
59	/** This optional interface gives an efficient access to all
60				properties at once or an ability to set more than one property at once.
61	 */
62	[optional] interface com::sun::star::beans::XFastPropertySet;
63
64
65	/** This optional interface gives access to the state of the
66				properties, e.g. whether a default value
67				is to be used or not for a certain property.
68	 */
69	[optional] interface com::sun::star::beans::XPropertyState;
70
71	//-------------------------------------------------------------------------
72
73	/** specifies the ID for classification of the component.
74		@see FormComponentType
75	 */
76	[readonly, property] short ClassId;
77
78	//-------------------------------------------------------------------------
79
80	/** determines the relative taborder of the control associated with the model.
81
82		<p>The default -1 is used to indicate that the tab-order of this control should be
83		determined automatically.</p>
84
85		<p>Each component which supports a tabstop must provide a
86		<member>FormControlModel::TabIndex</member> property.</p>
87
88		<p>Normally, a <type>FormController</type> instance is evaluating this property.</p>
89	 */
90	[optional, property] short TabIndex;
91
92	//-------------------------------------------------------------------------
93
94	/** used for additional information.
95		<p>No semantics is given for this property, it will usually be used by the creator of a document
96		containing form controls.</p>
97	 */
98	[property] string Tag;
99
100};
101
102//=============================================================================
103
104}; }; }; };
105
106#endif
107