juce_FileChooser.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  FileChooser
{
public:
    //==============================================================================
    FileChooser (const String& dialogBoxTitle,
                 const File& initialFileOrDirectory = File(),
                 const String& filePatternsAllowed = String(),
                 bool useOSNativeDialogBox = true,
                 bool treatFilePackagesAsDirectories = false,
                 Component* parentComponent = nullptr);

    ~FileChooser();
 
    //==============================================================================
   #if JUCE_MODAL_LOOPS_PERMITTED
    bool browseForFileToOpen (FilePreviewComponent* previewComponent = nullptr);

    bool browseForMultipleFilesToOpen (FilePreviewComponent* previewComponent = nullptr);

    bool browseForFileToSave (bool warnAboutOverwritingExistingFiles);

    bool browseForDirectory();

    bool browseForMultipleFilesOrDirectories (FilePreviewComponent* previewComponent = nullptr);
 
    //==============================================================================
    bool showDialog (int flags, FilePreviewComponent* previewComponent);
   #endif

    void launchAsync (int flags,
                      std::function<void (const FileChooser&)>,
                      FilePreviewComponent* previewComponent = nullptr);
 
    //==============================================================================
    File getResult() const;

    Array<File> getResults() const noexcept;
 
    //==============================================================================
    URL getURLResult() const;

    const Array<URL>& getURLResults() const noexcept      { return results; }
 
    //==============================================================================
    static bool isPlatformDialogAvailable();
 
    //==============================================================================
   #ifndef DOXYGEN
    class Native;
   #endif
 
private:
    //==============================================================================
    String title, filters;
    File startingFile;
    Component* parent;
    Array<URL> results;
    const bool useNativeDialogBox;
    const bool treatFilePackagesAsDirs;
    std::function<void (const FileChooser&)> asyncCallback;
 
    //==============================================================================
    void finished (const Array<URL>&);
 
    //==============================================================================
    struct Pimpl
    {
        virtual ~Pimpl() = default;
 
        virtual void launch()     = 0;
        virtual void runModally() = 0;
    };
 
    std::shared_ptr<Pimpl> pimpl;
 
    //==============================================================================
    std::shared_ptr<Pimpl> createPimpl (int, FilePreviewComponent*);
    static std::shared_ptr<Pimpl> showPlatformDialog (FileChooser&, int, FilePreviewComponent*);
 
    class NonNative;
    friend class NonNative;
    friend class Native;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FileChooser)
};
 
} // namespace juce