summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/script/XLibraryContainer.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/script/XLibraryContainer.idl95
1 files changed, 95 insertions, 0 deletions
diff --git a/offapi/com/sun/star/script/XLibraryContainer.idl b/offapi/com/sun/star/script/XLibraryContainer.idl
new file mode 100644
index 000000000..9b768fe89
--- /dev/null
+++ b/offapi/com/sun/star/script/XLibraryContainer.idl
@@ -0,0 +1,95 @@
+/* -*- 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_XLibraryContainer_idl__
+#define __com_sun_star_script_XLibraryContainer_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/container/XNameContainer.idl>
+
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+#include <com/sun/star/container/NoSuchElementException.idl>
+
+#include <com/sun/star/container/ElementExistException.idl>
+
+#include <com/sun/star/lang/WrappedTargetException.idl>
+
+
+
+module com { module sun { module star { module script {
+
+
+/**
+ Provides access to a library system.
+ */
+published interface XLibraryContainer: com::sun::star::container::XNameAccess
+{
+ /**
+ Creates a new library
+ */
+ com::sun::star::container::XNameContainer createLibrary( [in] string Name )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::container::ElementExistException );
+
+ /**
+ Creates a link to an "external" library that then can be
+ accessed using this library manager. The format of the
+ StorageURL is a matter of the implementation. If the read
+ only flag is set, the linked library cannot be modified.
+ In this case, the returned interface really is only an
+ XNameAccess. If ReadOnly is false (and the referenced
+ storage allows write access) the returned interface also
+ can be a com::sun::star::container::XNameContainer.
+ */
+ com::sun::star::container::XNameAccess createLibraryLink( [in] string Name, [in] string StorageURL, [in] boolean ReadOnly )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::container::ElementExistException );
+
+ /** removes the library item with the specified name. If the accessed
+ library item is a link only the link is removed, not the target library.
+ */
+ void removeLibrary( [in] string Name )
+ raises( com::sun::star::container::NoSuchElementException,
+ com::sun::star::lang::WrappedTargetException );
+
+ /**
+ returns true if the accessed library is already loaded from
+ the storage, otherwise false.
+ */
+ boolean isLibraryLoaded( [in] string Name )
+ raises( com::sun::star::container::NoSuchElementException );
+
+ /**
+ Causes the accessed library to be loaded from its storage
+ if it hasn't already been loaded.
+ */
+ void loadLibrary( [in] string Name )
+ raises( com::sun::star::container::NoSuchElementException,
+ com::sun::star::lang::WrappedTargetException );
+
+};
+
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */