include/sfx2/filedlghelper.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 #ifndef INCLUDED_SFX2_FILEDLGHELPER_HXX
  20 #define INCLUDED_SFX2_FILEDLGHELPER_HXX
  21
  22 #include <sal/config.h>
  23 #include <sfx2/dllapi.h>
  24 #include <sal/types.h>
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <com/sun/star/uno/Sequence.hxx>
  27 #include <rtl/ustring.hxx>
  28 #include <tools/errcode.hxx>
  29 #include <vcl/dialog.hxx>
  30 #include <vcl/edit.hxx>
  31 #include <vcl/button.hxx>
  32 #include <vcl/graph.hxx>
  33 #include <sfx2/sfxuno.hxx>
  34 #include <sfx2/docfilt.hxx>
  35
  36 #include <memory>
  37
  38 namespace com
  39 {
  40     namespace sun
  41     {
  42         namespace star
  43         {
  44             namespace ui
  45             {
  46                 namespace dialogs
  47                 {
  48                     class XFilePicker2;
  49                     class XFilePickerListener;
  50                     struct FilePickerEvent;
  51                     struct DialogClosedEvent;
  52                 }
  53             }
  54         }
  55     }
  56 }
  57
  58 class SfxItemSet;
  59 namespace vcl { class Window; }
  60
  61 enum class FileDialogFlags {
  62     NONE              = 0x00,
  63     Insert            = 0x01,    // turn Open into Insert dialog
  64     Export            = 0x02,    // turn Save into Export dialog
  65     SaveACopy         = 0x04,    // turn Save into Save a Copy dialog
  66     MultiSelection    = 0x08,
  67     Graphic           = 0x10     // register graphic formats
  68 };
  69 namespace o3tl {
  70     template<> struct typed_flags<FileDialogFlags> : is_typed_flags<FileDialogFlags, 0x1f> {};
  71 }
  72
  73 #define FILEDIALOG_FILTER_ALL   "*.*"
  74
  75 namespace sfx2 {
  76
  77 class FileDialogHelper_Impl;
  78
  79 class SFX2_DLLPUBLIC FileDialogHelper
  80 {
  81 public:
  82     enum Context                        // context where the FileDialogHelper is used
  83     {
  84         UNKNOWN_CONTEXT,                // unknown context
  85         SW_INSERT_GRAPHIC,              // insert graphic in writer
  86         SW_INSERT_SOUND,                // insert sound in writer
  87         SW_INSERT_VIDEO,                // insert video in writer
  88         SC_INSERT_GRAPHIC,              // insert graphic in calc
  89         SC_INSERT_SOUND,                // insert sound in calc
  90         SC_INSERT_VIDEO,                // insert video in calc
  91         SD_INSERT_GRAPHIC,              // insert graphic in draw
  92         SD_INSERT_SOUND,                // insert sound in draw
  93         SD_INSERT_VIDEO,                // insert video in draw
  94         SD_EXPORT,                      // export in draw
  95         SI_EXPORT,                      // export in impress
  96         SW_EXPORT                       // export in writer
  97     };
  98
  99 private:
 100     Link<FileDialogHelper*,void>  m_aDialogClosedLink;
 101     ErrCode m_nError;
 102
 103     css::uno::Reference< FileDialogHelper_Impl > mpImpl;
 104
 105
 106 public:
 107                             FileDialogHelper( sal_Int16 nDialogType,
 108                                               FileDialogFlags nFlags = FileDialogFlags::NONE,
 109                                               vcl::Window* _pPreferredParent = nullptr );
 110
 111                             FileDialogHelper( sal_Int16 nDialogType,
 112                                               FileDialogFlags nFlags,
 113                                               const OUString& rFactory,
 114                                               SfxFilterFlags nMust = SfxFilterFlags::NONE,
 115                                               SfxFilterFlags nDont = SfxFilterFlags::NONE );
 116
 117                             FileDialogHelper( sal_Int16 nDialogType,
 118                                               FileDialogFlags nFlags,
 119                                               const OUString& rFactory,
 120                                               sal_Int16 nDialog,
 121                                               SfxFilterFlags nMust,
 122                                               SfxFilterFlags nDont,
 123                                               const OUString& rStandardDir,
 124                                               const css::uno::Sequence< OUString >& rBlackList,
 125                                               vcl::Window* _pPreferredParent = nullptr);
 126
 127                             FileDialogHelper( sal_Int16 nDialogType,
 128                                               FileDialogFlags nFlags,
 129                                               const OUString& aFilterUIName,
 130                                               const OUString& aExtName,
 131                                               const OUString& rStandardDir,
 132                                               const css::uno::Sequence< OUString >& rBlackList,
 133                                               vcl::Window* _pPreferredParent = nullptr );
 134
 135
 136     virtual                 ~FileDialogHelper();
 137
 138     ErrCode                 Execute();
 139     void                    StartExecuteModal( const Link<FileDialogHelper*,void>& rEndDialogHdl );
 140     inline ErrCode          GetError() const { return m_nError; }
 141     sal_Int16               GetDialogType() const;
 142     bool                    IsPasswordEnabled() const;
 143     OUString                GetRealFilter() const;
 144
 145     void                    SetTitle( const OUString&  rNewTitle );
 146     OUString                GetPath() const;
 147
 148     /** @deprecated: Don't use this method to retrieve the selected files
 149         There are file picker which can provide multiple selected file which belong
 150         to different folders. As this method always provides the root folder for all selected
 151         files this cannot work.
 152     */
 153     css::uno::Sequence< OUString > GetMPath() const;
 154
 155     /** Provides the selected files with full path information */
 156     css::uno::Sequence< OUString > GetSelectedFiles() const;
 157
 158     void                     AddFilter( const OUString& rFilterName, const OUString& rExtension );
 159     void                     SetCurrentFilter( const OUString& rFilter );
 160
 161     /** sets an initial display directory/file name
 162
 163         @deprecated
 164             don't use this method. It contains a lot of magic in determining whether the
 165             last segment of the given path/URL denotes a file name or a folder, and by
 166             definition, it cannot succeed with this magic *all* the time - there will
 167             always be scenarios where it fails.
 168
 169             Use SetDisplayFolder and SetFileName.
 170     */
 171     void                     SetDisplayDirectory( const OUString& rPath );
 172
 173     /** sets a new folder whose content is to be displayed in the file picker
 174
 175         @param _rURL
 176             specifies the URL of the folder whose content is to be displayed.<br/>
 177             If the URL doesn't denote a valid (existent and accessible) folder, the
 178             request is silently dropped.
 179         @throws css::uno::RuntimeException
 180             if the invocation of any of the file picker or UCB methods throws a RuntimeException.
 181     */
 182     void                     SetDisplayFolder( const OUString& _rURL );
 183
 184     /** sets an initial file name to display
 185
 186         This method is usually used in "save-as" contexts, where the application should
 187         suggest an initial name for the file to save.
 188
 189         Calling this method is nearly equivalent to calling <code>GetFilePicker().setDefaultName( _rFileName )</code>,
 190         with the following differences:
 191         <ul><li>The FileDialogHelper remembers the given file name, and upon execution,
 192                 strips its extension if the dialog is set up for "automatic file name extension".</li>
 193             <li>Exceptions thrown from the <code>XFilePicker2</code> are caught and silenced.</li>
 194         </ul>
 195     */
 196     void                     SetFileName( const OUString& _rFileName );
 197
 198     OUString                 GetCurrentFilter() const;
 199     OUString                 GetDisplayDirectory() const;
 200     ErrCode                  GetGraphic( Graphic& rGraphic ) const;
 201
 202     const css::uno::Reference < css::ui::dialogs::XFilePicker2 >& GetFilePicker() const;
 203
 204     // XFilePickerListener methods
 205     void SAL_CALL   FileSelectionChanged( const css::ui::dialogs::FilePickerEvent& aEvent );
 206     void SAL_CALL   DirectoryChanged( const css::ui::dialogs::FilePickerEvent& aEvent );
 207     virtual void SAL_CALL   ControlStateChanged( const css::ui::dialogs::FilePickerEvent& aEvent );
 208     void SAL_CALL   DialogSizeChanged();
 209     static OUString SAL_CALL    HelpRequested( const css::ui::dialogs::FilePickerEvent& aEvent );
 210
 211     // XDialogClosedListener methods
 212     void SAL_CALL   DialogClosed( const css::ui::dialogs::DialogClosedEvent& _rEvent );
 213
 214     /** sets help ids for the controls in the dialog
 215         @param _pControlId
 216             Pointer to a 0-terminated array of control ids. They must be recruited from the
 217             CommonFilePickerElementIds and ExtendedFilePickerElementIds values.
 218         @param _pHelpId
 219             Pointer to an array of help ids. For each element in _pControlId, there must be
 220             a corresponding element herein.
 221     */
 222     void                    SetControlHelpIds( const sal_Int16* _pControlId, const char** _pHelpId );
 223     void                    CreateMatcher( const OUString& rName );
 224
 225     /** sets the context of the dialog and trigger necessary actions e.g. loading config, setting help id
 226         @param _eNewContext
 227             New context for the dialog.
 228     */
 229     void                    SetContext( Context _eNewContext );
 230
 231    DECL_LINK_TYPED( ExecuteSystemFilePicker, void*, void );
 232
 233    ErrCode                  Execute( std::vector<OUString>& rpURLList,
 234                                      SfxItemSet *&   rpSet,
 235                                      OUString&         rFilter,
 236                                      const OUString&   rDirPath );
 237    ErrCode                  Execute( SfxItemSet *&   rpSet,
 238                                      OUString&         rFilter );
 239 };
 240
 241 #define SFX2_IMPL_DIALOG_CONFIG 0
 242 #define SFX2_IMPL_DIALOG_SYSTEM 1
 243 #define SFX2_IMPL_DIALOG_OOO 2
 244 #define SFX2_IMPL_DIALOG_REMOTE 3
 245
 246 ErrCode FileOpenDialog_Impl( sal_Int16 nDialogType,
 247                              FileDialogFlags nFlags,
 248                              const OUString& rFact,
 249                              std::vector<OUString>& rpURLList,
 250                              OUString& rFilter,
 251                              SfxItemSet *& rpSet,
 252                              const OUString* pPath = nullptr,
 253                              sal_Int16 nDialog = SFX2_IMPL_DIALOG_CONFIG,
 254                              const OUString& rStandardDir = OUString(),
 255                              const css::uno::Sequence< OUString >& rBlackList = css::uno::Sequence< OUString >());
 256
 257
 258 ErrCode RequestPassword(const std::shared_ptr<const SfxFilter>& pCurrentFilter, OUString& aURL, SfxItemSet* pSet);
 259 }
 260
 261 #endif
 262
 263 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */