1*d1766043SAndrew Rist/**************************************************************
2*d1766043SAndrew Rist *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_inspection_ObjectInspectorModel_idl__
25cdf0e10cSrcweir#define __com_sun_star_inspection_ObjectInspectorModel_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_inspection_XObjectInspectorModel_idl__
28cdf0e10cSrcweir#include <com/sun/star/inspection/XObjectInspectorModel.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
32cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweirmodule com {  module sun {  module star {  module inspection {
37cdf0e10cSrcweir
38cdf0e10cSrcweir//-----------------------------------------------------------------------------
39cdf0e10cSrcweir/** describes a default implementation of an ObjectInspectorModel
40cdf0e10cSrcweir
41cdf0e10cSrcweir    <p>This service simplifies usage of an <type>ObjectInspector</type>.</p>
42cdf0e10cSrcweir
43cdf0e10cSrcweir    <p>The <type>XObjectInspectorModel</type> implemented by this service will not provide any property
44cdf0e10cSrcweir    categories, nor apply any particular order to the properties provided by its handler(s).</p>
45cdf0e10cSrcweir
46cdf0e10cSrcweir    @see ObjectInspector
47cdf0e10cSrcweir    @see XObjectInspectorModel
48cdf0e10cSrcweir    @see XObjectInspectorModel::describeCategories
49cdf0e10cSrcweir    @see XObjectInspectorModel::getPropertyOrderIndex
50cdf0e10cSrcweir
51cdf0e10cSrcweir    @since OOo 2.0.3
52cdf0e10cSrcweir*/
53cdf0e10cSrcweirpublished service ObjectInspectorModel : XObjectInspectorModel
54cdf0e10cSrcweir{
55cdf0e10cSrcweir    /** creates a default ObjectInspectorModel, whose one and only handler factory
56cdf0e10cSrcweir        creates a <type>GenericPropertyHandler</type>.
57cdf0e10cSrcweir    */
58cdf0e10cSrcweir    createDefault();
59cdf0e10cSrcweir
60cdf0e10cSrcweir    /** creates a default ObjectInspectorModel, using an externally provided sequence of property handler
61cdf0e10cSrcweir        factories.
62cdf0e10cSrcweir
63cdf0e10cSrcweir        @param handlerFactories
64cdf0e10cSrcweir            a sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories
65cdf0e10cSrcweir            method.
66cdf0e10cSrcweir        @throws ::com::sun::star::lang::IllegalArgumentException
67cdf0e10cSrcweir            if the given sequence is empty.
68cdf0e10cSrcweir
69cdf0e10cSrcweir        @see XObjectInspectorModel::HandlerFactories
70cdf0e10cSrcweir    */
71cdf0e10cSrcweir    createWithHandlerFactories( [in] sequence< any > handlerFactories )
72cdf0e10cSrcweir        raises ( ::com::sun::star::lang::IllegalArgumentException );
73cdf0e10cSrcweir
74cdf0e10cSrcweir    /** creates a default ObjectInspectorModel, using an externally provided sequence of property handler
75cdf0e10cSrcweir        factories, and describing an ObjectInspector which has a help section.
76cdf0e10cSrcweir
77cdf0e10cSrcweir        @param handlerFactories
78cdf0e10cSrcweir            a sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories
79cdf0e10cSrcweir            method.
80cdf0e10cSrcweir
81cdf0e10cSrcweir        @param minHelpTextLines
82cdf0e10cSrcweir            denotes the minimum number of lines of text to be reserved for the help
83cdf0e10cSrcweir            section.
84cdf0e10cSrcweir
85cdf0e10cSrcweir        @param maxHelpTextLines
86cdf0e10cSrcweir            denotes the maximum number of lines of text to be reserved for the help
87cdf0e10cSrcweir            section.
88cdf0e10cSrcweir
89cdf0e10cSrcweir        @throws ::com::sun::star::lang::IllegalArgumentException
90cdf0e10cSrcweir            if <arg>handlerFactories</arg> is empty.
91cdf0e10cSrcweir
92cdf0e10cSrcweir        @throws ::com::sun::star::lang::IllegalArgumentException
93cdf0e10cSrcweir            if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative,
94cdf0e10cSrcweir            or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>.
95cdf0e10cSrcweir
96cdf0e10cSrcweir        @see XObjectInspectorModel::HandlerFactories
97cdf0e10cSrcweir        @see XObjectInspectorModel::HasHelpSection
98cdf0e10cSrcweir        @see XObjectInspectorModel::MinHelpTextLines
99cdf0e10cSrcweir        @see XObjectInspectorModel::MaxHelpTextLines
100cdf0e10cSrcweir
101cdf0e10cSrcweir        @since OOo 2.2
102cdf0e10cSrcweir    */
103cdf0e10cSrcweir    createWithHandlerFactoriesAndHelpSection(
104cdf0e10cSrcweir        [in] sequence< any > handlerFactories,
105cdf0e10cSrcweir        [in] long minHelpTextLines,
106cdf0e10cSrcweir        [in] long maxHelpTextLines
107cdf0e10cSrcweir    )
108cdf0e10cSrcweir        raises ( ::com::sun::star::lang::IllegalArgumentException );
109cdf0e10cSrcweir};
110cdf0e10cSrcweir
111cdf0e10cSrcweir//=============================================================================
112cdf0e10cSrcweir
113cdf0e10cSrcweir}; }; }; };
114cdf0e10cSrcweir
115cdf0e10cSrcweir#endif
116cdf0e10cSrcweir
117cdf0e10cSrcweir
118