xref: /aoo42x/main/offapi/com/sun/star/inspection/DefaultHelpProvider.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_inspection_DefaultHelpProvider_idl__
#define __com_sun_star_inspection_DefaultHelpProvider_idl__

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

//=============================================================================

module com { module sun { module star { module inspection {

published interface XObjectInspectorUI;

//=============================================================================

/** implements a component which can default-fill the help section of an
    <type>ObjectInspector</type>.

    <p>The component registers a <type>XPropertyControlObserver</type> at an
    <type>XObjectInspectoryUI</type> interface. Whenever it then is notified
    of a <type>XPropertyControl</type> getting the focus, it will try to deduce
    the extended help text of this control's window, and set this help text at the
    object inspector's help section.</p>
 */
published service DefaultHelpProvider : com::sun::star::uno::XInterface
{
    /** creates a help provider instance
        @param InspectorUI
            provides access to the UI of the ObjectInspector which should be
            observed. Must not be <NULL/>.
        @throws ::com::sun::star::lang::IllegalArgumentException
            if the given inspector UI is <NULL/>.
    */
    create( [in] XObjectInspectorUI InspectorUI )
        raises ( ::com::sun::star::lang::IllegalArgumentException );
};

//=============================================================================

}; }; }; };

//=============================================================================

#endif