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 --- .../star/script/XStorageBasedLibraryContainer.idl | 91 ++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl (limited to 'offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl') diff --git a/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl new file mode 100644 index 000000000..4a531f587 --- /dev/null +++ b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl @@ -0,0 +1,91 @@ +/* -*- 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_script_XStorageBasedLibraryContainer_idl__ +#define __com_sun_star_script_XStorageBasedLibraryContainer_idl__ + +#include +#include + + +module com { module sun { module star { module script { + + +/** is the interface for an XLibraryContainer which can be made + persistent in a com::sun::star::embed::XStorage. + +

A persistent library container is associated with a root storage. The + container is responsible for a particular sub storage of the root storage, + the container storage.

+ + @since OOo 2.3 + */ +interface XStorageBasedLibraryContainer +{ + interface XPersistentLibraryContainer; + + /** denotes the root storage associated with the container. + +

Effectively, this attribute is a typed version of + XPersistentLibraryContainer::RootLocation, it's guaranteed + that at every time, XPersistentLibraryContainer::RootLocation and + RootStorage have the same value.

+ +

You should only set this attribute to a new value if you previously + called storeLibrariesToStorage with the same storage. Setting this attribute + to a storage into which the container has not been stored previously might + result in unexpected behavior.

+ */ + [attribute] ::com::sun::star::embed::XStorage RootStorage + { + set raises ( ::com::sun::star::lang::IllegalArgumentException ); + }; + + /** stores the libraries to a storage other than the current container storage + +

Note that the library container is not automatically associated with the + new root storage. Instead, you need to manually set the RootStorage + attribute afterwards. This separation allows for Save-To as well Save-As + operations.

+ + @param RootStorage + denotes the root storage into which the libraries should be written, which + must not be `NULL`.
+ Note that the actual libraries are written into a sub storage of this + root storage, as usual. + + @throws ::com::sun::star::lang::IllegalArgumentException + if the RootStorage parameter is `NULL`, or equals + #RootStorage. + + @throws ::com::sun::star::lang::WrappedTargetException + if an error occurs during storing. + */ + void storeLibrariesToStorage( [in] ::com::sun::star::embed::XStorage RootStorage ) + raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException ); +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3