ngscopeclient 0.1-dev+51fbda87c
NFDFileBrowser.h
Go to the documentation of this file.
1/***********************************************************************************************************************
2* *
3* ngscopeclient *
4* *
5* Copyright (c) 2012-2024 Andrew D. Zonenberg and contributors *
6* All rights reserved. *
7* *
8* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the *
9* following conditions are met: *
10* *
11* * Redistributions of source code must retain the above copyright notice, this list of conditions, and the *
12* following disclaimer. *
13* *
14* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the *
15* following disclaimer in the documentation and/or other materials provided with the distribution. *
16* *
17* * Neither the name of the author nor the names of any contributors may be used to endorse or promote products *
18* derived from this software without specific prior written permission. *
19* *
20* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
21* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
22* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES *
23* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR *
24* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
25* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE *
26* POSSIBILITY OF SUCH DAMAGE. *
27* *
28***********************************************************************************************************************/
29
35#ifndef NFDFileBrowser_h
36#define NFDFileBrowser_h
37
38#include "FileBrowser.h"
39#include <nfd.h>
40#include <future>
41
46{
47public:
49 const std::string& initialPath,
50 const std::string& title,
51 const std::string& filterName,
52 const std::string& filterMask,
53 bool saveDialog,
54 MainWindow* parent
55 );
56 virtual ~NFDFileBrowser();
57
58 virtual void Render();
59 virtual bool IsClosed();
60 virtual bool IsClosedOK();
61 virtual std::string GetFileName();
62
63protected:
64 MainWindow* m_parent;
65
66 std::optional<std::string> ThreadProc();
67
68 std::string m_initialPath;
69 std::string m_title;
70 std::string m_filterName;
71 std::string m_filterMask;
72 bool m_saveDialog;
73
74 std::future<std::optional<std::string> > m_future;
75
76 std::optional<std::string> GetCachedResult();
77
78 bool m_cachedResultValid;
79 std::optional<std::string> m_cachedResult;
80};
81
82#endif
Declaration of FileBrowser.
Abstract base class for a dialog that displays a file picker window.
Definition: FileBrowser.h:44
Top level application window.
Definition: MainWindow.h:115
File browser backed by NativeFileDialog-extended.
Definition: NFDFileBrowser.h:46
virtual void Render()
Run imgui tasks (if needed) for the dialog.
Definition: NFDFileBrowser.cpp:89
virtual bool IsClosed()
Returns true if the dialog has been closed.
Definition: NFDFileBrowser.cpp:94
virtual std::string GetFileName()
Gets the filename the user selected.
Definition: NFDFileBrowser.cpp:110
virtual bool IsClosedOK()
Returns true if the dialog has been closed with an "OK" response.
Definition: NFDFileBrowser.cpp:102