INTEGRATION: CWS oihelp (1.1.2); FILE ADDED

2006/11/15 14:32:52 fs 1.1.2.1: #i71485#

1 files changed, 79 insertions, 0 deletions

diff --git a/offapi/com/sun/star/inspection/DefaultHelpProvider.idl b/offapi/com/sun/star/inspection/DefaultHelpProvider.idl
new file mode 100644
index 000000000000..da69ba797dc3
--- /dev/null
+++ b/offapi/com/sun/star/inspection/DefaultHelpProvider.idl
@@ -0,0 +1,79 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: DefaultHelpProvider.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2006-12-13 11:44:49 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+#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 {
+
+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>
+ */
+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
+