Qt for HarmonyOS/qtohosextras doc/QOhosAppContext Class

< Qt for HarmonyOS / qtohosextras doc

QOhosAppContext Class

The QOhosAppContext class contains API to manage native application context. More...

Header:	#include <QOhosAppContext>
qmake:	QT += ohosextras
Since:	Qt 5.12.12
Inherits:	QObject

• List of all members, including inherited members
• Obsolete members

Public Types

enum	ColorThemeMode { LightTheme, DarkTheme, FollowSystemSetting }

Public Functions

virtual bool	darkThemeActive() const = 0
virtual void	enableContextMenuEventOnLongPress() = 0
virtual double	fontSizeScale() const = 0
int	getBundleInfo() const
virtual bool	isPermissionGranted(int permission) const = 0
virtual bool	isPermissionGranted(const QString &permissionName) const = 0
virtual void	requestPermissionFromUserIfNeeded(int permission) = 0
virtual void	requestPermissionOnSettingIfNeeded(int permission) = 0
virtual void	restartApp() = 0
virtual void	restartApp(const int &want) = 0
virtual void	setColorThemeMode(QtOhosExtras::QOhosAppContext::ColorThemeMode mode) = 0

Signals

void	darkThemeActiveChanged(bool darkThemeActive)
void	fontSizeScaleChanged(double fontSizeScale)
void	permissionRequestOnSettingResponseReceived(int permission, bool permissionGranted)
void	permissionRequestResponseReceived(int permission, bool permissionGranted)
void	permissionRequestResponseWithResultReceived(int permission, int result)

Static Public Members

int	getAppLaunchWant()
int	getAppLaunchWantInfo()
QtOhosExtras::QOhosAppContext *	instance()
bool	isNoUiChildMode()
void	startNoUiChildProcess(QString libraryName, QStringList args)
const QMetaObject	staticMetaObject

Protected Functions

	QOhosAppContext()
	QOhosAppContext(const QtOhosExtras::QOhosAppContext &)
virtual	~QOhosAppContext() override
QtOhosExtras::QOhosAppContext &	operator=(const QtOhosExtras::QOhosAppContext &)

Detailed Description

The QOhosAppContext class contains API to manage native application context.

Member Type Documentation

enum QOhosAppContext::ColorThemeMode

Defines the color theme mode for the application.

Constant	Value	Description
QtOhosExtras::QOhosAppContext::LightTheme	0	Uses the light theme colors (default).
QtOhosExtras::QOhosAppContext::DarkTheme	1	Uses the dark theme colors.
QtOhosExtras::QOhosAppContext::FollowSystemSetting	2	Automatically updates the theme based on the system setting.

Member Function Documentation

[protected] QOhosAppContext::QOhosAppContext()

Default constructs an instance of QOhosAppContext.

[protected] QOhosAppContext::QOhosAppContext(const QtOhosExtras::QOhosAppContext &)

Default constructs an instance of QOhosAppContext.

[override virtual protected] QOhosAppContext::~QOhosAppContext()

Destroys the instance of QOhosAppContext. The destructor is virtual.

[pure virtual] bool QOhosAppContext::darkThemeActive() const

Returns whether the dark color theme is active. By default, this function returns `false`, meaning the light theme is used.

[signal] void QOhosAppContext::darkThemeActiveChanged(bool darkThemeActive)

Signal emitted when the application's color theme changes between dark and light modes.

[pure virtual] void QOhosAppContext::enableContextMenuEventOnLongPress()

Enable context menu triggering on long press touch for the entire application lifetime. Mimic Windows long touch behavior by generating a contextMenuEvent with the QContextMenuEvent::Other reason.

The function should be called at the application start, before app.exec();.

[pure virtual] double QOhosAppContext::fontSizeScale() const

Returns font size scale ratio. The value ranges from 0 to 3.2. The default value is 1. See Font Size Scale.

[signal] void QOhosAppContext::fontSizeScaleChanged(double fontSizeScale)

Signal emitted on system configuration update. fontSizeScale is the system current font size scale. See Configuration Updated.

[static] int QOhosAppContext::getAppLaunchWant()

Returns the Want object that was used to launch initial instance of the application's QAbility. It is recommended to use newer getAppLaunchWantInfo() method.

