offapi/com/sun/star/inspection/DefaultHelpProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DefaultHelpProvider.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_inspection_DefaultHelpProvider_idl__
  31 #define __com_sun_star_inspection_DefaultHelpProvider_idl__
  32
  33 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module inspection {
  40
  41 interface XObjectInspectorUI;
  42
  43 //=============================================================================
  44
  45 /** implements a component which can default-fill the help section of an
  46     <type>ObjectInspector</type>.
  47
  48     <p>The component registers a <type>XPropertyControlObserver</type> at an
  49     <type>XObjectInspectoryUI</type> interface. Whenever it then is notified
  50     of a <type>XPropertyControl</type> getting the focus, it will try to deduce
  51     the extended help text of this control's window, and set this help text at the
  52     object inspector's help section.</p>
  53  */
  54 service DefaultHelpProvider : com::sun::star::uno::XInterface
  55 {
  56     /** creates a help provider instance
  57         @param InspectorUI
  58             provides access to the UI of the ObjectInspector which should be
  59             observed. Must not be <NULL/>.
  60         @throws ::com::sun::star::lang::IllegalArgumentException
  61             if the given inspector UI is <NULL/>.
  62     */
  63     create( [in] XObjectInspectorUI InspectorUI )
  64         raises ( ::com::sun::star::lang::IllegalArgumentException );
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 //=============================================================================
  72
  73 #endif
  74