FileChooserDialog.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: FileChooserDialog
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/QCustomStackedWidget.h>
#include <NDEVR/File.h>
#include <NDEVR/FileFormat.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/UUID.h>
#include <NDEVR/INIInterface.h>
#include <QWidget>
#include <functional>
#include <QPointer>
#include <QIcon>
class QHBoxLayout;
#if NDEVR_SUPPORTS_THREADING
class QThread;
#endif
namespace NDEVR
{
 
    class INIFactory;
    class Button;
    class QCustomTableWidget;
    class Thread;
    class Toggle;
    class ButtonGallery;
    class QCustomLineEdit;
    class QCustomComboBox;
    class QCustomMessageBox;
    class FolderCreatorWidget;
    /**--------------------------------------------------------------------------------------------------
    \brief A placeholder widget for Files displayed with FileChooserDialog until the actual icon can be
        loaded from the disk, which may be a slow operation for large directories.
    **/
    struct IconCacheWidget
    {
        QPointer<Button> button;
        QPointer<QCustomTableWidget> table;
        uint04 table_index =  Constant<uint04>::Invalid;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A dialog designed to allow the user to navigate a filesytem and select or create one or more 
        files or folders that match a criteria.
 
    Supports browsing the filesystem using a native dialog or in touch mode a touch-friendly dialog. Also
        supports favorites and recents when available.
    **/
    class NDEVR_WIDGETS_API FileChooserDialog : public QWidget, public INIInterface
    {   
        Q_OBJECT
    public:
#if NDEVR_SUPPORTS_THREADING
        friend class ImageCacheThread;
#endif
        enum DisplayMode
        {
              e_browser
            , e_recents
            , e_favorites
        };
        FileChooserDialog(bool save_dialog = false, QWidget *parent = nullptr);
        FileChooserDialog(const File& ini_location, bool save_dialog = false, QWidget *parent = nullptr);
        ~FileChooserDialog();
        void setOptions(const Buffer<FileFormat>& extensions, bool save_dialog);
        QSize sizeHint() const override;
        Buffer<File> getSelected() const;
        //Should be used normally to correctly show the dialog in the most reasonable way
        void autoShowDialog(PopupInfo info = PopupInfo());
        void autoHideDialog(PopupInfo info = PopupInfo());
        const Buffer<FileRequest>& getSelectedRequests() const;
        void setAllowAny(bool allow_any) { m_allow_any = allow_any; }
        bool isSaveDialog() const { return m_save_dialog; }
        void setCurrentDirectory(const File& current_directory);
        void setFallbackDirectory(const File& file);
        void setSaveContent(const Buffer<UUID>& save_content) { m_save_content = save_content; }
        const Buffer<UUID>& saveContent() const { return m_save_content; }
        void showModifiedTime(bool show_modified_time);
        void showAccessedTime(bool show_accessed_time);
        void showFileSize(bool show_modified_time);
        void setShowRecents(bool show_recent);
        void setCurrentFileName(const String& name);
        void setCurrentFile(const File& file);
        void setCurrentExtension(const String& extension, bool update_format_to_first_match);
        bool event(QEvent* e) override;
        bool isFolderBrowser() const;
        bool showRecents() const { return m_show_recents; };
        bool showFavorites() const;
        void prepareForINI(INIFactory& factory) override;
        void finishReadingINI(INIFactory& factory) override;
        void selectFileNameField();
        void setAdditionalFavorites(Buffer<File> favorites);
        void browseFile(PopupInfo popup_origin = PopupInfo());
        void setIconProvider(const std::function<String(const FileRequest&)>& icon_provider);
        void setCanReadCallback(const std::function<bool(const FileFormat&, const File&)>& callback);
        TranslatedString actionName() const;
        void setActionName(const TranslatedString& action_name);
        void addToRecents(const Buffer<File>& files); 
        void addToRecents(const File& file);
        TranslatedString windowTitle() const;
        void showRecents();
        const File& currentDirectory() const { return m_current_directory; };
        void setNativeParent(QWidget* native_parent);
    protected:
        void postResolveIcons();
        void browseFileNative();
        void retranslate();
        void updateGallery(Button* b);
        void hidePopupDialog();
        void autoSelectFavoritesItem();
        FileFormat currentSelectedFormat() const;
        void updateBrowserWidgets();
        void SetupForBrowser();
        void SetupForFavorites();
        QWidget* createRequestWidget(File item);
        QWidget* createNavigationButtons();
        QWidget* createBottomPanel();
        QWidget* createfavoritesPanel();
        QWidget* settingsDialog();
        String extensionsString(const String& delimiter = ";;") const;
        void addItem(ButtonGallery* gallery, QCustomTableWidget* table, uint04 index, const File& item);
        void removeFromRecents(File item);
        void clearRecents();
        void finishBrowse();
        void setup();
        FileFormat getFileFormat(const QString& file, const QString& string) const;
        FileFormat getFileFormatFromExtension(const String& ext) const;
        FileFormat getFileFormat(const File& file);
        Buffer<File> filterFiles(const Buffer<File>& all_files) const;
        bool checkFileAgainstFilter(const File& file, const FileFormat& selected_format) const;
        const Buffer<File>& currentDirectoryFiles() const;
        const Buffer<File> favoriteFiles() const;
        void setIsFileChooser(bool is_file_chooser);
        void onFileChosen(File file);
    private slots:
        void contextMenu(const QPoint &pos);
        void browsingFinished();
        void updateFilesSlot();
    signals:
        void finishedSignal();
        void onFileChoosenSignal();
        void onCanceledSignal();
    private:
        void _setDisplayMode(DisplayMode mode);
        QIcon _getIconCallback(const File& file);
        String _getIconID(const File& file);
        void _setCurrentDirectory(const File& dir);
        void onUserReadyToFinish(bool was_browsing);
        void onUserFinish();
        void setFileIcon(File file, QIcon icon);
        void showFiles(ButtonGallery* gallery, QCustomTableWidget* table, const Buffer<File>& files);
        QCustomTableWidget* createTable(bool is_favorites = false);
        virtual void getINI(INIFactory& factory) override;
        bool getSelectedFilters(QString & selected_filter, QString & default_suffix);
        void resolveIcons();
        void resolveIcon(const File& file);
    private:
        Buffer<File> m_recent_files;
        Dictionary<File, FileCachedData> m_program_managed_data;
        mutable Buffer<File> m_current_directory_files;
        Buffer<File> m_additional_favorites;
        Dictionary<File, QIcon> m_cached_icons;
        Dictionary<File, IconCacheWidget> m_cached_icon_locations;
        File m_current_directory;
        File m_fallback_directory;
        String m_current_file_name;
        String m_current_file_extension;
        Buffer<FileFormat> m_filter;
        
