diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
commit | 267c6f2ac71f92999e969232431ba04678e7437e (patch) | |
tree | 358c9467650e1d0a1d7227a21dac2e3d08b622b2 /offapi/com/sun/star/embed/FileSystemStorage.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.tar.xz libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.zip |
Adding upstream version 4:24.2.0.upstream/4%24.2.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/embed/FileSystemStorage.idl')
-rw-r--r-- | offapi/com/sun/star/embed/FileSystemStorage.idl | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/offapi/com/sun/star/embed/FileSystemStorage.idl b/offapi/com/sun/star/embed/FileSystemStorage.idl new file mode 100644 index 0000000000..c2b44f5217 --- /dev/null +++ b/offapi/com/sun/star/embed/FileSystemStorage.idl @@ -0,0 +1,97 @@ +/* -*- 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 . + */ + + + module com { module sun { module star { module embed { + +/** This is a service that allows to get access to a file system folder using + storage hierarchy. + */ +published service FileSystemStorage +{ + /** This service describes the base functionality of storages. + + <p> + Please see below the description of additional requirements for the + file system storage implementation. + </p> + + <dl> + <dt>interface com::sun::star::lang::XComponent + </dt> + <dd> + <p> + A file system storage is created either by + StorageFactory or by XStorage + interface and is controlled by refcounting. In case + refcounting is decreased to zero the storage will be + disposed automatically. + </p> + + <p> + In case a storage object is disposed the elements + ( substorages and substreams ) are not affected. + </p> + </dd> + <dt>interface XStorage</dt> + <dd> + <dl> + <dt>XStorage::openStorageElement()</dt> + <dd> + This method returns FileSystemStorage + service implementation. + </dd> + + <dt>XStorage::copyLastCommitTo()</dt> + <dd> + Since this service implementation supports no transaction + this method just creates a copy of the storage in its + current state. + </dd> + + <dt>XStorage::copyStorageElementLastCommitTo()</dt> + <dd> + Since this service implementation supports no transaction + this method just creates a copy of the storage in its + current state. + </dd> + + <dt>XStorage::removeStorageElement()</dt> + <dd> + If the element is opened and it is a stream element + the removing will fail. If the element is opened and + it is a storage element, all the contents that can be + removed will be removed. + </dd> + </dl> + </dd> + <dt>property URL</dt> + <dd> + This property is not optional for this service. + </dd> + </dl> + + */ + service BaseStorage; +}; + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |