| blob | 466ce990f0c04d6e36287777dafc8e850f18ec46 |
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 */
20 #ifndef INCLUDED_UCBHELPER_CONTENTHELPER_HXX
21 #define INCLUDED_UCBHELPER_CONTENTHELPER_HXX
23 #include <com/sun/star/beans/XPropertyContainer.hpp>
24 #include <com/sun/star/beans/XPropertiesChangeNotifier.hpp>
25 #include <com/sun/star/ucb/XCommandProcessor.hpp>
26 #include <com/sun/star/ucb/XContent.hpp>
27 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.hpp>
28 #include <com/sun/star/ucb/XCommandInfoChangeNotifier.hpp>
29 #include <com/sun/star/container/XChild.hpp>
30 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
31 #include <com/sun/star/lang/XTypeProvider.hpp>
32 #include <com/sun/star/lang/XServiceInfo.hpp>
33 #include <com/sun/star/lang/XComponent.hpp>
34 #include <com/sun/star/ucb/CommandAbortedException.hpp>
35 #include <cppuhelper/weak.hxx>
37 #include <osl/mutex.hxx>
38 #include <rtl/ref.hxx>
39 #include <ucbhelper/macros.hxx>
40 #include <ucbhelper/ucbhelperdllapi.h>
47 } } } }
52 } } } }
56 namespace ucbhelper
57 {
63 /**
64 * This is an abstract base class for implementations of the service
65 * com.sun.star.ucb.Content. Implementations derived from this class are
66 * objects provided by implementations derived from
67 * class ucb::ContentProviderImplHelper.
68 *
69 * Features of the base class implementation:
70 * - standard interfaces ( XInterface, XTypeProvider, XServiceInfo )
71 * - all required interfaces for service com::sun::star::ucb::Content
72 * - all required listener containers
73 * ( XComponent, XPropertiesChangeNotifier, XPropertySetInfoChangeNotifier,
74 * XCommandInfoChangeNotifier )
75 * - XPropertyContainer implementation ( persistence is implemented using
76 * service com.sun.star.ucb.Store )
77 * - complete XPropertySetInfo implementation ( including Additioanl Core
78 * Properties supplied via XPropertyContainer interface )
79 * -> protected method: getPropertySetInfo
80 * - complete XCommandInfo implementation
81 * -> protected method: getCommandInfo
82 */
95 {
104 m_xContext;
106 m_xIdentifier;
108 m_xProvider;
109 sal_uInt32 m_nCommandId;
112 /**
113 * Your implementation of this method must return a sequence containing
114 * the meta data of the properties supported by the content.
115 * Note: If you wish to provide your own implementation of the interface
116 * XPropertyContainer ( completely override addContent and removeContent
117 * implementation of this base class in this case ), you can supply the
118 * meta data for your Additional Core Properties here to get a fully
119 * featured getPropertySetInfo method ( see below ).
120 *
121 * @param xEnv is an environment to use for example, for interactions.
122 * @return a sequence containing the property meta data.
123 */
124 UCBHELPER_DLLPRIVATE
129 /**
130 * Your implementation of this method must return a sequence containing
131 * the meta data of the commands supported by the content.
132 *
133 * @param xEnv is an environment to use for example, for interactions.
134 * @return a sequence containing the command meta data.
135 */
136 UCBHELPER_DLLPRIVATE
141 /**
142 * The implementation of this method shall return the URL of the parent
143 * of your content.
144 *
145 * @return the URL of the parent content or an empty string.
146 * Note that not all contents must have one parent. There may
147 * be contents with no parent. In that case an empty string must
148 * be returned. If your content has more than one parent you may
149 * return the URL of one "preferred" parent or an empty string.
150 */
154 /**
155 * This method returns complete meta data for the properties ( including
156 * Additional Core Properties supplied via XPropertyContainer interface )
157 * supported by the content. To implement the required command
158 * "getPropertySetInfo" simply return the return value of this method.
159 *
160 * @param xEnv is an environment to use for example, for interactions.
161 * @param bCache indicates, whether the implementation should use
162 * cached data, if exist.
163 * @return an XPropertySetInfo implementation object containing meta data
164 * for the properties supported by this content.
165 */
171 /**
172 * This method returns complete meta data for the commands supported by
173 * the content. To implement the required command "getCommandInfo" simply
174 * return the return value of this method.
175 *
176 * @param xEnv is an environment to use for example, for interactions.
177 * @param bCache indicates, whether the implementation should use
178 * cached data, if exist.
179 * @return an XCommandInfo implementation object containing meta data
180 * for the commands supported by this content.
181 */
187 /**
188 * This method can be used to propagate changes of property values.
189 *
190 * @param evt is a sequence of property change events.
191 */
196 /**
197 * This method can be used to propagate changes of the propertyset
198 * info of your content (i.e. this happens if a new property is added
199 * to your content via its XPropertyContainer interface). This base class
200 * automatically generates events when the propertyset info changes. If
201 * you provide your own implementations of addproperty and removeProperty,
202 * then you must call "notifyPropertySetInfoChange" by yourself.
203 *
204 * @param evt is a sequence of property change events.
205 */
209 /**
210 * This method can be used to propagate content events.
211 *
212 * @param evt is a sequence of content events.
213 */
217 /**
218 * Use this method to announce the insertion of this content at
219 * the end of your implementation of the command "insert". The
220 * implementation of is method propagates a ContentEvent( INSERTED ).
221 */
224 /**
225 * Use this method to announce the destruction of this content at
226 * the end of your implementation of the command "delete". The
227 * implementation of is method propagates a ContentEvent( DELETED )
228 * and a ContentEvent( REMOVED ) at the parent of the deleted content,
229 * if a parent exists.
230 */
233 /**
234 * Use this method to change the identity of a content. The implementation
235 * of this method will replace the content identifier of the content and
236 * propagate the appropriate ContentEvent( EXCHANGED ).
237 *
238 * @param rNewId is the new content identifier for the contant.
239 * @return a success indicator.
240 */
244 /**
245 * Use this method to get access to the Additional Core Properties of
246 * the content ( added using content's XPropertyContainer interface ).
247 * If you supply your own XPropertyContainer implementation, this method
248 * will always return an empty propertyset.
249 *
250 * @param bCreate indicates whether a new propertyset shall be created
251 * if it does not exist.
252 * @return the implementation of the service
253 * com.sun.star.ucb.PersistentPropertySet.
254 */
259 /**
260 * This method renames the propertyset containing the Additional Core
261 * Properties of the content.
262 *
263 * @param rOldKey is the old key of the propertyset.
264 * @param rNewKey is the new key for the propertyset.
265 * @param bRecursive is a flag indicating whether propertysets for
266 * children described by rOldKey shall be renamed too.
267 * @return True, if the operation succeeded - False, otherwise.
268 */
273 /**
274 * This method copies the propertyset containing the Additional Core
275 * Properties of the content.
276 *
277 * @param rSourceKey is the key of the source propertyset.
278 * @param rTargetKey is the key of the target propertyset.
279 * @param bRecursive is a flag indicating whether propertysets for
280 * children described by rSourceKey shall be copied too.
281 * @return True, if the operation succeeded - False, otherwise.
282 */
287 /**
288 * This method removes the propertyset containing the Additional Core
289 * Properties of the content.
290 *
291 * @param bRecursive is a flag indicating whether propertysets for
292 * children described by rOldKey shall be removed too.
293 * @return True, if the operation succeeded - False, otherwise.
294 */
298 /**
299 * Constructor.
300 *
301 * Note that the implementation of this ctor registers itself at its
302 * content provider. The provider implementation inserts the content
303 * in a hash map. So it easily can be found and reused when the provider
304 * is asked for a content.
305 *
306 * @param rxContext is a Service Manager.
307 * @param rxProvider is the provider for the content.
308 * @param Identifier is the content identifier for the content.
309 */
317 /**
318 * Destructor.
319 *
320 * Note that the implementation of this dtor deregisters itself from its
321 * content provider. The provider implementation removes the content
322 * from a hash map.
323 */
326 // XInterface
334 // XTypeProvider
342 // XServiceInfo
343 virtual OUString SAL_CALL
346 virtual sal_Bool SAL_CALL
353 // XComponent
366 // XContent
371 virtual OUString SAL_CALL
385 // XCommandProcessor
386 virtual sal_Int32 SAL_CALL
391 sal_Int32 CommandId,
401 // XPropertiesChangeNotifier
415 // XCommandInfoChangeNotifier
427 // XPropertyContainer
429 /**
430 * This method adds a property to the content according to the interface
431 * specification. The properties will be stored using the service
432 * com.sun.star.ucb.Store.
433 *
434 * Note: You may provide your own implementation of this method, for
435 * instance, if your data source supports adding/removing of properties.
436 * Don't forget to return the meta data for these properties in your
437 * implementation of getPropertyInfoTable.
438 */
441 sal_Int16 Attributes,
448 /**
449 * This method removes a property from the content according to the
450 * interface specification. The properties will be stored using the
451 * service com.sun.star.ucb.Store.
452 *
453 * Note: You may provide your own implementation of this method, for
454 * instance, if your data source supports adding/removing of properties.
455 * Don't forget to return the meta data for these properties in your
456 * implementation of getPropertyInfoTable.
457 */
464 // XPropertySetInfoChangeNotifier
476 // XChild
478 /**
479 * This method returns the content representing the parent of a content,
480 * if such a parent exists. The implementation of this method uses your
481 * implementation of getParentURL.
482 */
488 /**
489 * The implementation of this method always throws a NoSupportException.
490 */
498 // Non-interface methods.
501 /**
502 * This method returns the provider of the content.
503 *
504 * @return the provider of the content.
505 */
508 };
514 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */