juce_FileBrowserComponent.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  FileBrowserComponent  : public Component,
                                        private FileBrowserListener,
                                        private FileFilter,
                                        private Timer
{
public:
    //==============================================================================
    enum FileChooserFlags
    {
        openMode                        = 1,    
        saveMode                        = 2,    
        canSelectFiles                  = 4,    
        canSelectDirectories            = 8,    
        canSelectMultipleItems          = 16,   
        useTreeView                     = 32,   
        filenameBoxIsReadOnly           = 64,   
        warnAboutOverwriting            = 128,  
        doNotClearFileNameOnRootChange  = 256   
    };
 
    //==============================================================================
    FileBrowserComponent (int flags,
                          const File& initialFileOrDirectory,
                          const FileFilter* fileFilter,
                          FilePreviewComponent* previewComp);

    ~FileBrowserComponent() override;
 
    //==============================================================================
    int getNumSelectedFiles() const noexcept;

    File getSelectedFile (int index) const noexcept;

    void deselectAllFiles();

    bool currentFileIsValid() const;

    File getHighlightedFile() const noexcept;
 
    //==============================================================================
    const File& getRoot() const;

    void setRoot (const File& newRootDirectory);

    void setFileName (const String& newName);

    void goUp();

    void refresh();

    void setFileFilter (const FileFilter* newFileFilter);

    virtual String getActionVerb() const;

    bool isSaveMode() const noexcept;

    void setFilenameBoxLabel (const String& name);
 
    //==============================================================================
    void addListener (FileBrowserListener* listener);

    void removeListener (FileBrowserListener* listener);

    static void getDefaultRoots (StringArray& rootNames, StringArray& rootPaths);
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        // These return a pointer to an internally cached drawable - make sure you don't keep
        // a copy of this pointer anywhere, as it may become invalid in the future.
        virtual const Drawable* getDefaultFolderImage() = 0;
        virtual const Drawable* getDefaultDocumentFileImage() = 0;
 
        virtual AttributedString createFileChooserHeaderText (const String& title,
                                                              const String& instructions) = 0;
 
        virtual void drawFileBrowserRow (Graphics&, int width, int height,
                                         const File& file,
                                         const String& filename,
                                         Image* optionalIcon,
                                         const String& fileSizeDescription,
                                         const String& fileTimeDescription,
                                         bool isDirectory,
                                         bool isItemSelected,
                                         int itemIndex,
                                         DirectoryContentsDisplayComponent&) = 0;
 
        virtual Button* createFileBrowserGoUpButton() = 0;
 
        virtual void layoutFileBrowserComponent (FileBrowserComponent& browserComp,
                                                 DirectoryContentsDisplayComponent* fileListComponent,
                                                 FilePreviewComponent* previewComp,
                                                 ComboBox* currentPathBox,
                                                 TextEditor* filenameBox,
                                                 Button* goUpButton) = 0;
    };

    enum ColourIds
    {
        currentPathBoxBackgroundColourId    = 0x1000640, 
        currentPathBoxTextColourId          = 0x1000641, 
        currentPathBoxArrowColourId         = 0x1000642, 
        filenameBoxBackgroundColourId       = 0x1000643, 
        filenameBoxTextColourId             = 0x1000644  
    };
 
    //==============================================================================
    void resized() override;
    void lookAndFeelChanged() override;
    bool keyPressed (const KeyPress&) override;
    void selectionChanged() override;
    void fileClicked (const File&, const MouseEvent&) override;
    void fileDoubleClicked (const File&) override;
    void browserRootChanged (const File&) override;
    bool isFileSuitable (const File&) const override;
    bool isDirectorySuitable (const File&) const override;
    FilePreviewComponent* getPreviewComponent() const noexcept;
    DirectoryContentsDisplayComponent* getDisplayComponent() const noexcept;
 
protected:
    virtual void getRoots (StringArray& rootNames, StringArray& rootPaths);

    void resetRecentPaths();
 
private:
    //==============================================================================
    std::unique_ptr<DirectoryContentsList> fileList;
    const FileFilter* fileFilter;
 
    int flags;
    File currentRoot;
    Array<File> chosenFiles;
    ListenerList<FileBrowserListener> listeners;
 
    std::unique_ptr<DirectoryContentsDisplayComponent> fileListComponent;
    FilePreviewComponent* previewComp;
    ComboBox currentPathBox;
    TextEditor filenameBox;
    Label fileLabel;
    std::unique_ptr<Button> goUpButton;
    TimeSliceThread thread;
    bool wasProcessActive;
 
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    void timerCallback() override;
    void sendListenerChangeMessage();
    bool isFileOrDirSuitable (const File&) const;
    void updateSelectedPath();
    void changeFilename();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FileBrowserComponent)
};
 
} // namespace juce