Application class.

Header#include "nativeui/app.h"
Namespacenamespace nu

This class represents current app and provides app wide APIs.

This class can not be created by user, you must create State first and then receive an instance of App via App::GetCurrent.

nu::State state;
nu::App* app = nu::App::GetCurrent();

Class methods

App* GetCurrent()

Return current app.




void SetName(std::string name)

Set the name of current app.

The app name should be something like "My App", it will be used in vairous places, such as folder name when storing user data, or key name when writing registry.

You should always call this API at the beginning of your app.

On macOS it is strong recommended to use the same name with the CFBundleName field of app bundle's Info.plist file.


std::string GetName() const

Return current app's name.

If App::SetName(name) has never been called, this API will try to guess a name from existing information, for example the executable's version info, or the app bundle information, or the executable file's base name.



void SetID(std::string id) Windows Linux

Set the application ID.

The application ID must be globally unique, and it is recommended to use something like "org.myself.myapp".

On macOS the application ID is the app bundle ID, and there is no way to change it at runtime.

On Linux the application ID will be used in various places, such as the name of the .desktop file, or the base name of GSettings schemas.

On Windows the application ID is AppUserModelID, it is mainly used to recognize which app a process belongs to. For UWP/Desktop Bridge apps, Windows will assign an AppUserModelID to the app and this API should not be used.


std::string GetID() const

Return the application ID.

On macOS if the app is bundled, the app bundle ID will be returned, otherwise empty string will be returned.

On Linux the ID set by SetID will be returned.

On Windows the AppUserModelID will be returned. If neither you or Windows ever assigned an ID to the app, empty string will be returned.



void SetApplicationMenu(scoped_refptr<MenuBar> menu) macOS

Set the application menu bar.


MenuBar* GetApplicationMenu() const macOS

Return the application menu bar.



void SetDockBadgeLabel(const std::string& label) macOS

Set the label to be displayed in dock’s badging area.


std::string GetDockBadgeLabel() const macOS

Get the label displayed in dock’s badging area.



bool IsRunningAsUWP() const Windows

Return whether app is running as UWP/Desktop Bridge.

On Windows the Win32 apps can run as UWP apps by using Desktop Bridge, which is required for submitting Win32 apps to Microsoft Store.

There are a few runtime differences when running apps as UWP, and this API can be used to detect the environment.



bool CreateStartMenuShortcut(const App::ShortcutOptions& options) Windows

Create a start menu shortcut for current user linking to current process.

This API will write the AppUserModelID and ToastActivatorCLSID to the shortcut file, and the shortcut file's name will be the app's name, so it is recommended to call App::SetID(id) and App::SetName(name) before using this API.

Note that on Windows you should generally not write start menu shortcut automatically, by convention the file is commonly created by installers or users themselves. This API is usually used for testing purpose.




base::FilePath GetStartMenuShortcutPath() const Windows

Return file path to the shortcut created by the App::CreateStartMenuShortcut(options) API.



void Activate(bool force) macOS

Make current app the active app.

The force parameter is normally set to false. When the Finder launches an app, using a value of false for force allows the app to become active if the user waits for it to launch, but the app remains unobtrusive if the user activates another app. Regardless of the setting of flag, there may be a time lag before the app activates—you should not assume the app will be active immediately after sending this message.


void Deactivate() macOS

Deactivate current app.

bool IsActive() const macOS

Return whether current app is the active app.



void SetActivationPolicy(App::ActivationPolicy policy) macOS

Modify the app's activation policy.


App::ActivationPolicy GetActivationPolicy() const macOS

Return app's activation policy.