#85946# The idl-files describing the service, all other things are present already.

2 files changed, 333 insertions, 0 deletions

diff --git a/offapi/com/sun/star/ucb/HelpContent.idl b/offapi/com/sun/star/ucb/HelpContent.idl
new file mode 100644
index 000000000000..cd2153c49120
--- /dev/null
+++ b/offapi/com/sun/star/ucb/HelpContent.idl
@@ -0,0 +1,233 @@
+/*************************************************************************
+ *
+ *  $RCSfile: HelpContent.idl,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: abi $ $Date: 2002-04-26 12:49:56 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 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
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_ucb_HelpContent_idl__
+#define __com_sun_star_ucb_HelpContent_idl__
+
+#ifndef __com_sun_star_lang_XComponent_idl__
+#include <com/sun/star/lang/XComponent.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_XContent_idl__
+#include <com/sun/star/ucb/XContent.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
+#include <com/sun/star/ucb/XCommandProcessor.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
+#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertyContainer_idl__
+#include <com/sun/star/beans/XPropertyContainer.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
+#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
+#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
+#endif
+
+#ifndef __com_sun_star_container_XChild_idl__
+#include <com/sun/star/container/XChild.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+//=============================================================================
+/** A Help Content represents either a directory object allowing access to a
+    search engine and to index information for the respective module, or an
+    object allowing access to the concrete written help content.
+
+    @see com::sun::star::ucb::HelpContentProvider
+*/
+service HelpContent
+{
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::lang::XComponent;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::ucb::XContent;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+
+        <p>
+
+        <b>Supported Commands</b>
+
+        <ul>
+        <li>
+        getCommandInfo
+        </li>
+        <li>
+        getPropertySetInfo
+        </li>
+        <li>
+        getPropertyValues
+        </li>
+        <li>
+        setPropertyValues
+        </li>
+        <li>
+        open
+        </li>
+        </ul>
+
+        <b>Supported Properties</b>
+        <ul>
+        <li>
+        string ContentType ( read-only,
+        ""application/vnd.sun.star.help" )
+        </li>
+        <li>
+        boolean IsReadOnly ( read-only, always "true" )
+        </li>
+        <li>
+        boolean IsDocument ( read-only )
+        </li>
+        <li>
+        boolean IsFolder ( read-only )
+        </li>
+        <li>
+        string Title ( read-only, content title )
+        </li>
+        <li>
+        string MediaType ( read only, either "image/gif", "text/plain",
+        "text/html" or "text/css" )
+        </li>
+        <li>
+        sequence&lt;string&gt; KeywordList ( read-only, only if IsFolder is true,
+        contains the index )
+        </li>
+        <li>
+        sequence&lt;sequence&lt;string&gt;&gt; KeywordRef ( read-only, only if IsFolder is true,
+        contains the links belonging to the index )
+        </li>
+        <li>
+        sequence&lt;sequence&lt;string&gt;&gt; KeywordAnchorForRef ( read-only, only if IsFolder is true,
+        contains the anchor names belonging to the index )
+        </li>
+        <li>
+        sequence&lt;sequence&lt;string&gt;&gt; KeywordTitleForRef ( read-only, , only if IsFolder is true,
+        contains the titles of the documents in which the keywords are found. )
+        </li>
+        <li>
+        sequence&lt;string&gt; SearchScopes ( read only, , only if IsFolder is true,
+        contains the scopes in which to search ).
+        </li>
+        <li>
+        string AnchorName ( readonly, only if content is has media type "text/html".
+        </li>
+        </ul>
+
+        </p>
+     */
+    interface com::sun::star::ucb::XCommandProcessor;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::beans::XPropertiesChangeNotifier;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::beans::XPropertyContainer;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::ucb::XCommandInfoChangeNotifier;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::container::XChild;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
diff --git a/offapi/com/sun/star/ucb/HelpContentProvider.idl b/offapi/com/sun/star/ucb/HelpContentProvider.idl
new file mode 100644
index 000000000000..97fde65a7b33
--- /dev/null
+++ b/offapi/com/sun/star/ucb/HelpContentProvider.idl
@@ -0,0 +1,100 @@
+/*************************************************************************
+ *
+ *  $RCSfile: HelpContentProvider.idl,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: abi $ $Date: 2002-04-26 12:49:56 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 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
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_ucb_HelpContentProvider_idl__
+#define __com_sun_star_ucb_HelpContentProvider_idl__
+
+#ifndef __com_sun_star_ucb_XContentProvider_idl__
+#include <com/sun/star/ucb/XContentProvider.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+//=============================================================================
+/** The Help Content Provider (HCP) implements a <type>ContentProvider</type>
+    for the <Type>UniversalContentBroker</type> (UCB).
+
+    <p>The served contents enable access to the help contents and to the
+    search engine.
+
+    @see com::sun::star::ucb::Content
+*/
+
+service HelpContentProvider
+{
+    //-------------------------------------------------------------------------
+    /** provides an object representing either a directory object allowing
+        searching or a help content object providing access to the help content.
+
+        @see com::sun::star::ucb::HelpContent
+     */
+
+    interface com::sun::star::ucb::XContentProvider;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif