Ocean
FileDialog.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Meta Platforms, Inc. and affiliates.
3  *
4  * This source code is licensed under the MIT license found in the
5  * LICENSE file in the root directory of this source tree.
6  */
7 
8 #ifndef META_OCEAN_PLATFORM_WIN_FILE_DIALOG_H
9 #define META_OCEAN_PLATFORM_WIN_FILE_DIALOG_H
10 
11 #include "ocean/platform/win/Win.h"
12 
13 namespace Ocean
14 {
15 
16 namespace Platform
17 {
18 
19 namespace Win
20 {
21 
22 /**
23  * This class implements capabilities to open file dialogs.
24  * @ingroup platformwin
25  */
26 class OCEAN_PLATFORM_WIN_EXPORT FileDialog
27 {
28  public:
29 
30  /**
31  * Shows a file dialog allowing to open a file.
32  * @param filePath The resulting file the user has selected
33  * @return True, if the user has selected a file
34  * @see saveFile().
35  */
36  static bool openFile(std::wstring& filePath);
37 
38  /**
39  * Shows a file dialog allowing to save a file.
40  * @param filePath The resulting file the user has defined
41  * @return True, if the user has defined a file
42  * @see openFile().
43  */
44  static bool saveFile(std::wstring& filePath);
45 };
46 
47 }
48 
49 }
50 
51 }
52 
53 #endif // META_OCEAN_PLATFORM_WIN_FILE_DIALOG_H
This class implements capabilities to open file dialogs.
Definition: FileDialog.h:27
static bool saveFile(std::wstring &filePath)
Shows a file dialog allowing to save a file.
static bool openFile(std::wstring &filePath)
Shows a file dialog allowing to open a file.
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15