offapi/com/sun/star/ucb/HelpContent.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: HelpContent.idl,v $
  10  * $Revision: 1.6 $
  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_ucb_HelpContent_idl__
  31 #define __com_sun_star_ucb_HelpContent_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XContent_idl__
  38 #include <com/sun/star/ucb/XContent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XCommandProcessor_idl__
  42 #include <com/sun/star/ucb/XCommandProcessor.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
  46 #include <com/sun/star/ucb/XCommandProcessor2.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
  50 #include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_XPropertyContainer_idl__
  54 #include <com/sun/star/beans/XPropertyContainer.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
  58 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
  62 #include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_container_XChild_idl__
  66 #include <com/sun/star/container/XChild.idl>
  67 #endif
  68
  69 //=============================================================================
  70
  71 module com { module sun { module star { module ucb {
  72
  73 //=============================================================================
  74 /** A Help Content represents either a directory object allowing access to a
  75     search engine and to index information for the respective module, or an
  76     object allowing access to the concrete written help content.
  77
  78     @see com::sun::star::ucb::HelpContentProvider
  79 */
  80 published service HelpContent
  81 {
  82     //-------------------------------------------------------------------------
  83     /** This interface is implemented according to the specification of
  84         service <type>Content</type>.
  85      */
  86     interface com::sun::star::lang::XComponent;
  87
  88     //-------------------------------------------------------------------------
  89     /** This interface is implemented according to the specification of
  90         service <type>Content</type>.
  91      */
  92     interface com::sun::star::ucb::XContent;
  93
  94     //-------------------------------------------------------------------------
  95     /** This interface is implemented according to the specification of
  96         service <type>Content</type>.
  97
  98         <p>
  99
 100         <b>Supported Commands</b>
 101
 102         <ul>
 103         <li>
 104         getCommandInfo
 105         </li>
 106         <li>
 107         getPropertySetInfo
 108         </li>
 109         <li>
 110         getPropertyValues
 111         </li>
 112         <li>
 113         setPropertyValues
 114         </li>
 115         <li>
 116         open
 117         </li>
 118         </ul>
 119
 120         <b>Supported Properties</b>
 121         <ul>
 122         <li>
 123         string ContentType ( read-only,
 124         ""application/vnd.sun.star.help" )
 125         </li>
 126         <li>
 127         boolean IsReadOnly ( read-only, always "true" )
 128         </li>
 129         <li>
 130         boolean IsDocument ( read-only )
 131         </li>
 132         <li>
 133         boolean IsFolder ( read-only )
 134         </li>
 135         <li>
 136         string Title ( read-only, content title )
 137         </li>
 138         <li>
 139         string MediaType ( read only, either "image/gif", "text/plain",
 140         "text/html" or "text/css" )
 141         </li>
 142         <li>
 143         sequence&lt;string&gt; KeywordList ( read-only, only if IsFolder is true,
 144         contains the index )
 145         </li>
 146         <li>
 147         sequence&lt;sequence&lt;string&gt;&gt; KeywordRef ( read-only, only if IsFolder is true,
 148         contains the links belonging to the index )
 149         </li>
 150         <li>
 151         sequence&lt;sequence&lt;string&gt;&gt; KeywordAnchorForRef ( read-only, only if IsFolder is true,
 152         contains the anchor names belonging to the index )
 153         </li>
 154         <li>
 155         sequence&lt;sequence&lt;string&gt;&gt; KeywordTitleForRef ( read-only, , only if IsFolder is true,
 156         contains the titles of the documents in which the keywords are found. )
 157         </li>
 158         <li>
 159         sequence&lt;string&gt; SearchScopes ( read only, , only if IsFolder is true,
 160         contains the scopes in which to search ).
 161         </li>
 162         <li>
 163         string AnchorName ( readonly, only if content is has media type "text/html".
 164         </li>
 165         </ul>
 166
 167         </p>
 168      */
 169     interface com::sun::star::ucb::XCommandProcessor;
 170
 171     //-------------------------------------------------------------------------
 172     /** is an enhanced version of <type>XCommandProcessor</type> that has an
 173         additional method for releasing command identifiers obtained via
 174         <member>XCommandProcessor::createCommandIdentifier</member> to avoid
 175         resource leaks. For a detailed description of the problem refer to
 176         <member>XCommandProcessor2::releaseCommandIdentifier</member>.
 177
 178         <p>Where many existing <type>Content</type> implementations do not
 179         (yet), every new implementation should support this interface.
 180      */
 181     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 182
 183     //-------------------------------------------------------------------------
 184     /** This interface is implemented according to the specification of
 185         service <type>Content</type>.
 186      */
 187     interface com::sun::star::beans::XPropertiesChangeNotifier;
 188
 189     //-------------------------------------------------------------------------
 190     /** This interface is implemented according to the specification of
 191         service <type>Content</type>.
 192      */
 193     interface com::sun::star::beans::XPropertyContainer;
 194
 195     //-------------------------------------------------------------------------
 196     /** This interface is implemented according to the specification of
 197         service <type>Content</type>.
 198      */
 199     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 200
 201     //-------------------------------------------------------------------------
 202     /** This interface is implemented according to the specification of
 203         service <type>Content</type>.
 204      */
 205     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 206
 207     //-------------------------------------------------------------------------
 208     /** This interface is implemented according to the specification of
 209         service <type>Content</type>.
 210      */
 211     interface com::sun::star::container::XChild;
 212 };
 213
 214 //=============================================================================
 215
 216 }; }; }; };
 217
 218 #endif