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_DefaultFormComponentInspectorModel_idl__
24#define __com_sun_star_form_DefaultFormComponentInspectorModel_idl__
25
26#ifndef __com_sun_star_inspection_XObjectInspectorModel_idl__
27#include <com/sun/star/inspection/XObjectInspectorModel.idl>
28#endif
29#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
30#include <com/sun/star/lang/IllegalArgumentException.idl>
31#endif
32
33//=============================================================================
34
35module com {  module sun {  module star {  module form { module inspection {
36
37//=============================================================================
38
39/** implements a <type scope="com::sun::star::inspection">XObjectInspectorModel</type> for
40    inspecting form components, in particular all components implementing the <type>FormComponent</type>
41    service.
42
43    <p>A <type>DefaultFormComponentInspectorModel</type> provides the following handlers by default:
44	<ul><li><type>ButtonNavigationHandler</type></li>
45	    <li><type>CellBindingPropertyHandler</type></li>
46	    <li><type>EditPropertyHandler</type></li>
47        <li><type>EventHandler</type></li>
48	    <li><type>FormComponentPropertyHandler</type></li>
49        <li><type>SubmissionPropertyHandler</type></li>
50	    <li><type>XMLFormsPropertyHandler</type></li>
51	    <li><type>XSDValidationPropertyHandler</type></li>
52    </ul></p>
53
54    @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories
55*/
56service DefaultFormComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel
57{
58    /** creates a default DefaultFormComponentInspectorModel, providing factories for all
59        handlers listed above.
60
61        @since OpenOffice 2.2
62    */
63    createDefault();
64
65    /** creates a default DefaultFormComponentInspectorModel, providing factories for all
66        handlers listed above, and describing an ObjectInspector which has a help section.
67
68        @param minHelpTextLines
69            denotes the minimum number of lines of text to be reserved for the help
70            section.
71
72        @param maxHelpTextLines
73            denotes the maximum number of lines of text to be reserved for the help
74            section.
75
76        @throws ::com::sun::star::lang::IllegalArgumentException
77            if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative,
78            or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>.
79
80        @see XObjectInspectorModel::HasHelpSection
81        @see XObjectInspectorModel::MinHelpTextLines
82        @see XObjectInspectorModel::MaxHelpTextLines
83
84        @since OpenOffice 2.2
85    */
86    createWithHelpSection(
87        [in] long minHelpTextLines,
88        [in] long maxHelpTextLines
89    )
90        raises ( ::com::sun::star::lang::IllegalArgumentException );
91};
92
93//=============================================================================
94
95}; }; }; }; };
96
97#endif
98