Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 208 insertions, 0 deletions

diff --git a/offapi/com/sun/star/ucb/PackageFolderContent.idl b/offapi/com/sun/star/ucb/PackageFolderContent.idl
new file mode 100644
index 000000000..1252125c1
--- /dev/null
+++ b/offapi/com/sun/star/ucb/PackageFolderContent.idl
@@ -0,0 +1,208 @@
+/* -*- 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_ucb_PackageFolderContent_idl__
+#define __com_sun_star_ucb_PackageFolderContent_idl__
+
+#include <com/sun/star/lang/XComponent.idl>
+#include <com/sun/star/ucb/XContent.idl>
+#include <com/sun/star/ucb/XCommandProcessor.idl>
+#include <com/sun/star/ucb/XCommandProcessor2.idl>
+#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
+#include <com/sun/star/beans/XPropertyContainer.idl>
+#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
+#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
+#include <com/sun/star/container/XChild.idl>
+#include <com/sun/star/ucb/XContentCreator.idl>
+
+
+module com { module sun { module star { module ucb {
+
+/** A PCP Folder is a container for other PCP Folders and PCP Streams.
+
+    @see com::sun::star::ucb::PackageContentProvider
+    @see com::sun::star::ucb::PackageStreamContent
+*/
+published service PackageFolderContent
+{
+    /** This interface is implemented according to the specification of
+        service Content.
+     */
+    interface com::sun::star::lang::XComponent;
+
+    /** This interface is implemented according to the specification of
+        service Content.
+     */
+    interface com::sun::star::ucb::XContent;
+
+    /** This interface is implemented according to the specification of
+        service Content.
+
+        <p>
+
+        <b>Supported Commands</b>
+        <ul>
+        <li>
+        getCommandInfo
+        </li>
+        <li>
+        getPropertySetInfo
+        </li>
+        <li>
+        getPropertyValues
+        </li>
+        <li>
+        setPropertyValues
+        </li>
+        <li>
+        insert ( makes a newly created folder persistent )
+        </li>
+        <li>
+        delete
+        </li>
+        <li>
+        open
+        </li>
+        <li>
+        transfer ( only transfers from PCP Folders/PCP Streams to other
+        PCP folders. It does not handle contents with a URL scheme other
+        then the PCP-URL-scheme. )
+        </li>
+        <li>
+        flush ( a command introduced by the PCP Folder. It takes a
+        void-argument and returns void. This command is used to write unsaved
+        changes to the underlying package file. Note that the current
+        implementation of PCP contents never flushes automatically! Operations
+        which require a flush to get persistent, are:
+        "setPropertyValues( < any_non_read_only_property > ) ", "delete",
+        "insert" )
+        </li>
+        </ul>
+
+        <b>Supported Properties</b>
+        <ul>
+        <li>
+        string ContentType ( read-only, always "application/vnd.sun.star.pkg-folder" )
+        </li>
+        <li>
+        boolean IsDocument ( read-only, always false )
+        </li>
+        <li>
+        boolean IsFolder ( read-only, always true )
+        </li>
+        <li>
+        string MediaType
+        </li>
+        <li>
+        string Title
+        </li>
+        </ul>
+
+        </p>
+     */
+    interface com::sun::star::ucb::XCommandProcessor;
+
+    /** is an enhanced version of XCommandProcessor that has an
+        additional method for releasing command identifiers obtained via
+        XCommandProcessor::createCommandIdentifier() to avoid
+        resource leaks. For a detailed description of the problem refer to
+        XCommandProcessor2::releaseCommandIdentifier().
+
+        <p>Where many existing Content implementations do not
+        (yet), every new implementation should support this interface.
+     */
+    [optional] interface com::sun::star::ucb::XCommandProcessor2;
+
+    /** This interface is implemented according to the specification of
+        service Content.
+     */
+    interface com::sun::star::beans::XPropertiesChangeNotifier;
+
+    /** This interface is implemented according to the specification of
+        service Content.
+     */
+    interface com::sun::star::beans::XPropertyContainer;
+
+    /** This interface is implemented according to the specification of
+        service Content.
+     */
+    interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
+
+    /** This interface is implemented according to the specification of
+        service Content.
+     */
+    interface com::sun::star::ucb::XCommandInfoChangeNotifier;
+
+    /** This interface is implemented according to the specification of
+        service Content.
+     */
+    interface com::sun::star::container::XChild;
+
+    /** This interface is implemented according to the specification of
+        service Content.
+
+        <p>
+
+        A PCP Folder can create other PCP Folders and PCP Streams. To create
+        a new child of a PCP Folder:
+
+        <ol>
+        <li>
+        Let the parent folder create a new content by calling
+        XContentCreator::createNewContent() on it. The content
+        type to use for new folders is "application/vnd.sun.star.pkg-folder".
+        To create a new PCP Stream, use the type
+        "application/vnd.sun.star.pkg-stream".
+        </li>
+        <li>
+        Set a title at the new folder / stream. ( Let the new child execute
+        the command "setPropertyValues", which sets at least the property
+        "Title" to a non-empty value ).
+        </li>
+        <li>
+        Let the new child ( not the parent! ) execute the command "insert".
+        This will commit the creation process. For streams, you need to supply
+        the implementation of an
+        com::sun::star::io::XInputStream with the command's
+        parameters, that provides access to the stream data.
+        </li>
+        </ol>
+
+        </p>
+
+        <p>
+        Another, more convenient way for creating streams is simply to assemble
+        the URL for the new content ( last part of the path will become the
+        title of the new stream ) and to obtain a Content object for that URL
+        from the UCB. Then let the content execute the command "insert". The
+        command will fail, if you set the command's parameter
+        InsertCommandArgument::ReplaceExisting"
+        to false and there is already a stream with the title given by the
+        content's URL.
+
+        </p>
+     */
+    interface com::sun::star::ucb::XContentCreator;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */