juce_FilenameComponent.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  FilenameComponentListener
{
public:
    virtual ~FilenameComponentListener() = default;

    virtual void filenameComponentChanged (FilenameComponent* fileComponentThatHasChanged) = 0;
};
 
 
//==============================================================================
class JUCE_API  FilenameComponent  : public Component,
                                     public SettableTooltipClient,
                                     public FileDragAndDropTarget,
                                     private AsyncUpdater
{
public:
    //==============================================================================
    FilenameComponent (const String& name,
                       const File& currentFile,
                       bool canEditFilename,
                       bool isDirectory,
                       bool isForSaving,
                       const String& fileBrowserWildcard,
                       const String& enforcedSuffix,
                       const String& textWhenNothingSelected);

    ~FilenameComponent() override;
 
    //==============================================================================
    File getCurrentFile() const;

    String getCurrentFileText() const;

    void setCurrentFile (File newFile,
                         bool addToRecentlyUsedList,
                         NotificationType notification = sendNotificationAsync);

    void setFilenameIsEditable (bool shouldBeEditable);

    void setDefaultBrowseTarget (const File& newDefaultDirectory);

    virtual File getLocationToBrowse();

    StringArray getRecentlyUsedFilenames() const;

    void setRecentlyUsedFilenames (const StringArray& filenames);

    void addRecentlyUsedFile (const File& file);

    void setMaxNumberOfRecentFiles (int newMaximum);

    void setBrowseButtonText (const String& browseButtonText);
 
    //==============================================================================
    void addListener (FilenameComponentListener* listener);

    void removeListener (FilenameComponentListener* listener);

    void setTooltip (const String& newTooltip) override;
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        virtual Button* createFilenameComponentBrowseButton (const String& text) = 0;
        virtual void layoutFilenameComponent (FilenameComponent&, ComboBox* filenameBox, Button* browseButton) =  0;
    };
 
    //==============================================================================
    void paintOverChildren (Graphics&) override;
    void resized() override;
    void lookAndFeelChanged() override;
    bool isInterestedInFileDrag (const StringArray&) override;
    void filesDropped (const StringArray&, int, int) override;
    void fileDragEnter (const StringArray&, int, int) override;
    void fileDragExit (const StringArray&) override;
    std::unique_ptr<ComponentTraverser> createKeyboardFocusTraverser() override;
 
private:
    //==============================================================================
    void handleAsyncUpdate() override;
 
    void showChooser();
 
    ComboBox filenameBox;
    String lastFilename;
    std::unique_ptr<Button> browseButton;
    int maxRecentFiles = 30;
    bool isDir, isSaving, isFileDragOver = false;
    String wildcard, enforcedSuffix, browseButtonText;
    ListenerList <FilenameComponentListener> listeners;
    File defaultBrowseFile;
    std::unique_ptr<FileChooser> chooser;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FilenameComponent)
};
 
} // namespace juce