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