        QHBoxLayout* m_top_layout;
        String m_last_dir;
        bool m_save_dialog;
        bool m_show_recents = true;
        bool m_touch_prefer_gallery = true;
        bool m_desktop_prefer_gallery = false;
        bool m_show_hidden = false;
        bool m_show_extensions = true;
        bool m_show_favorites;
        DisplayMode m_display_mode;
        FolderCreatorWidget* m_folder_creation_widget;
        QCustomTableWidget* m_file_table;
        QCustomTableWidget* m_favorites_table;
        ButtonGallery* m_file_gallery;
        QCustomStackedWidget* m_view_stack;
        Button* m_browse_button;
        Button* m_database_button;
        Button* m_view_toggle;
        Button* m_accept_button;
        Button* m_new_folder_button;
        Button* m_up_level_button;
        Button* m_favorites_button;
        QWidget* m_navigation_buttons;
        QWidget* m_bottom_buttons;
        QWidget* m_favorites_panel;
        QCustomComboBox* m_file_types_combo;
        QCustomLineEdit* m_location_label;
 
        QCustomLineEdit* m_file_name_line_edit;
        QCustomMessageBox* m_override_file_message_box;
        QCustomMessageBox* m_invalid_file_message_box;
        Buffer<UUID> m_save_content;
        QIcon m_loading_icon;
        QWidget* m_popup_dialog;
        QWidget* m_settings_dialog;
        
        TranslatedString m_action_name;
 
        Buffer<File> m_pending_icons;
#if NDEVR_SUPPORTS_THREADING
        QThread* m_icon_thread = nullptr;
#endif
        QWidget* m_native_parent = nullptr;
        std::function<String(const FileRequest&)> m_icon_provider;
        std::function<bool(const FileFormat&, const File&)> m_can_read_callback;
    protected:
        Buffer<FileRequest> m_selected_files;
        bool m_allow_any;
        void updateTableIconSize(QCustomTableWidget* table);
        bool m_neeeds_to_update = false;
    };
}