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_XPropertyControlFactory_idl__
25cdf0e10cSrcweir#define __com_sun_star_inspection_XPropertyControlFactory_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
28cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir//=============================================================================
32cdf0e10cSrcweirmodule com {  module sun {  module star {  module inspection {
33cdf0e10cSrcweir
34cdf0e10cSrcweirpublished interface XPropertyControl;
35cdf0e10cSrcweir
36cdf0e10cSrcweir//-----------------------------------------------------------------------------
37cdf0e10cSrcweir/** a factory for <type>XPropertyControl</type>s
38cdf0e10cSrcweir
39cdf0e10cSrcweir    @since OOo 2.0.3
40cdf0e10cSrcweir*/
41cdf0e10cSrcweirpublished interface XPropertyControlFactory
42cdf0e10cSrcweir{
43cdf0e10cSrcweir    /** creates a <type>XPropertyControl</type>
44cdf0e10cSrcweir
45cdf0e10cSrcweir        <p>A <type>XPropertyControlFactory</type> can create any of the control types denoted by
46cdf0e10cSrcweir        the <type>PropertyControlType</type> constants.</p>
47cdf0e10cSrcweir
48cdf0e10cSrcweir        @param ControlType
49cdf0e10cSrcweir            the type of the requested control
50cdf0e10cSrcweir
51cdf0e10cSrcweir        @param CreateReadOnly
52cdf0e10cSrcweir            determines whether the newly created control should be readonly.
53cdf0e10cSrcweir
54cdf0e10cSrcweir            <p>If this argument is <TRUE/>, this does not necessarily mean that the property cannot be
55cdf0e10cSrcweir            changed at all in the <type>ObjectInspector</type>. Instead, an <type>XPropertyHandler</type>
56cdf0e10cSrcweir            can still decide that there is a dedicated UI for entering the property value,
57cdf0e10cSrcweir            which is usually triggered by a <member>LineDescriptor::PrimaryButton</member>.</p>
58cdf0e10cSrcweir
59cdf0e10cSrcweir            <p>Note that this parameter might be ignored if the <member>XObjectInspectorModel::IsReadOnly</member>
60cdf0e10cSrcweir            attribute is <TRUE/>, in which case all created property controls must be readonly.</p>
61cdf0e10cSrcweir
62cdf0e10cSrcweir        @returns
63cdf0e10cSrcweir            a control of the given type.
64cdf0e10cSrcweir
65cdf0e10cSrcweir        @throws com::sun::star::lang::IllegalArgumentException
66cdf0e10cSrcweir            if the given <arg>ControlType</arg> is not a value <type>PropertyControlType</type>
67cdf0e10cSrcweir    */
68cdf0e10cSrcweir    XPropertyControl    createPropertyControl( [in] short ControlType, [in] boolean CreateReadOnly )
69cdf0e10cSrcweir        raises ( com::sun::star::lang::IllegalArgumentException );
70cdf0e10cSrcweir};
71cdf0e10cSrcweir
72cdf0e10cSrcweir//=============================================================================
73cdf0e10cSrcweir
74cdf0e10cSrcweir}; }; }; };
75cdf0e10cSrcweir
76cdf0e10cSrcweir#endif
77cdf0e10cSrcweir
78