TGUI 1.11
Loading...
Searching...
No Matches
FileDialog.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef TGUI_FILE_DIALOG_HPP
26#define TGUI_FILE_DIALOG_HPP
27
28#include <TGUI/Widgets/Label.hpp>
29#include <TGUI/Widgets/Button.hpp>
30#include <TGUI/Widgets/EditBox.hpp>
31#include <TGUI/Widgets/ComboBox.hpp>
32#include <TGUI/Widgets/ListView.hpp>
33#include <TGUI/Widgets/ChildWindow.hpp>
34#include <TGUI/Widgets/Panel.hpp>
35#include <TGUI/Renderers/FileDialogRenderer.hpp>
36#include <TGUI/Filesystem.hpp>
37
38#include <tuple>
39
41
42namespace tgui
43{
45
60 class TGUI_API FileDialog : public ChildWindow
61 {
62 public:
63
64 using Ptr = std::shared_ptr<FileDialog>;
65 using ConstPtr = std::shared_ptr<const FileDialog>;
66
67 static constexpr const char StaticWidgetType[] = "FileDialog";
68
76 FileDialog(const char* typeName = StaticWidgetType, bool initRenderer = true);
77
87 TGUI_NODISCARD static FileDialog::Ptr create(const String& title = "Open file", const String& confirmButtonText = "Open", bool allowCreateFolder = false);
88
92 FileDialog(const FileDialog& copy);
93
97 FileDialog(FileDialog&& copy) noexcept;
98
102 FileDialog& operator= (const FileDialog& right);
103
107 FileDialog& operator= (FileDialog&& right) noexcept;
108
116 TGUI_NODISCARD static FileDialog::Ptr copy(const FileDialog::ConstPtr& dialog);
117
122 TGUI_NODISCARD FileDialogRenderer* getSharedRenderer() override;
123 TGUI_NODISCARD const FileDialogRenderer* getSharedRenderer() const override;
124
130 TGUI_NODISCARD FileDialogRenderer* getRenderer() override;
131
149 TGUI_NODISCARD const std::vector<Filesystem::Path>& getSelectedPaths() const;
150
158 void setPath(const String& path);
159
167 void setPath(const Filesystem::Path& path);
168
174 TGUI_NODISCARD const Filesystem::Path& getPath() const;
175
181 void setFilename(const String& filename);
182
192 TGUI_NODISCARD const String& getFilename() const;
193
217 void setFileTypeFilters(const std::vector<std::pair<String, std::vector<String>>>& filters, std::size_t defaultFilterIndex = 0);
218
226 TGUI_NODISCARD const std::vector<std::pair<String, std::vector<String>>>& getFileTypeFilters() const;
227
235 TGUI_NODISCARD std::size_t getFileTypeFiltersIndex() const;
236
242 void setConfirmButtonText(const String& text = "Open");
243
249 TGUI_NODISCARD const String& getConfirmButtonText() const;
250
256 void setCancelButtonText(const String& text = "Cancel");
257
263 TGUI_NODISCARD const String& getCancelButtonText() const;
264
270 void setCreateFolderButtonText(const String& text = "Create Folder");
271
277 TGUI_NODISCARD const String& getCreateFolderButtonText() const;
278
284 void setAllowCreateFolder(bool allowCreateFolder);
285
291 TGUI_NODISCARD bool getAllowCreateFolder() const;
292
298 void setFilenameLabelText(const String& labelText = "Filename:");
299
305 TGUI_NODISCARD const String& getFilenameLabelText() const;
306
314 void setListViewColumnCaptions(const String& nameColumnText = "Name", const String& sizeColumnText = "Size", const String& modifiedColumnText = "Modified");
315
323 TGUI_NODISCARD std::tuple<String, String, String> getListViewColumnCaptions() const;
324
332 void setFileMustExist(bool enforceExistence);
333
339 TGUI_NODISCARD bool getFileMustExist() const;
340
349 void setSelectingDirectory(bool selectDirectories);
350
356 TGUI_NODISCARD bool getSelectingDirectory() const;
357
363 void setMultiSelect(bool multiSelect);
364
370 TGUI_NODISCARD bool getMultiSelect() const;
371
381 void setIconLoader(std::shared_ptr<FileDialogIconLoader> iconLoader);
382
388 TGUI_NODISCARD std::shared_ptr<FileDialogIconLoader> getIconLoader() const;
389
393 void keyPressed(const Event::KeyEvent& event) override;
394
404 bool canHandleKeyPress(const Event::KeyEvent& event) override;
405
409 void textEntered(char32_t key) override;
410
412 protected:
413
423 TGUI_NODISCARD Signal& getSignal(String signalName) override;
424
430 void rendererChanged(const String& property) override;
431
435 TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
436
440 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
441
443 // This function is called every frame with the time passed since the last frame.
445 bool updateTime(Duration elapsedTime) override;
446
448 // Makes a copy of the widget
450 TGUI_NODISCARD Widget::Ptr clone() const override;
451
453 private:
454
456 // Changes the directory that is shown in the dialog
458 void changePath(const Filesystem::Path& path, bool updateHistory);
459
461 // Updates the back and forward buttons when the path history changes
463 void historyChanged();
464
466 // Adds the files to the list view in the order shosen by the user
468 void sortFilesInListView();
469
471 // Stores the selected files and closes the dialog
473 void filesSelected(std::vector<Filesystem::Path> filenames);
474
476 // Updates whether the open/save button is enabled or disabled
478 void updateConfirmButtonEnabled();
479
481 // Handles a press of the open/save button
483 void confirmButtonPressed();
484
486 // Adds a button the File Dialog which allows the user to create a new folder
488 void addCreateFolderButton();
489
491 // Creates a folder in a given directory
493 void createFolder(const String& name);
494
496 // Handles a press of the create folder button
498 void createCreateFolderDialog();
499
501 // Destroys the create folder dialog
503 void destroyCreateFolderDialog();
504
506 // Check if the name of a new folder is valid
508 bool isValidFolderName(const String& name);
509
511 // Initializes the widget pointers after copying or loading the dialog
513 void identifyChildWidgets();
514
516 // Connects the signals of the child widgets
518 void connectSignals();
519
521 public:
522
527
529 Signal onCancel = {"Cancelled"};
530
532 protected:
533
534 Button::Ptr m_buttonBack;
535 Button::Ptr m_buttonForward;
536 Button::Ptr m_buttonUp;
537 EditBox::Ptr m_editBoxPath;
538 ListView::Ptr m_listView;
539 Label::Ptr m_labelFilename;
540 EditBox::Ptr m_editBoxFilename;
541 ComboBox::Ptr m_comboBoxFileTypes;
542 Button::Ptr m_buttonCancel;
543 Button::Ptr m_buttonConfirm;
544 Button::Ptr m_buttonCreateFolder;
545 bool m_allowCreateFolder = false;
546
547 bool m_createFolderDialogOpen = false;
548
549 Filesystem::Path m_currentDirectory;
550 std::vector<Filesystem::FileInfo> m_filesInDirectory;
551 std::vector<Texture> m_fileIcons; // Same order as m_filesInDirectory
552 std::size_t m_sortColumnIndex = 0;
553 bool m_sortInversed = false;
554
555 std::vector<Filesystem::Path> m_pathHistory;
556 std::size_t m_pathHistoryIndex = 0;
557
558 bool m_fileMustExist = true;
559 bool m_selectingDirectory = false;
560 bool m_multiSelect = false;
561
562 std::vector<std::pair<String, std::vector<String>>> m_fileTypeFilters;
563 std::size_t m_selectedFileTypeFilter = 0;
564
565 std::shared_ptr<FileDialogIconLoader> m_iconLoader;
566
567 std::vector<Filesystem::Path> m_selectedFiles;
568 };
569
571}
572
574
575#endif // TGUI_FILE_DIALOG_HPP
std::shared_ptr< Button > Ptr
Shared widget pointer.
Definition Button.hpp:41
std::shared_ptr< ComboBox > Ptr
Shared widget pointer.
Definition ComboBox.hpp:52
Wrapper for durations.
Definition Duration.hpp:53
std::shared_ptr< EditBox > Ptr
Shared widget pointer.
Definition EditBox.hpp:49
Definition FileDialogIconLoader.hpp:43
Definition FileDialogRenderer.hpp:35
SignalFileDialogPaths onFileSelect
Definition FileDialog.hpp:526
void setCancelButtonText(const String &text="Cancel")
Changes the text of the cancel button (e.g. to display it in a different language)
void setMultiSelect(bool multiSelect)
Changes whether multiple files can be selected.
void setFileTypeFilters(const std::vector< std::pair< String, std::vector< String > > > &filters, std::size_t defaultFilterIndex=0)
Changes the file filters which the user can select to only show files of a certain type.
void setFileMustExist(bool enforceExistence)
Changes whether the file should exist or whether the filename can be a non-existent file.
std::size_t getFileTypeFiltersIndex() const
Returns the index of the currently selected file filter.
void setAllowCreateFolder(bool allowCreateFolder)
Adds or removes the create folder button.
void setConfirmButtonText(const String &text="Open")
Changes the text of the open/save button.
static FileDialog::Ptr create(const String &title="Open file", const String &confirmButtonText="Open", bool allowCreateFolder=false)
Creates a new file dialog widget.
std::unique_ptr< DataIO::Node > save(SavingRenderersMap &renderers) const override
Saves the widget as a tree node in order to save it to a file.
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
const String & getCreateFolderButtonText() const
Return the text of the create folder button.
const String & getConfirmButtonText() const
Return the text of the open/save button.
FileDialogRenderer * getSharedRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
bool getFileMustExist() const
Returns whether the file should exist or whether the filename can be a non-existent file.
void setPath(const String &path)
Changes the directory for which the files are to be displayed.
std::shared_ptr< const FileDialog > ConstPtr
Shared constant widget pointer.
Definition FileDialog.hpp:65
std::shared_ptr< FileDialog > Ptr
Shared widget pointer.
Definition FileDialog.hpp:64
const String & getCancelButtonText() const
Return the text of the cancel button.
std::shared_ptr< FileDialogIconLoader > getIconLoader() const
Gets the icon loader that is currently being used.
const String & getFilenameLabelText() const
Return the text of the filename label.
const std::vector< std::pair< String, std::vector< String > > > & getFileTypeFilters() const
Returns the file filters which the user can select to only show files of a certain type.
bool getAllowCreateFolder() const
Return whether the file dialog allows the user to create a folder.
void setPath(const Filesystem::Path &path)
Changes the directory for which the files are to be displayed.
void setCreateFolderButtonText(const String &text="Create Folder")
Changes the text of the create folder button.
std::tuple< String, String, String > getListViewColumnCaptions() const
Returns the names of the list view columns.
const String & getFilename() const
Returns the filename that is entered in the filename edit box.
bool getMultiSelect() const
Returns whether multiple files can be selected.
FileDialogRenderer * getRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void setIconLoader(std::shared_ptr< FileDialogIconLoader > iconLoader)
Sets a custom icon loader.
bool canHandleKeyPress(const Event::KeyEvent &event) override
Called by the parent of the widget to check if keyPressed would process the event.
static FileDialog::Ptr copy(const FileDialog::ConstPtr &dialog)
Makes a copy of another file dialog.
void setSelectingDirectory(bool selectDirectories)
Changes whether the file dialog is used for selecting a file or for selecting a directory.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
bool getSelectingDirectory() const
Returns whether the file dialog is used for selecting a file or for selecting a directory.
void setFilenameLabelText(const String &labelText="Filename:")
Changes the text of the filename label (e.g. to display it in a different language)
void setFilename(const String &filename)
Sets the filename that is shown at the bottom of the file dialog.
FileDialog(FileDialog &&copy) noexcept
Move constructor.
const std::vector< Filesystem::Path > & getSelectedPaths() const
Returns the selected files/directories.
void setListViewColumnCaptions(const String &nameColumnText="Name", const String &sizeColumnText="Size", const String &modifiedColumnText="Modified")
Changes the names of the list view columns (e.g. to display them in a different language)
Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
FileDialog(const FileDialog &copy)
Copy constructor.
Signal onCancel
The child window was closed or the cancel button was pressed. This signal fires before onClose.
Definition FileDialog.hpp:529
static constexpr const char StaticWidgetType[]
Type name of the widget.
Definition FileDialog.hpp:67
const Filesystem::Path & getPath() const
Returns the directory that is currently being shown in the file dialog.
Object to represent paths on a filesystem.
Definition Filesystem.hpp:56
std::shared_ptr< Label > Ptr
Shared widget pointer.
Definition Label.hpp:44
std::shared_ptr< ListView > Ptr
Shared widget pointer.
Definition ListView.hpp:48
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:781
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:59
Wrapper class to store strings.
Definition String.hpp:94
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:87
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:36
KeyPressed event parameters.
Definition Event.hpp:168