Molybden API
Loading...
Searching...
No Matches
app.hpp
1// Copyright (c) 2000-2023 TeamDev Ltd. All rights reserved.
2// TeamDev PROPRIETARY and CONFIDENTIAL.
3// Use is subject to license terms.
4
5#ifndef MOLYBDEN_APP_HPP
6#define MOLYBDEN_APP_HPP
7
8#include <functional>
9#include <memory>
10#include <string>
11#include <unordered_set>
12#include <vector>
13
14#include "molybden/app/password_store_type.hpp"
15#include "molybden/app/ui_language.hpp"
16#include "molybden/base/logging.hpp"
17
18namespace molybden {
19
20class Menu;
21class Browser;
22class Profile;
23class Dock;
24class Desktop;
25class Tray;
26
27enum class AppTheme;
28enum class PathKey;
29
33struct AppOptions {
45 std::string user_data_dir;
46
50 UiLanguage ui_language = UiLanguage::kEnglishUs;
51
56
66
72 bool disable_sandbox = false;
73
79 bool disable_gpu = false;
80
84 bool enable_autoplay = false;
85
95 bool enable_incognito = false;
96
106 bool enable_h264 = false;
107
117 bool enable_aac = false;
118
127 bool enable_widevine = false;
128
138
143
152
159
167 PasswordStoreType password_store_type = PasswordStoreType::kBasic;
168
172 std::string user_agent;
173
177 std::vector<std::string> schemes;
178
183 std::unordered_set<std::string> switches;
184};
185
189class App {
190 public:
194 static void init(
195 const std::function<void(std::shared_ptr<App> app)>& callback);
196
201 static void init(
202 const AppOptions& options,
203 const std::function<void(std::shared_ptr<App> app)>& callback);
204
208 virtual const AppOptions& options() = 0;
209
213 virtual bool isProduction() = 0;
214
218 virtual std::string baseUrl() = 0;
219
225 virtual std::string name() = 0;
226
233 virtual std::string version() = 0;
234
240 virtual std::string copyright() = 0;
241
247 virtual std::string description() = 0;
248
253 virtual std::string getPath(PathKey key) = 0;
254
260 virtual void quit() = 0;
261
266 virtual std::shared_ptr<Desktop> desktop() = 0;
267
275 virtual std::shared_ptr<Dock> dock() = 0;
276
284 virtual std::shared_ptr<Profile> profile() = 0;
285
291 virtual std::shared_ptr<Profile> profile(const std::string& name) = 0;
292
296 virtual std::vector<std::shared_ptr<Profile>> profiles() = 0;
297
311 virtual void deleteProfile(std::shared_ptr<Profile> profile) = 0;
312
316 virtual std::vector<std::shared_ptr<Tray>> trays() = 0;
317
321 virtual void setMainMenu(std::shared_ptr<Menu> menu) = 0;
322
330 virtual void setTheme(AppTheme theme) = 0;
331
337 virtual AppTheme theme() = 0;
338};
339
340} // namespace molybden
341
342#endif // MOLYBDEN_APP_HPP
Provides access to Molybden app.
Definition app.hpp:189
virtual std::string description()=0
Returns the current application description.
static void init(const AppOptions &options, const std::function< void(std::shared_ptr< App > app)> &callback)
Initializes this application and creates an application instance with the given options.
virtual std::vector< std::shared_ptr< Tray > > trays()=0
Returns the list of the available (non-destroyed) application trays.
static void init(const std::function< void(std::shared_ptr< App > app)> &callback)
Initializes this application and creates an application instance.
virtual void setMainMenu(std::shared_ptr< Menu > menu)=0
Sets the given menu as the application menu on macOS.
virtual std::shared_ptr< Desktop > desktop()=0
Returns the desktop instance that provides functionality related to the desktop environment.
virtual std::string getPath(PathKey key)=0
Returns absolute path to the directory specified by the given key or an empty string if there's no su...
virtual std::string name()=0
Returns the current application name.
virtual std::string baseUrl()=0
Returns the base URL of the resource that represents app user interface.
virtual AppTheme theme()=0
Returns the application theme.
virtual std::shared_ptr< Profile > profile()=0
Returns the default app profile.
virtual std::string version()=0
Returns the current application version.
virtual const AppOptions & options()=0
Returns the app options.
virtual std::shared_ptr< Dock > dock()=0
Returns an object that allows working with the application icon in the Dock on macOS.
virtual bool isProduction()=0
Indicates whether the app is running in the production or development mode.
virtual std::string copyright()=0
Returns the current application copyright.
virtual void setTheme(AppTheme theme)=0
Sets the given theme to the app.
virtual void quit()=0
Terminates this app instance.
virtual std::shared_ptr< Profile > profile(const std::string &name)=0
Returns the profile with the given name if it exists.
virtual std::vector< std::shared_ptr< Profile > > profiles()=0
Returns the list of the profiles in this app including the default profile.
virtual void deleteProfile(std::shared_ptr< Profile > profile)=0
Deletes the given profile from the list of available profiles, closes all browsers associated with it...
The Molybden app options.
Definition app.hpp:33
std::string user_data_dir
The absolute path to the directory where the user data such as cache, cookies, history,...
Definition app.hpp:45
uint32_t remote_debugging_port
The remote debugging port number.
Definition app.hpp:65
bool enable_autoplay
Allows automatically starting video and audio playbacks on the web pages.
Definition app.hpp:84
bool warn_before_quitting
Enables the warning on quitting the application via Cmd+Q.
Definition app.hpp:151
bool disable_sandbox
Disables Chromium Sandbox.
Definition app.hpp:72
bool enable_remote_debugging_port
Enables the remote debugging port in the production mode.
Definition app.hpp:55
Logging logging
Allows configuring the application logging.
Definition app.hpp:142
bool terminate_on_failed_check
Enables the application termination in case of a failed internal check.
Definition app.hpp:137
bool enable_h264
Enables support of the H.264 codec.
Definition app.hpp:106
std::vector< std::string > schemes
The schemes that will be intercepted.
Definition app.hpp:177
PasswordStoreType password_store_type
Configures the password store type that specifies which storage backend to use to encrypt cookies on ...
Definition app.hpp:167
std::string user_agent
A string used to override the default user agent with a custom one.
Definition app.hpp:172
UiLanguage ui_language
The language used on the default error pages and the message dialogs.
Definition app.hpp:50
bool disable_gpu
Disables GPU rendering.
Definition app.hpp:79
bool enable_aac
Enables support of the AAC codec.
Definition app.hpp:117
bool enable_incognito
Enables the incognito mode for the default profile.
Definition app.hpp:95
std::unordered_set< std::string > switches
The Chromium command line switches that will be passed to the Main Chromium process.
Definition app.hpp:183
bool quit_when_last_browser_closed
Indicates if the app should quit when the last browser is closed.
Definition app.hpp:158
bool enable_widevine
Enables support of the Widevine DRM decryption.
Definition app.hpp:127
Allows configuring the application logging.
Definition logging.hpp:19