d9b2c00228
git-subtree-dir: libraries/ZWidget git-subtree-split: 96501b6ef11e8737cd8ccb2451395115b810dfcc
55 lines
1.8 KiB
C++
55 lines
1.8 KiB
C++
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
class Widget;
|
|
|
|
/// \brief Displays the system open file dialog.
|
|
class OpenFileDialog
|
|
{
|
|
public:
|
|
/// \brief Constructs an open file dialog.
|
|
static std::unique_ptr<OpenFileDialog> Create(Widget* owner);
|
|
|
|
virtual ~OpenFileDialog() = default;
|
|
|
|
/// \brief Get the full path of the file selected.
|
|
///
|
|
/// If multiple files are selected, this returns the first file.
|
|
virtual std::string Filename() const = 0;
|
|
|
|
/// \brief Gets an array that contains one file name for each selected file.
|
|
virtual std::vector<std::string> Filenames() const = 0;
|
|
|
|
/// \brief Sets if multiple files can be selected or not.
|
|
/// \param multiselect = When true, multiple items can be selected.
|
|
virtual void SetMultiSelect(bool multiselect) = 0;
|
|
|
|
/// \brief Sets a string containing the full path of the file selected.
|
|
virtual void SetFilename(const std::string &filename) = 0;
|
|
|
|
/// \brief Sets the default extension to use.
|
|
virtual void SetDefaultExtension(const std::string& extension) = 0;
|
|
|
|
/// \brief Add a filter that determines what types of files are displayed.
|
|
virtual void AddFilter(const std::string &filter_description, const std::string &filter_extension) = 0;
|
|
|
|
/// \brief Clears all filters.
|
|
virtual void ClearFilters() = 0;
|
|
|
|
/// \brief Sets a default filter, on a 0-based index.
|
|
virtual void SetFilterIndex(int filter_index) = 0;
|
|
|
|
/// \brief Sets the initial directory that is displayed.
|
|
virtual void SetInitialDirectory(const std::string &path) = 0;
|
|
|
|
/// \brief Sets the text that appears in the title bar.
|
|
virtual void SetTitle(const std::string &title) = 0;
|
|
|
|
/// \brief Shows the file dialog.
|
|
/// \return true if the user clicks the OK button of the dialog that is displayed, false otherwise.
|
|
virtual bool Show() = 0;
|
|
};
|