juce_FileBasedDocument.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 FileBasedDocument  : public ChangeBroadcaster
{
public:
    FileBasedDocument (const String& fileExtension,
                       const String& fileWildCard,
                       const String& openFileDialogTitle,
                       const String& saveFileDialogTitle);

    ~FileBasedDocument() override;
 
    //==============================================================================
    bool hasChangedSinceSaved() const;

    virtual void changed();

    void setChangedFlag (bool hasChanged);
 
    //==============================================================================
    Result loadFrom (const File& fileToLoadFrom,
                     bool showMessageOnFailure,
                     bool showWaitCursor = true);

    void loadFromAsync (const File& fileToLoadFrom,
                        bool showMessageOnFailure,
                        std::function<void (Result)> callback);
 
   #if JUCE_MODAL_LOOPS_PERMITTED
    Result loadFromUserSpecifiedFile (bool showMessageOnFailure);
   #endif

    void loadFromUserSpecifiedFileAsync (bool showMessageOnFailure, std::function<void (Result)> callback);
 
    //==============================================================================
    enum SaveResult
    {
        savedOk = 0,            
        userCancelledSave,      
        failedToWriteToFile     
    };
 
   #if JUCE_MODAL_LOOPS_PERMITTED
    SaveResult save (bool askUserForFileIfNotSpecified,
                     bool showMessageOnFailure);
   #endif

    void saveAsync (bool askUserForFileIfNotSpecified,
                    bool showMessageOnFailure,
                    std::function<void (SaveResult)> callback);
 
   #if JUCE_MODAL_LOOPS_PERMITTED
    SaveResult saveIfNeededAndUserAgrees();
   #endif

    void saveIfNeededAndUserAgreesAsync (std::function<void (SaveResult)> callback);
 
   #if JUCE_MODAL_LOOPS_PERMITTED
    SaveResult saveAs (const File& newFile,
                       bool warnAboutOverwritingExistingFiles,
                       bool askUserForFileIfNotSpecified,
                       bool showMessageOnFailure,
                       bool showWaitCursor = true);
   #endif

    void saveAsAsync (const File& newFile,
                      bool warnAboutOverwritingExistingFiles,
                      bool askUserForFileIfNotSpecified,
                      bool showMessageOnFailure,
                      std::function<void (SaveResult)> callback);
 
   #if JUCE_MODAL_LOOPS_PERMITTED
    SaveResult saveAsInteractive (bool warnAboutOverwritingExistingFiles);
   #endif

    void saveAsInteractiveAsync (bool warnAboutOverwritingExistingFiles,
                                 std::function<void (SaveResult)> callback);
 
    //==============================================================================
    const File& getFile() const;

    void setFile (const File& newFile);
 
protected:
    //==============================================================================
    virtual String getDocumentTitle() = 0;

    virtual Result loadDocument (const File& file) = 0;

    virtual void loadDocumentAsync (const File& file, std::function<void (Result)> callback);

    virtual Result saveDocument (const File& file) = 0;

    virtual void saveDocumentAsync (const File& file, std::function<void (Result)> callback);

    virtual File getLastDocumentOpened() = 0;

    virtual void setLastDocumentOpened (const File& file) = 0;

    virtual File getSuggestedSaveAsFile (const File& defaultFile);
 
private:
    //==============================================================================
    class Pimpl;
    std::unique_ptr<Pimpl> pimpl;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FileBasedDocument)
};
 
} // namespace juce