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
  20
  21 module com { module sun { module star { module ucb {
  22
  23 /** A Help Content represents either a directory object allowing access to a
  24     search engine and to index information for the respective module, or an
  25     object allowing access to the concrete written help content.
  26
  27     @see com::sun::star::ucb::HelpContentProvider
  28 */
  29 published service HelpContent
  30 {
  31     /** This interface is implemented according to the specification of
  32         service Content.
  33      */
  34     interface com::sun::star::lang::XComponent;
  35
  36     /** This interface is implemented according to the specification of
  37         service Content.
  38      */
  39     interface com::sun::star::ucb::XContent;
  40
  41     /** This interface is implemented according to the specification of
  42         service Content.
  43
  44         <p>
  45
  46         <b>Supported Commands</b>
  47
  48         <ul>
  49         <li>
  50         getCommandInfo
  51         </li>
  52         <li>
  53         getPropertySetInfo
  54         </li>
  55         <li>
  56         getPropertyValues
  57         </li>
  58         <li>
  59         setPropertyValues
  60         </li>
  61         <li>
  62         open
  63         </li>
  64         </ul>
  65
  66         <b>Supported Properties</b>
  67         <ul>
  68         <li>
  69         string ContentType ( read-only,
  70         ""application/vnd.sun.star.help" )
  71         </li>
  72         <li>
  73         boolean IsReadOnly ( read-only, always "true" )
  74         </li>
  75         <li>
  76         boolean IsDocument ( read-only )
  77         </li>
  78         <li>
  79         boolean IsFolder ( read-only )
  80         </li>
  81         <li>
  82         string Title ( read-only, content title )
  83         </li>
  84         <li>
  85         string MediaType ( read only, either "image/gif", "text/plain",
  86         "text/html" or "text/css" )
  87         </li>
  88         <li>
  89         sequence&lt;string&gt; KeywordList ( read-only, only if IsFolder is true,
  90         contains the index )
  91         </li>
  92         <li>
  93         sequence&lt;sequence&lt;string&gt;&gt; KeywordRef ( read-only, only if IsFolder is true,
  94         contains the links belonging to the index )
  95         </li>
  96         <li>
  97         sequence&lt;sequence&lt;string&gt;&gt; KeywordAnchorForRef ( read-only, only if IsFolder is true,
  98         contains the anchor names belonging to the index )
  99         </li>
 100         <li>
 101         sequence&lt;sequence&lt;string&gt;&gt; KeywordTitleForRef ( read-only, , only if IsFolder is true,
 102         contains the titles of the documents in which the keywords are found. )
 103         </li>
 104         <li>
 105         sequence&lt;string&gt; SearchScopes ( read only, , only if IsFolder is true,
 106         contains the scopes in which to search ).
 107         </li>
 108         <li>
 109         string AnchorName ( readonly, only if content is has media type "text/html".
 110         </li>
 111         </ul>
 112
 113         </p>
 114      */
 115     interface com::sun::star::ucb::XCommandProcessor;
 116
 117     /** is an enhanced version of XCommandProcessor that has an
 118         additional method for releasing command identifiers obtained via
 119         XCommandProcessor::createCommandIdentifier() to avoid
 120         resource leaks. For a detailed description of the problem refer to
 121         XCommandProcessor2::releaseCommandIdentifier().
 122
 123         <p>Where many existing Content implementations do not
 124         (yet), every new implementation should support this interface.
 125      */
 126     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 127
 128     /** This interface is implemented according to the specification of
 129         service Content.
 130      */
 131     interface com::sun::star::beans::XPropertiesChangeNotifier;
 132
 133     /** This interface is implemented according to the specification of
 134         service Content.
 135      */
 136     interface com::sun::star::beans::XPropertyContainer;
 137
 138     /** This interface is implemented according to the specification of
 139         service Content.
 140      */
 141     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 142
 143     /** This interface is implemented according to the specification of
 144         service Content.
 145      */
 146     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 147
 148     /** This interface is implemented according to the specification of
 149         service Content.
 150      */
 151     interface com::sun::star::container::XChild;
 152 };
 153
 154
 155 }; }; }; };
 156
 157 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */