juce_RecentlyOpenedFilesList.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  RecentlyOpenedFilesList
{
public:
    //==============================================================================
    RecentlyOpenedFilesList();
 
    //==============================================================================
    void setMaxNumberOfItems (int newMaxNumber);

    int getMaxNumberOfItems() const noexcept                            { return maxNumberOfItems; }

    int getNumFiles() const;

    File getFile (int index) const;

    const StringArray& getAllFilenames() const noexcept                 { return files; }

    void clear();

    void addFile (const File& file);

    void removeFile (const File& file);

    void removeNonExistentFiles();

    static void registerRecentFileNatively (const File& file);

    static void forgetRecentFileNatively (const File& file);

    static void clearRecentFilesNatively();
 
    //==============================================================================
    int createPopupMenuItems (PopupMenu& menuToAddItemsTo,
                              int baseItemId,
                              bool showFullPaths,
                              bool dontAddNonExistentFiles,
                              const File** filesToAvoid = nullptr);
 
    //==============================================================================
    String toString() const;

    void restoreFromString (const String& stringifiedVersion);
 
 
private:
    //==============================================================================
    StringArray files;
    int maxNumberOfItems;
 
    JUCE_LEAK_DETECTOR (RecentlyOpenedFilesList)
};
 
} // namespace juce