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