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
24#ifndef __com_sun_star_inspection_ObjectInspectorModel_idl__
25#define __com_sun_star_inspection_ObjectInspectorModel_idl__
26
27#ifndef __com_sun_star_inspection_XObjectInspectorModel_idl__
28#include <com/sun/star/inspection/XObjectInspectorModel.idl>
29#endif
30
31#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
32#include <com/sun/star/lang/IllegalArgumentException.idl>
33#endif
34
35//=============================================================================
36module com {  module sun {  module star {  module inspection {
37
38//-----------------------------------------------------------------------------
39/** describes a default implementation of an ObjectInspectorModel
40
41    <p>This service simplifies usage of an <type>ObjectInspector</type>.</p>
42
43    <p>The <type>XObjectInspectorModel</type> implemented by this service will not provide any property
44    categories, nor apply any particular order to the properties provided by its handler(s).</p>
45
46    @see ObjectInspector
47    @see XObjectInspectorModel
48    @see XObjectInspectorModel::describeCategories
49    @see XObjectInspectorModel::getPropertyOrderIndex
50
51    @since OOo 2.0.3
52*/
53published service ObjectInspectorModel : XObjectInspectorModel
54{
55    /** creates a default ObjectInspectorModel, whose one and only handler factory
56        creates a <type>GenericPropertyHandler</type>.
57    */
58    createDefault();
59
60    /** creates a default ObjectInspectorModel, using an externally provided sequence of property handler
61        factories.
62
63        @param handlerFactories
64            a sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories
65            method.
66        @throws ::com::sun::star::lang::IllegalArgumentException
67            if the given sequence is empty.
68
69        @see XObjectInspectorModel::HandlerFactories
70    */
71    createWithHandlerFactories( [in] sequence< any > handlerFactories )
72        raises ( ::com::sun::star::lang::IllegalArgumentException );
73
74    /** creates a default ObjectInspectorModel, using an externally provided sequence of property handler
75        factories, and describing an ObjectInspector which has a help section.
76
77        @param handlerFactories
78            a sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories
79            method.
80
81        @param minHelpTextLines
82            denotes the minimum number of lines of text to be reserved for the help
83            section.
84
85        @param maxHelpTextLines
86            denotes the maximum number of lines of text to be reserved for the help
87            section.
88
89        @throws ::com::sun::star::lang::IllegalArgumentException
90            if <arg>handlerFactories</arg> is empty.
91
92        @throws ::com::sun::star::lang::IllegalArgumentException
93            if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative,
94            or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>.
95
96        @see XObjectInspectorModel::HandlerFactories
97        @see XObjectInspectorModel::HasHelpSection
98        @see XObjectInspectorModel::MinHelpTextLines
99        @see XObjectInspectorModel::MaxHelpTextLines
100
101        @since OOo 2.2
102    */
103    createWithHandlerFactoriesAndHelpSection(
104        [in] sequence< any > handlerFactories,
105        [in] long minHelpTextLines,
106        [in] long maxHelpTextLines
107    )
108        raises ( ::com::sun::star::lang::IllegalArgumentException );
109};
110
111//=============================================================================
112
113}; }; }; };
114
115#endif
116
117
118