offapi/com/sun/star/ucb/HelpContent.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_HelpContent_idl__
  20 #define __com_sun_star_ucb_HelpContent_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23 #include <com/sun/star/ucb/XContent.idl>
  24 #include <com/sun/star/ucb/XCommandProcessor.idl>
  25 #include <com/sun/star/ucb/XCommandProcessor2.idl>
  26 #include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
  27 #include <com/sun/star/beans/XPropertyContainer.idl>
  28 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
  29 #include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
  30 #include <com/sun/star/container/XChild.idl>
  31
  32
  33 module com { module sun { module star { module ucb {
  34
  35 /** A Help Content represents either a directory object allowing access to a
  36     search engine and to index information for the respective module, or an
  37     object allowing access to the concrete written help content.
  38
  39     @see com::sun::star::ucb::HelpContentProvider
  40 */
  41 published service HelpContent
  42 {
  43     /** This interface is implemented according to the specification of
  44         service Content.
  45      */
  46     interface com::sun::star::lang::XComponent;
  47
  48     /** This interface is implemented according to the specification of
  49         service Content.
  50      */
  51     interface com::sun::star::ucb::XContent;
  52
  53     /** This interface is implemented according to the specification of
  54         service Content.
  55
  56         <p>
  57
  58         <b>Supported Commands</b>
  59
  60         <ul>
  61         <li>
  62         getCommandInfo
  63         </li>
  64         <li>
  65         getPropertySetInfo
  66         </li>
  67         <li>
  68         getPropertyValues
  69         </li>
  70         <li>
  71         setPropertyValues
  72         </li>
  73         <li>
  74         open
  75         </li>
  76         </ul>
  77
  78         <b>Supported Properties</b>
  79         <ul>
  80         <li>
  81         string ContentType ( read-only,
  82         ""application/vnd.sun.star.help" )
  83         </li>
  84         <li>
  85         boolean IsReadOnly ( read-only, always "true" )
  86         </li>
  87         <li>
  88         boolean IsDocument ( read-only )
  89         </li>
  90         <li>
  91         boolean IsFolder ( read-only )
  92         </li>
  93         <li>
  94         string Title ( read-only, content title )
  95         </li>
  96         <li>
  97         string MediaType ( read only, either "image/gif", "text/plain",
  98         "text/html" or "text/css" )
  99         </li>
 100         <li>
 101         sequence&lt;string&gt; KeywordList ( read-only, only if IsFolder is true,
 102         contains the index )
 103         </li>
 104         <li>
 105         sequence&lt;sequence&lt;string&gt;&gt; KeywordRef ( read-only, only if IsFolder is true,
 106         contains the links belonging to the index )
 107         </li>
 108         <li>
 109         sequence&lt;sequence&lt;string&gt;&gt; KeywordAnchorForRef ( read-only, only if IsFolder is true,
 110         contains the anchor names belonging to the index )
 111         </li>
 112         <li>
 113         sequence&lt;sequence&lt;string&gt;&gt; KeywordTitleForRef ( read-only, , only if IsFolder is true,
 114         contains the titles of the documents in which the keywords are found. )
 115         </li>
 116         <li>
 117         sequence&lt;string&gt; SearchScopes ( read only, , only if IsFolder is true,
 118         contains the scopes in which to search ).
 119         </li>
 120         <li>
 121         string AnchorName ( readonly, only if content is has media type "text/html".
 122         </li>
 123         </ul>
 124
 125         </p>
 126      */
 127     interface com::sun::star::ucb::XCommandProcessor;
 128
 129     /** is an enhanced version of XCommandProcessor that has an
 130         additional method for releasing command identifiers obtained via
 131         XCommandProcessor::createCommandIdentifier() to avoid
 132         resource leaks. For a detailed description of the problem refer to
 133         XCommandProcessor2::releaseCommandIdentifier().
 134
 135         <p>Where many existing Content implementations do not
 136         (yet), every new implementation should support this interface.
 137      */
 138     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 139
 140     /** This interface is implemented according to the specification of
 141         service Content.
 142      */
 143     interface com::sun::star::beans::XPropertiesChangeNotifier;
 144
 145     /** This interface is implemented according to the specification of
 146         service Content.
 147      */
 148     interface com::sun::star::beans::XPropertyContainer;
 149
 150     /** This interface is implemented according to the specification of
 151         service Content.
 152      */
 153     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 154
 155     /** This interface is implemented according to the specification of
 156         service Content.
 157      */
 158     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 159
 160     /** This interface is implemented according to the specification of
 161         service Content.
 162      */
 163     interface com::sun::star::container::XChild;
 164 };
 165
 166
 167 }; }; }; };
 168
 169 #endif
 170
 171 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */