1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_ucb_HelpContent_idl__ 24#define __com_sun_star_ucb_HelpContent_idl__ 25 26#ifndef __com_sun_star_lang_XComponent_idl__ 27#include <com/sun/star/lang/XComponent.idl> 28#endif 29 30#ifndef __com_sun_star_ucb_XContent_idl__ 31#include <com/sun/star/ucb/XContent.idl> 32#endif 33 34#ifndef __com_sun_star_ucb_XCommandProcessor_idl__ 35#include <com/sun/star/ucb/XCommandProcessor.idl> 36#endif 37 38#ifndef __com_sun_star_ucb_XCommandProcessor2_idl__ 39#include <com/sun/star/ucb/XCommandProcessor2.idl> 40#endif 41 42#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__ 43#include <com/sun/star/beans/XPropertiesChangeNotifier.idl> 44#endif 45 46#ifndef __com_sun_star_beans_XPropertyContainer_idl__ 47#include <com/sun/star/beans/XPropertyContainer.idl> 48#endif 49 50#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__ 51#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl> 52#endif 53 54#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__ 55#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl> 56#endif 57 58#ifndef __com_sun_star_container_XChild_idl__ 59#include <com/sun/star/container/XChild.idl> 60#endif 61 62//============================================================================= 63 64module com { module sun { module star { module ucb { 65 66//============================================================================= 67/** A Help Content represents either a directory object allowing access to a 68 search engine and to index information for the respective module, or an 69 object allowing access to the concrete written help content. 70 71 @see com::sun::star::ucb::HelpContentProvider 72*/ 73published service HelpContent 74{ 75 //------------------------------------------------------------------------- 76 /** This interface is implemented according to the specification of 77 service <type>Content</type>. 78 */ 79 interface com::sun::star::lang::XComponent; 80 81 //------------------------------------------------------------------------- 82 /** This interface is implemented according to the specification of 83 service <type>Content</type>. 84 */ 85 interface com::sun::star::ucb::XContent; 86 87 //------------------------------------------------------------------------- 88 /** This interface is implemented according to the specification of 89 service <type>Content</type>. 90 91 <p> 92 93 <b>Supported Commands</b> 94 95 <ul> 96 <li> 97 getCommandInfo 98 </li> 99 <li> 100 getPropertySetInfo 101 </li> 102 <li> 103 getPropertyValues 104 </li> 105 <li> 106 setPropertyValues 107 </li> 108 <li> 109 open 110 </li> 111 </ul> 112 113 <b>Supported Properties</b> 114 <ul> 115 <li> 116 string ContentType ( read-only, 117 ""application/vnd.sun.star.help" ) 118 </li> 119 <li> 120 boolean IsReadOnly ( read-only, always "true" ) 121 </li> 122 <li> 123 boolean IsDocument ( read-only ) 124 </li> 125 <li> 126 boolean IsFolder ( read-only ) 127 </li> 128 <li> 129 string Title ( read-only, content title ) 130 </li> 131 <li> 132 string MediaType ( read only, either "image/gif", "text/plain", 133 "text/html" or "text/css" ) 134 </li> 135 <li> 136 sequence<string> KeywordList ( read-only, only if IsFolder is true, 137 contains the index ) 138 </li> 139 <li> 140 sequence<sequence<string>> KeywordRef ( read-only, only if IsFolder is true, 141 contains the links belonging to the index ) 142 </li> 143 <li> 144 sequence<sequence<string>> KeywordAnchorForRef ( read-only, only if IsFolder is true, 145 contains the anchor names belonging to the index ) 146 </li> 147 <li> 148 sequence<sequence<string>> KeywordTitleForRef ( read-only, , only if IsFolder is true, 149 contains the titles of the documents in which the keywords are found. ) 150 </li> 151 <li> 152 sequence<string> SearchScopes ( read only, , only if IsFolder is true, 153 contains the scopes in which to search ). 154 </li> 155 <li> 156 string AnchorName ( readonly, only if content is has media type "text/html". 157 </li> 158 </ul> 159 160 </p> 161 */ 162 interface com::sun::star::ucb::XCommandProcessor; 163 164 //------------------------------------------------------------------------- 165 /** is an enhanced version of <type>XCommandProcessor</type> that has an 166 additional method for releasing command identifiers obtained via 167 <member>XCommandProcessor::createCommandIdentifier</member> to avoid 168 resource leaks. For a detailed description of the problem refer to 169 <member>XCommandProcessor2::releaseCommandIdentifier</member>. 170 171 <p>Where many existing <type>Content</type> implementations do not 172 (yet), every new implementation should support this interface. 173 */ 174 [optional] interface com::sun::star::ucb::XCommandProcessor2; 175 176 //------------------------------------------------------------------------- 177 /** This interface is implemented according to the specification of 178 service <type>Content</type>. 179 */ 180 interface com::sun::star::beans::XPropertiesChangeNotifier; 181 182 //------------------------------------------------------------------------- 183 /** This interface is implemented according to the specification of 184 service <type>Content</type>. 185 */ 186 interface com::sun::star::beans::XPropertyContainer; 187 188 //------------------------------------------------------------------------- 189 /** This interface is implemented according to the specification of 190 service <type>Content</type>. 191 */ 192 interface com::sun::star::beans::XPropertySetInfoChangeNotifier; 193 194 //------------------------------------------------------------------------- 195 /** This interface is implemented according to the specification of 196 service <type>Content</type>. 197 */ 198 interface com::sun::star::ucb::XCommandInfoChangeNotifier; 199 200 //------------------------------------------------------------------------- 201 /** This interface is implemented according to the specification of 202 service <type>Content</type>. 203 */ 204 interface com::sun::star::container::XChild; 205}; 206 207//============================================================================= 208 209}; }; }; }; 210 211#endif 212