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