LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
XLibraryContainer.idl
Go to the documentation of this file.
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 */
19
20
21
22module com { module sun { module star { module script {
23
24
28published interface XLibraryContainer: com::sun::star::container::XNameAccess
29{
33 com::sun::star::container::XNameContainer createLibrary( [in] string Name )
34 raises( com::sun::star::lang::IllegalArgumentException,
35 com::sun::star::container::ElementExistException );
36
47 com::sun::star::container::XNameAccess createLibraryLink( [in] string Name, [in] string StorageURL, [in] boolean ReadOnly )
48 raises( com::sun::star::lang::IllegalArgumentException,
49 com::sun::star::container::ElementExistException );
50
54 void removeLibrary( [in] string Name )
55 raises( com::sun::star::container::NoSuchElementException,
56 com::sun::star::lang::WrappedTargetException );
57
62 boolean isLibraryLoaded( [in] string Name )
63 raises( com::sun::star::container::NoSuchElementException );
64
69 void loadLibrary( [in] string Name )
70 raises( com::sun::star::container::NoSuchElementException,
71 com::sun::star::lang::WrappedTargetException );
72
73};
74
75
76
77}; }; }; };
78
79/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition ElementExistException.idl:35
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition NoSuchElementException.idl:31
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
com::sun::star::lang::WrappedTargetException
This is a checked exception that wraps an exception thrown by the original target.
Definition WrappedTargetException.idl:34
com::sun::star::container::XNameAccess
is used to access named objects within a container.
Definition XNameAccess.idl:32
com::sun::star::container::XNameContainer
This is the generic interface for supporting the insertion and removal of named elements.
Definition XNameContainer.idl:29
com::sun::star::script::XLibraryContainer
Provides access to a library system.
Definition XLibraryContainer.idl:29
com::sun::star::script::XLibraryContainer::loadLibrary
void loadLibrary([in] string Name)
Causes the accessed library to be loaded from its storage if it hasn't already been loaded.
com::sun::star::script::XLibraryContainer::createLibrary
com::sun::star::container::XNameContainer createLibrary([in] string Name)
Creates a new library.
com::sun::star::script::XLibraryContainer::createLibraryLink
com::sun::star::container::XNameAccess createLibraryLink([in] string Name, [in] string StorageURL, [in] boolean ReadOnly)
Creates a link to an "external" library that then can be accessed using this library manager.
com::sun::star::script::XLibraryContainer::removeLibrary
void removeLibrary([in] string Name)
removes the library item with the specified name.
com::sun::star::script::XLibraryContainer::isLibraryLoaded
boolean isLibraryLoaded([in] string Name)
returns true if the accessed library is already loaded from the storage, otherwise false.
com
Definition Ambiguous.idl:20