Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

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

1 files changed, 187 insertions, 0 deletions

diff --git a/fpicker/source/office/fileview.hxx b/fpicker/source/office/fileview.hxx
new file mode 100644
index 000000000..9bf4dca06
--- /dev/null
+++ b/fpicker/source/office/fileview.hxx
@@ -0,0 +1,187 @@
+/* -*- 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 INCLUDED_VCL_FILEVIEW_HXX
+#define INCLUDED_VCL_FILEVIEW_HXX
+
+#include <memory>
+#include <com/sun/star/uno/Sequence.h>
+#include <vcl/errinf.hxx>
+#include <vcl/weld.hxx>
+#include <rtl/ustring.hxx>
+
+namespace com :: sun :: star :: ucb { class XContent; }
+
+// class SvtFileView -----------------------------------------------------
+
+class SvtFileView_Impl;
+struct SvtContentEntry;
+
+/// the result of an action in the FileView
+enum FileViewResult
+{
+    eSuccess,
+    eFailure,
+    eTimeout,
+    eStillRunning
+};
+
+enum FileViewMode
+{
+    eDetailedList,
+    eIcon
+};
+
+/// describes parameters for doing an action on the FileView asynchronously
+struct FileViewAsyncAction
+{
+    sal_uInt32  nMinTimeout;    /// minimum time to wait for a result, in milliseconds
+    sal_uInt32  nMaxTimeout;    /// maximum time to wait for a result, in milliseconds, until eTimeout is returned
+    Link<void*,void>  aFinishHandler; /// the handler to be called when the action is finished. Called in every case, no matter of the result
+
+    FileViewAsyncAction() : nMinTimeout(0), nMaxTimeout (0)
+    {
+    }
+};
+
+class SvtFileView
+{
+private:
+    std::unique_ptr<SvtFileView_Impl> mpImpl;
+    css::uno::Sequence<OUString> maBlackList;
+
+    DECL_LINK(HeaderSelect_Impl, int, void);
+
+public:
+    SvtFileView(weld::Window* pTopLevel,
+                std::unique_ptr<weld::TreeView> xTreeView,
+                std::unique_ptr<weld::IconView> xIconView,
+                bool bOnlyFolder, bool bMultiSelection, bool bShowType = true);
+    ~SvtFileView();
+
+    void                    SetViewMode( FileViewMode eMode );
+
+    const OUString&         GetViewURL() const;
+    OUString                GetURL(const weld::TreeIter& rEntry) const;
+    OUString                GetCurrentURL() const;
+
+    bool                    GetParentURL( OUString& _rParentURL ) const;
+    void                    CreatedFolder( const OUString& rUrl, const OUString& rNewFolder );
+
+    void                    set_help_id(const OString& rHelpId);
+    OString                 get_help_id() const;
+
+    void                    grab_focus();
+    bool                    has_focus() const;
+
+    OUString                get_selected_text() const;
+
+    weld::Widget*           identifier() const; // just to uniquely identify this widget
+
+    /** initialize the view with the content of a folder given by URL, and apply an immediate filter
+
+        @param rFolderURL
+            the URL of the folder whose content is to be read
+        @param rFilter
+            the initial filter to be applied
+        @param pAsyncDescriptor
+            If not <NULL/>, this struct describes the parameters for doing the
+            action asynchronously.
+    */
+    FileViewResult          Initialize(
+                                const OUString& rFolderURL,
+                                const OUString& rFilter,
+                                const FileViewAsyncAction* pAsyncDescriptor,
+                                const css::uno::Sequence< OUString >& rBlackList
+                            );
+
+    /** reads the current content of the current folder again, and applies the given filter to it
+
+        Note 1: The folder is really read a second time. This implies that any new elements (which were
+        not present when you called Initialize the last time) are now displayed.
+
+        Note 2: This method must not be called when you previously initialized the view from a sequence
+        of strings, or a UNO content object.
+
+        @param rFilter
+            the filter to be applied
+        @param pAsyncDescriptor
+            If not <NULL/>, this struct describes the parameters for doing the
+            action asynchronously.
+    */
+    FileViewResult          ExecuteFilter(
+                                const OUString& rFilter,
+                                const FileViewAsyncAction* pAsyncDescriptor
+                            );
+
+    /** cancels a running async action (if any)
+
+        @seealso Initialize
+        @seealso ExecuteFilter
+        @seealso FileViewAsyncAction
+    */
+    void                    CancelRunningAsyncAction();
+
+    /** initializes the view with the parent folder of the current folder
+
+        @param rNewURL
+            the URL of the folder which we just navigated to
+        @param pAsyncDescriptor
+            If not <NULL/>, this struct describes the parameters for doing the
+            action asynchronously.
+    */
+    FileViewResult          PreviousLevel(
+                                const FileViewAsyncAction* pAsyncDescriptor
+                            );
+
+    void                    SetNoSelection();
+
+    void                    SetSelectHdl( const Link<SvtFileView*,void>& rHdl );
+    void                    SetDoubleClickHdl( const Link<SvtFileView*,bool>& rHdl );
+    void                    SetOpenDoneHdl( const Link<SvtFileView*,void>& rHdl );
+
+    sal_uInt32              GetSelectionCount() const;
+    SvtContentEntry*        FirstSelected() const;
+
+    void selected_foreach(const std::function<bool(weld::TreeIter&)>& func);
+
+    void                    EnableDelete( bool bEnable );
+
+                            // save and load column size and sort order
+    OUString                GetConfigString() const;
+    void                    SetConfigString( const OUString& rCfgStr );
+
+    void                    EndInplaceEditing();
+
+    ::std::vector< SvtContentEntry > GetContent();
+};
+
+// struct SvtContentEntry ------------------------------------------------
+
+struct SvtContentEntry
+{
+    bool     mbIsFolder;
+    OUString maURL;
+
+    SvtContentEntry( const OUString& rURL, bool bIsFolder ) :
+        mbIsFolder( bIsFolder ), maURL( rURL ) {}
+};
+
+#endif // INCLUDED_VCL_FILEVIEW_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */