ngscopeclient 0.1-dev+51fbda87c
FileBrowser.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 FileBrowser_h
36#define FileBrowser_h
37
38class MainWindow;
39
44{
45public:
47 virtual ~FileBrowser();
48
52 virtual void Render() =0;
53
57 virtual bool IsClosed() =0;
58
62 virtual bool IsClosedOK() =0;
63
67 virtual std::string GetFileName() =0;
68
69protected:
70};
71
72std::shared_ptr<FileBrowser> MakeFileBrowser(
73 MainWindow* wnd,
74 const std::string& initialPath,
75 const std::string& title,
76 const std::string& filterName,
77 const std::string& filterMask,
78 bool saveDialog);
79
80#endif
shared_ptr< FileBrowser > MakeFileBrowser(MainWindow *wnd, const string &initialPath, const string &title, const string &filterName, const string &filterMask, bool saveDialog)
Helper function to create the correct FileBrowser based on user preferences.
Definition: FileBrowser.cpp:62
Abstract base class for a dialog that displays a file picker window.
Definition: FileBrowser.h:44
virtual std::string GetFileName()=0
Gets the filename the user selected.
virtual bool IsClosed()=0
Returns true if the dialog has been closed.
virtual void Render()=0
Run imgui tasks (if needed) for the dialog.
virtual bool IsClosedOK()=0
Returns true if the dialog has been closed with an "OK" response.
Top level application window.
Definition: MainWindow.h:115