summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/packages/PackageFolder.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/packages/PackageFolder.idl
parentInitial commit. (diff)
downloadlibreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz
libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/packages/PackageFolder.idl')
-rw-r--r--offapi/com/sun/star/packages/PackageFolder.idl86
1 files changed, 86 insertions, 0 deletions
diff --git a/offapi/com/sun/star/packages/PackageFolder.idl b/offapi/com/sun/star/packages/PackageFolder.idl
new file mode 100644
index 000000000..8b652d3bd
--- /dev/null
+++ b/offapi/com/sun/star/packages/PackageFolder.idl
@@ -0,0 +1,86 @@
+/* -*- 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_packages_PackageFolder_idl__
+#define __com_sun_star_packages_PackageFolder_idl__
+
+#include <com/sun/star/container/XNamed.idl>
+#include <com/sun/star/container/XChild.idl>
+#include <com/sun/star/container/XNameContainer.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/container/XEnumerationAccess.idl>
+
+module com { module sun { module star { module packages {
+
+/**
+ The PackageFolder service represents a single folder or directory within
+ a Package. Instances of this service can only be constructed by an
+ implementation of the Package service and not via the service manager.
+*/
+published service PackageFolder
+{
+ /**
+ This interface is used to get or set the name of the folder.
+ */
+ interface com::sun::star::container::XNamed;
+ /**
+ The getParent method of XChild will return the PackageFolder that
+ contains this PackageFolder or nothing if this PackageFolder is
+ the root PackageFolder.
+
+ setParent will move the PackageFolder.
+ */
+ interface com::sun::star::container::XChild;
+ /**
+ This interface describes all of the PackageFolders and PackageStreams
+ which are contained within this instance of the PackageFolder service.
+
+ XElementAccess::getElementType returns service PackageStream
+ XNameAccess::getByName returns either a PackageFolder or a PackageStream
+ as a css::uno::Any
+ XNameAccess::getElementNames returns a uno::Sequence of strings containing
+ the names of all children stored in the PackageFolder
+ */
+ interface com::sun::star::container::XNameContainer;
+ /**
+ This interface will return an implementation of service
+ PackageFolderEnumeration, which represents an iterator over the children
+ of the PackageFolder, or the PackageStreams and PackageFolders contained
+ within this instance of the PackageFolder service.
+
+ This provides a "snapshot" of the contents of the
+ PackageFolder at the time of construction. It is the responsibility of the
+ caller to ensure that any given member of the enumeration refers to a valid
+ PackageStream or PackageFolder.
+
+ */
+ interface com::sun::star::container::XEnumerationAccess;
+
+ /**
+ This interface provides access to the properties of the package entry.
+ Currently, this only supports one entry which is a string called
+ MediaType. This contains the MIME type of the stream (e.g. "text/html").
+ For PackageFolders, this is always an empty string.
+ */
+ interface com::sun::star::beans::XPropertySet;
+};
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */