fpicker/source/office/fileview.hxx

   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 #pragma once
  20
  21 #include <memory>
  22 #include <com/sun/star/uno/Sequence.h>
  23 #include <utility>
  24 #include <vcl/weld.hxx>
  25 #include <rtl/ustring.hxx>
  26
  27 namespace com :: sun :: star :: ucb { class XContent; }
  28
  29 // class SvtFileView -----------------------------------------------------
  30
  31 class SvtFileView_Impl;
  32 struct SvtContentEntry;
  33
  34 /// the result of an action in the FileView
  35 enum FileViewResult
  36 {
  37     eSuccess,
  38     eFailure,
  39     eTimeout,
  40     eStillRunning
  41 };
  42
  43 enum FileViewMode
  44 {
  45     eDetailedList,
  46     eIcon
  47 };
  48
  49 /// describes parameters for doing an action on the FileView asynchronously
  50 struct FileViewAsyncAction
  51 {
  52     sal_uInt32  nMinTimeout;    /// minimum time to wait for a result, in milliseconds
  53     sal_uInt32  nMaxTimeout;    /// maximum time to wait for a result, in milliseconds, until eTimeout is returned
  54     Link<void*,void>  aFinishHandler; /// the handler to be called when the action is finished. Called in every case, no matter of the result
  55
  56     FileViewAsyncAction() : nMinTimeout(0), nMaxTimeout (0)
  57     {
  58     }
  59 };
  60
  61 class SvtFileView
  62 {
  63 private:
  64     std::unique_ptr<SvtFileView_Impl> mpImpl;
  65     css::uno::Sequence<OUString> maDenyList;
  66
  67     DECL_LINK(HeaderSelect_Impl, int, void);
  68
  69 public:
  70     SvtFileView(weld::Window* pTopLevel,
  71                 std::unique_ptr<weld::TreeView> xTreeView,
  72                 std::unique_ptr<weld::IconView> xIconView,
  73                 bool bOnlyFolder, bool bMultiSelection, bool bShowType = true);
  74     ~SvtFileView();
  75
  76     void                    SetViewMode( FileViewMode eMode );
  77
  78     const OUString&         GetViewURL() const;
  79     OUString                GetURL(const weld::TreeIter& rEntry) const;
  80     OUString                GetCurrentURL() const;
  81
  82     bool                    GetParentURL( OUString& _rParentURL ) const;
  83     void                    CreatedFolder( const OUString& rUrl, const OUString& rNewFolder );
  84
  85     void                    set_help_id(const OUString& rHelpId);
  86     OUString                get_help_id() const;
  87
  88     void                    grab_focus();
  89     bool                    has_focus() const;
  90
  91     OUString                get_selected_text() const;
  92
  93     weld::Widget*           identifier() const; // just to uniquely identify this widget
  94
  95     /** initialize the view with the content of a folder given by URL, and apply an immediate filter
  96
  97         @param rFolderURL
  98             the URL of the folder whose content is to be read
  99         @param rFilter
 100             the initial filter to be applied
 101         @param pAsyncDescriptor
 102             If not <NULL/>, this struct describes the parameters for doing the
 103             action asynchronously.
 104     */
 105     FileViewResult          Initialize(
 106                                 const OUString& rFolderURL,
 107                                 const OUString& rFilter,
 108                                 const FileViewAsyncAction* pAsyncDescriptor,
 109                                 const css::uno::Sequence< OUString >& rDenyList
 110                             );
 111
 112     /** reads the current content of the current folder again, and applies the given filter to it
 113
 114         Note 1: The folder is really read a second time. This implies that any new elements (which were
 115         not present when you called Initialize the last time) are now displayed.
 116
 117         Note 2: This method must not be called when you previously initialized the view from a sequence
 118         of strings, or a UNO content object.
 119
 120         @param rFilter
 121             the filter to be applied
 122         @param pAsyncDescriptor
 123             If not <NULL/>, this struct describes the parameters for doing the
 124             action asynchronously.
 125     */
 126     FileViewResult          ExecuteFilter(
 127                                 const OUString& rFilter,
 128                                 const FileViewAsyncAction* pAsyncDescriptor
 129                             );
 130
 131     /** cancels a running async action (if any)
 132
 133         @seealso Initialize
 134         @seealso ExecuteFilter
 135         @seealso FileViewAsyncAction
 136     */
 137     void                    CancelRunningAsyncAction();
 138
 139     /** initializes the view with the parent folder of the current folder
 140
 141         @param rNewURL
 142             the URL of the folder which we just navigated to
 143         @param pAsyncDescriptor
 144             If not <NULL/>, this struct describes the parameters for doing the
 145             action asynchronously.
 146     */
 147     FileViewResult          PreviousLevel(
 148                                 const FileViewAsyncAction* pAsyncDescriptor
 149                             );
 150
 151     void                    SetNoSelection();
 152
 153     void                    SetSelectHdl( const Link<SvtFileView*,void>& rHdl );
 154     void                    SetDoubleClickHdl( const Link<SvtFileView*,bool>& rHdl );
 155     void                    SetOpenDoneHdl( const Link<SvtFileView*,void>& rHdl );
 156
 157     sal_uInt32              GetSelectionCount() const;
 158     SvtContentEntry*        FirstSelected() const;
 159
 160     void selected_foreach(const std::function<bool(weld::TreeIter&)>& func);
 161
 162     void                    EnableDelete( bool bEnable );
 163
 164                             // save and load column size and sort order
 165     OUString                GetConfigString() const;
 166     void                    SetConfigString( std::u16string_view rCfgStr );
 167
 168     void                    EndInplaceEditing();
 169
 170     ::std::vector< SvtContentEntry > GetContent();
 171 };
 172
 173 // struct SvtContentEntry ------------------------------------------------
 174
 175 struct SvtContentEntry
 176 {
 177     bool     mbIsFolder;
 178     OUString maURL;
 179
 180     SvtContentEntry( OUString aURL, bool bIsFolder ) :
 181         mbIsFolder( bIsFolder ), maURL(std::move( aURL )) {}
 182 };
 183
 184 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */