From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/ucb/HierarchyDataSource.idl | 104 ++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 offapi/com/sun/star/ucb/HierarchyDataSource.idl (limited to 'offapi/com/sun/star/ucb/HierarchyDataSource.idl') diff --git a/offapi/com/sun/star/ucb/HierarchyDataSource.idl b/offapi/com/sun/star/ucb/HierarchyDataSource.idl new file mode 100644 index 000000000..4a9842cb6 --- /dev/null +++ b/offapi/com/sun/star/ucb/HierarchyDataSource.idl @@ -0,0 +1,104 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_ucb_HierarchyDataSource_idl__ +#define __com_sun_star_ucb_HierarchyDataSource_idl__ + +#include +#include + + +module com { module sun { module star { module ucb { + +/** manages one or more complete sets of hierarchy data and serves as a factory + for objects that provide access to a subset of the data. + +

Note: This is an abstract service. This means, that there should + never be implementations that can be instantiated using the service name + com.sun.star.ucb.HierarchyDataSource. Each implementation must + provide its own service name that can be used to create instances of that + service implementation. Important for those service specifications is also + to specify which of the optional parts are supported by the implementation. +*/ +published service HierarchyDataSource +{ + /** allows creating access objects for specific views such as subsets and + fragments of the hierarchy data. + +

The parameter aServiceSpecifier passed to + com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments() + supports at least the service specifier + "com.sun.star.ucb.HierarchyDataReadAccess", which will + create a read-only view to the data. The object that is created + implements the service HierarchyDataReadAccess. + +

Optionally the factory may support writable views. A + writable view is requested by passing the service specifier + "com.sun.star.ucb.HierarchyDataReadWriteAccess" to + com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments() + The object that is created implements the service + HierarchyDataReadWriteAccess. + +

The arguments passed to + com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments() + in parameter aArguments specify the view of the data that + should be created. That is, they determine the subset of elements that + can be accessed starting from the returned object. Each element of the + argument sequence should be a + com::sun::star::beans::PropertyValue, so that the + parameters can be identified by name rather than by position. + +

With both of the standard service specifiers above, an implementation + must accept a property named nodepath of type + `string`. This property must contain the absolute path to an + element of the data. The view that is selected consists of the named + element and all its descendants. A path consists of segments that are + separated by a single slash ("/"). There is neither a leading nor a + trailing slash allowed. The root of the hierarchy data always + has an empty path. Refer to HierarchyDataReadAccess for + more information on hierarchical names. + +

Other arguments can be used to control the behavior of the view. + These are different for different implementations. Whether and how they + are used may also depend on the configuration store and configuration + that were selected when the provider was created. + +

An implementation must ignore unknown arguments. + +

The implementation of + com::sun::star::lang::XMultiServiceFactory::createInstance() + must behave exactly as if + com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments() + were called passing one single property named nodepath + where the property value is an empty string. Thus it always creates a + view to the root of the hierarchy data. + */ + interface com::sun::star::lang::XMultiServiceFactory; + + /** allows controlling or observing the lifetime of the hierarchy data + source and its views. + */ + interface com::sun::star::lang::XComponent; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3