[static] int QOhosAppContext::getAppLaunchWantInfo()

Returns the Want object that was used to launch initial instance of the application's QAbility.

int QOhosAppContext::getBundleInfo() const

Returns QOhosBundleInfo object for the current application. The obtained information does not contain information about the signature, HAP module, ability, ExtensionAbility, or permission.

[static] QtOhosExtras::QOhosAppContext *QOhosAppContext::instance()

Gets QOhosAppContext global instance.

[static] bool QOhosAppContext::isNoUiChildMode()

Returns true if the current process was started as a "No UI" child.

[pure virtual] bool QOhosAppContext::isPermissionGranted(int permission) const

Returns true if a given permission is granted, false otherwise. See Check Access Token.

[signal] void QOhosAppContext::permissionRequestOnSettingResponseReceived(int permission, bool permissionGranted)

Signal emitted on requestPermissionOnSettingIfNeeded(QtOhosExtras::AppPermissions::Permission permission) request result. Provides permissionGranted state for a checked permission.

See also requestPermissionOnSettingIfNeeded(QtOhosExtras::AppPermissions::Permission permission).

[signal] void QOhosAppContext::permissionRequestResponseReceived(int permission, bool permissionGranted)

Signal emitted on requestPermissionFromUserIfNeeded() request result. Provides permissionGranted state for a checked permission.

See also requestPermissionFromUserIfNeeded().

[signal] void QOhosAppContext::permissionRequestResponseWithResultReceived(int permission, int result)

Signal emitted on requestPermissionFromUserIfNeeded() request result. Provides result for a checked permission.

See also requestPermissionFromUserIfNeeded().

[pure virtual] void QOhosAppContext::requestPermissionFromUserIfNeeded(int permission)

Request a given application permission from the User. This is asynchronous call which result will be emitted by permissionRequestResponseReceived() signal.

See also permissionRequestResponseReceived().

[pure virtual] void QOhosAppContext::requestPermissionOnSettingIfNeeded(int permission)

Request a given application permission in a Settings dialog box. This is asynchronous call which result will be emitted by permissionRequestOnSettingResponseReceived() signal.

See also permissionRequestOnSettingResponseReceived().

[pure virtual] void QOhosAppContext::restartApp()

Restarts the Application using the app launch want.

The current application will be killed using SIGKILL and a new instance of the application will be launched with the application start want.

All abilities and sub-widnows created within this process will be closed.

The application will be killed ungracefully. This function won't return to the caller.

The caller must ensure, that the application has system focus when this function is called, otherwise the application will be killed but the new application won't be started. OHOS system treats some system dialogs (for example File Dialog) as separate from the application. If such dialog is open, the application loses the system focus.

If restartApp is called too frequently, the system call will be throttled to avoid errors.

Use this function, if you want to restart app with app launch want, instead of calling.

See also QtOhosExtras::QOhosAppContext::restartApp(const QtOhosExtras::QOhosWant &requestWant), with, QtOhosExtras::QOhosAppContext::getAppLaunchWant(), as, a, parameter, and ..

[pure virtual] void QOhosAppContext::setColorThemeMode(QtOhosExtras::QOhosAppContext::ColorThemeMode mode)

Sets the application's color theme to fixed value or enables automatic theme updates.

Calling this function with mode `FollowSystemSetting` allows the application to adjust its theme dynamically based on the system's theme configuration. The theme will be updated to match the system theme when `FollowSystemSetting` is set. See Configuration Updated. If the color theme actually changes as a result of this call, the darkThemeActiveChanged() signal will be emitted.

See also darkThemeActive() and darkThemeActiveChanged().

[static] void QOhosAppContext::startNoUiChildProcess(QString libraryName, QStringList args)

Starts "No UI" child process for a given libraryName and args. Arguments passed to the startNoUiChildProcess() function are forwarded to the child's main() function. See Child Process Manager.

QtOhosExtras::QOhosAppContext::startNoUiChildProcess(
     "libapp.so",
     QStringList{
         "first arg",
         "second arg",
     });

[protected] QtOhosExtras::QOhosAppContext &QOhosAppContext::operator=(const QtOhosExtras::QOhosAppContext &)

Copy-assignment operator.