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_inspection_DefaultHelpProvider_idl__
24#define __com_sun_star_inspection_DefaultHelpProvider_idl__
25
26#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
27#include <com/sun/star/lang/IllegalArgumentException.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module inspection {
33
34published interface XObjectInspectorUI;
35
36//=============================================================================
37
38/** implements a component which can default-fill the help section of an
39    <type>ObjectInspector</type>.
40
41    <p>The component registers a <type>XPropertyControlObserver</type> at an
42    <type>XObjectInspectoryUI</type> interface. Whenever it then is notified
43    of a <type>XPropertyControl</type> getting the focus, it will try to deduce
44    the extended help text of this control's window, and set this help text at the
45    object inspector's help section.</p>
46 */
47published service DefaultHelpProvider : com::sun::star::uno::XInterface
48{
49    /** creates a help provider instance
50        @param InspectorUI
51            provides access to the UI of the ObjectInspector which should be
52            observed. Must not be <NULL/>.
53        @throws ::com::sun::star::lang::IllegalArgumentException
54            if the given inspector UI is <NULL/>.
55    */
56    create( [in] XObjectInspectorUI InspectorUI )
57        raises ( ::com::sun::star::lang::IllegalArgumentException );
58};
59
60//=============================================================================
61
62}; }; }; };
63
64//=============================================================================
65
66#endif
67
68