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