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_report_inspection__DefaultComponentInspectorModel_idl__
24#define __com_sun_star_report_inspection_DefaultComponentInspectorModel_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 report { 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>ReportComponent</type>
41    service.
42
43    <p>A <type>DefaultComponentInspectorModel</type> provides the following handlers by default:
44    <ul><li><type>GeometryHandler</type></li>
45        <li><type>ReportComponentHandler</type></li>
46        <li><typescope="com::sun::star::form::inspection">EditPropertyHandler</type></li>
47    </ul></p>
48
49    @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories
50*/
51published service DefaultComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel
52{
53    /** creates a default DefaultComponentInspectorModel, providing factories for all
54        handlers listed above.
55
56        @since OpenOffice 2.2
57    */
58    createDefault();
59
60    /** creates a default DefaultComponentInspectorModel, providing factories for all
61        handlers listed above, and describing an ObjectInspector which has a help section.
62
63        @param minHelpTextLines
64            denotes the minimum number of lines of text to be reserved for the help
65            section.
66
67        @param maxHelpTextLines
68            denotes the maximum number of lines of text to be reserved for the help
69            section.
70
71        @throws ::com::sun::star::lang::IllegalArgumentException
72            if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative,
73            or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>.
74
75        @see XObjectInspectorModel::HasHelpSection
76        @see XObjectInspectorModel::MinHelpTextLines
77        @see XObjectInspectorModel::MaxHelpTextLines
78
79        @since OpenOffice 2.2
80    */
81    createWithHelpSection(
82        [in] long minHelpTextLines,
83        [in] long maxHelpTextLines
84    )
85        raises ( ::com::sun::star::lang::IllegalArgumentException );
86};
87
88//=============================================================================
89
90}; }; }; }; };
91
92#endif
93