FileDialog.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
// you must not claim that you wrote the original software.
// If you use this software in a product, an acknowledgment
// in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
// and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
 
#ifndef TGUI_FILE_DIALOG_HPP
#define TGUI_FILE_DIALOG_HPP
 
 
#include <TGUI/CopiedSharedPtr.hpp>
#include <TGUI/Widgets/Label.hpp>
#include <TGUI/Widgets/Button.hpp>
#include <TGUI/Widgets/EditBox.hpp>
#include <TGUI/Widgets/ComboBox.hpp>
#include <TGUI/Widgets/ListView.hpp>
#include <TGUI/Widgets/ChildWindow.hpp>
#include <TGUI/Widgets/Panel.hpp>
#include <TGUI/Renderers/FileDialogRenderer.hpp>
#include <TGUI/Filesystem.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
 #include <tuple>
#endif
 
 
TGUI_MODULE_EXPORT namespace tgui
{
 class FileDialogIconLoader;
 
 class TGUI_API FileDialog : public ChildWindow
 {
 public:
 
 using Ptr = std::shared_ptr<FileDialog>; 
 using ConstPtr = std::shared_ptr<const FileDialog>; 
 
 static constexpr const char StaticWidgetType[] = "FileDialog"; 
 
 
 FileDialog(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
 
 TGUI_NODISCARD static FileDialog::Ptr create(const String& title = "Open file", const String& confirmButtonText = "Open", bool allowCreateFolder = false);
 
 
 FileDialog(const FileDialog& copy);
 
 
 FileDialog(FileDialog&& copy) noexcept;
 
 
 FileDialog& operator= (const FileDialog& right);
 
 
 FileDialog& operator= (FileDialog&& right) noexcept;
 
 
 TGUI_NODISCARD static FileDialog::Ptr copy(const FileDialog::ConstPtr& dialog);
 
 
 TGUI_NODISCARD FileDialogRenderer* getSharedRenderer() override;
 TGUI_NODISCARD const FileDialogRenderer* getSharedRenderer() const override;
 
 TGUI_NODISCARD FileDialogRenderer* getRenderer() override;
 
 
 TGUI_NODISCARD const std::vector<Filesystem::Path>& getSelectedPaths() const;
 
 
 void setPath(const String& path);
 
 
 void setPath(const Filesystem::Path& path);
 
 
 TGUI_NODISCARD const Filesystem::Path& getPath() const;
 
 
 void setFilename(const String& filename);
 
 
 TGUI_NODISCARD const String& getFilename() const;
 
 
 void setFileTypeFilters(const std::vector<std::pair<String, std::vector<String>>>& filters, std::size_t defaultFilterIndex = 0);
 
 
 TGUI_NODISCARD const std::vector<std::pair<String, std::vector<String>>>& getFileTypeFilters() const;
 
 
 TGUI_NODISCARD std::size_t getFileTypeFiltersIndex() const;
 
 
 void setConfirmButtonText(const String& text = "Open");
 
 
 TGUI_NODISCARD const String& getConfirmButtonText() const;
 
 
 void setCancelButtonText(const String& text = "Cancel");
 
 
 TGUI_NODISCARD const String& getCancelButtonText() const;
 
 
 void setCreateFolderButtonText(const String& text = "Create Folder");
 
 
 TGUI_NODISCARD const String& getCreateFolderButtonText() const;
 
 void setAllowCreateFolder(bool allowCreateFolder);
 
 TGUI_NODISCARD bool getAllowCreateFolder() const;
 
 
 void setFilenameLabelText(const String& labelText = "Filename:");
 
 
 TGUI_NODISCARD const String& getFilenameLabelText() const;
 
 
 void setListViewColumnCaptions(const String& nameColumnText = "Name", const String& sizeColumnText = "Size", const String& modifiedColumnText = "Modified");
 
 
 TGUI_NODISCARD std::tuple<String, String, String> getListViewColumnCaptions() const;
 
 
 void setFileMustExist(bool enforceExistence);
 
 
 TGUI_NODISCARD bool getFileMustExist() const;
 
 
 void setSelectingDirectory(bool selectDirectories);
 
 
 TGUI_NODISCARD bool getSelectingDirectory() const;
 
 
 void setMultiSelect(bool multiSelect);
 
 
 TGUI_NODISCARD bool getMultiSelect() const;
 
 
 void setIconLoader(std::shared_ptr<FileDialogIconLoader> iconLoader);
 
 
 TGUI_NODISCARD std::shared_ptr<FileDialogIconLoader> getIconLoader() const;
 
 
 void keyPressed(const Event::KeyEvent& event) override;
 
 bool canHandleKeyPress(const Event::KeyEvent& event) override;
 
 void textEntered(char32_t key) override;
 
 
 protected:
 
 TGUI_NODISCARD Signal& getSignal(String signalName) override;
 
 
 void rendererChanged(const String& property) override;
 
 
 TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 
 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 
 // This function is called every frame with the time passed since the last frame.
 bool updateTime(Duration elapsedTime) override;
 
 
 // Makes a copy of the widget
 TGUI_NODISCARD Widget::Ptr clone() const override;
 
 
 private:
 
 // Changes the directory that is shown in the dialog
 void changePath(const Filesystem::Path& path, bool updateHistory);
 
 
 // Updates the back and forward buttons when the path history changes
 void historyChanged();
 
 
 // Adds the files to the list view in the order shosen by the user
 void sortFilesInListView();
 
 
 // Stores the selected files and closes the dialog
 void filesSelected(std::vector<Filesystem::Path> filenames);
 
 
 // Updates whether the open/save button is enabled or disabled
 void updateConfirmButtonEnabled();
 
 
 // Handles a press of the open/save button
 void confirmButtonPressed();
 
 // Adds a button the File Dialog which allows the user to create a new folder
 void addCreateFolderButton();
 
 // Creates a folder in a given directory
 void createFolder(const String& name);
 
 // Handles a press of the create folder button
 void createCreateFolderDialog();
 
 // Destroys the create folder dialog
 void destroyCreateFolderDialog();
 
 // Check if the name of a new folder is valid
 bool isValidFolderName(const String& name);
 
 // Initializes the widget pointers after copying or loading the dialog
 void identifyChildWidgets();
 
 
 // Connects the signals of the child widgets
 void connectSignals();
 
 
 public:
 
 SignalFileDialogPaths onFileSelect = {"FileSelected"};
 
 Signal onCancel = {"Cancelled"};
 
 
 protected:
 
 Button::Ptr m_buttonBack;
 Button::Ptr m_buttonForward;
 Button::Ptr m_buttonUp;
 EditBox::Ptr m_editBoxPath;
 ListView::Ptr m_listView;
 Label::Ptr m_labelFilename;
 EditBox::Ptr m_editBoxFilename;
 ComboBox::Ptr m_comboBoxFileTypes;
 Button::Ptr m_buttonCancel;
 Button::Ptr m_buttonConfirm;
 Button::Ptr m_buttonCreateFolder;
 bool m_allowCreateFolder = false;
 
 bool m_createFolderDialogOpen = false;
 
 Filesystem::Path m_currentDirectory;
 std::vector<Filesystem::FileInfo> m_filesInDirectory;
 std::vector<Texture> m_fileIcons; // Same order as m_filesInDirectory
 std::size_t m_sortColumnIndex = 0;
 bool m_sortInversed = false;
 
 std::vector<Filesystem::Path> m_pathHistory;
 std::size_t m_pathHistoryIndex = 0;
 
 bool m_fileMustExist = true;
 bool m_selectingDirectory = false;
 bool m_multiSelect = false;
 
 std::vector<std::pair<String, std::vector<String>>> m_fileTypeFilters;
 std::size_t m_selectedFileTypeFilter = 0;
 
 std::shared_ptr<FileDialogIconLoader> m_iconLoader;
 
 std::vector<Filesystem::Path> m_selectedFiles;
 };
 
}
 
 
#endif // TGUI_FILE_DIALOG_HPP