Ocean
platform/wxwidgets/System.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_WXWIDGETS_SYSTEM_H
9 #define META_OCEAN_PLATFORM_WXWIDGETS_SYSTEM_H
10 
12 
13 #include "ocean/io/Directory.h"
14 
15 namespace Ocean
16 {
17 
18 namespace Platform
19 {
20 
21 namespace WxWidgets
22 {
23 
24 /**
25  * This class provides basic system functionalities on wxwidgets platforms.
26  * @ingroup platformwxw
27  */
28 class OCEAN_PLATFORM_WXWIDGETS_EXPORT System
29 {
30  public:
31 
32  /**
33  * Returns the current directory used for this process.
34  * @return Current directory
35  */
37 
38  /**
39  * Returns the process directory used for this process.
40  * @return Process directory
41  */
43 
44  /**
45  * Returns a defined environment variable.
46  * @param variable Environment variable to return
47  * @param removeQuotes Determines whether all beginning and ending quotes are removed from the environment variable, if existent
48  * @return Specified environment variable
49  */
50  static std::string environmentVariable(const std::string& variable, const bool removeQuotes = true);
51 };
52 
53 }
54 
55 }
56 
57 }
58 
59 #endif // META_OCEAN_PLATFORM_WXWIDGETS_SYSTEM_H
This class holds a directory.
Definition: Directory.h:36
This class provides basic system functionalities on wxwidgets platforms.
Definition: platform/wxwidgets/System.h:29
static IO::Directory currentDirectory()
Returns the current directory used for this process.
static std::string environmentVariable(const std::string &variable, const bool removeQuotes=true)
Returns a defined environment variable.
static IO::Directory processDirectory()
Returns the process directory used for this process.
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15