#include <qohosappcontext_p.h>

Inheritance diagram for QtOhosAppKit::AppContext:

Collaboration diagram for QtOhosAppKit::AppContext:

Signals
void	fontSizeScaleChanged (double fontSizeScale)
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
virtual bool	hasSerialPortAccessRight (const QString &portName) const =0
	Checks whether the application currently has permission to access the serial port identified by portName.
virtual void	requestSerialPortAccessRightIfNeeded (const QString &portName, QObject *context, std::function< void(std::shared_ptr< QObject >)> callback)=0
	Requests permission for the application to access the serial port identified by portName.
virtual std::shared_ptr< BundleInfo >	bundleInfo () const =0
	Returns BundleInfo object for the current application.
virtual Q_NORETURN void	restartApp (const std::optional< Want > &want)=0
	Restarts the Application.
virtual double	fontSizeScale () const =0
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlExposed () const noexcept
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static AppContext *	instance ()
	Gets AppContext global instance.
static bool	isNoUiChildMode ()
	Returns `true` if the current process was started as a "No UI" child process (see startNoUiChildProcess()), otherwise returns `false`.
static void	startNoUiChildProcess (const QString &libraryName, const QStringList &args)
	Starts "No UI" child process for a given libraryName and args.
static std::shared_ptr< WantInfo >	appLaunchWantInfo ()
	Returns the Want object that was used to launch initial instance of the application's QAbility.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool	disconnect (QMetaObject::Connection &)
static bool	disconnect (QMetaObject::Connection &&conn)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions
	AppContext ()
	~AppContext () override
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtOhosAppKit

Since: 5.12.12

The AppContext class contains API to manage native application context.

Definition at line 32 of file qohosappcontext_p.h.

Constructor & Destructor Documentation

◆ AppContext()

QtOhosAppKit::AppContext::AppContext ( )

protecteddefault

◆ ~AppContext()

QtOhosAppKit::AppContext::~AppContext ( )

overrideprotecteddefault

Member Function Documentation

◆ appLaunchWantInfo()

std::shared_ptr< WantInfo > QtOhosAppKit::AppContext::appLaunchWantInfo ( )

static

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

Definition at line 411 of file qohosappcontext.cpp.

◆ bundleInfo()

virtual std::shared_ptr< BundleInfo > QtOhosAppKit::AppContext::bundleInfo ( ) const

pure virtual

Returns BundleInfo object for the current application.

The obtained information does not contain information about the signature, HAP module, ability, ExtensionAbility, or permission.

◆ fontSizeScale()

virtual double QtOhosAppKit::AppContext::fontSizeScale ( ) const

pure virtual

◆ fontSizeScaleChanged

void QtOhosAppKit::AppContext::fontSizeScaleChanged ( double fontSizeScale )

signal

◆ hasSerialPortAccessRight()

virtual bool QtOhosAppKit::AppContext::hasSerialPortAccessRight ( const QString & portName ) const

pure virtual

Checks whether the application currently has permission to access the serial port identified by portName.

Returns true if access rights for the specified serial port are currently granted, otherwise returns false.

This function performs a synchronous check of the current permission state and does not trigger any permission request. To request access rights when they are not yet granted, use requestSerialPortAccessRightIfNeeded().

For details about the underlying platform API, see \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references/js-apis-serialmanager} {Serial Port Manager}.

See also: requestSerialPortAccessRightIfNeeded()

◆ instance()

AppContext * QtOhosAppKit::AppContext::instance ( )

static

Gets AppContext global instance.

Definition at line 354 of file qohosappcontext.cpp.

◆ isNoUiChildMode()

bool QtOhosAppKit::AppContext::isNoUiChildMode ( )

static

Returns true if the current process was started as a "No UI" child process (see startNoUiChildProcess()), otherwise returns false.

Definition at line 366 of file qohosappcontext.cpp.

◆ requestSerialPortAccessRightIfNeeded()

virtual void QtOhosAppKit::AppContext::requestSerialPortAccessRightIfNeeded	(	const QString &	portName,
		QObject *	context,
		std::function< void(std::shared_ptr< QObject >)>	callback )

pure virtual

Requests permission for the application to access the serial port identified by portName.

This function performs an asynchronous permission request. The result of the request is delivered by invoking callback on the thread of context; if context is destroyed before the response arrives, callback is not invoked.

The outcome of the request (granted or denied) is reported asynchronously through callback. If access is granted, callback provides a context object that must be kept alive for as long as the application requires access to the serial port.

If access is not granted, callback delivers nullptr. This may happen if: \list

a provided portName cannot be mapped to a valid system serial port,
an error occurred while requesting the access right,
user denied the access right. \endlist

For details about the underlying platform API, see \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references/js-apis-serialmanager} {Serial Port Manager}.

◆ restartApp()

virtual Q_NORETURN void QtOhosAppKit::AppContext::restartApp ( const std::optional< Want > & want )

pure virtual

Restarts the Application.

If want is set, the new instance is launched with it; if want is empty, the application is restarted with the app launch want.

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

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.

QtOhosAppKit::Want requestWant = QtOhosAppKit::AppContext::getAppLaunchWant();
requestWant.parameters["first_parameter"] = "first_parameter_value";
requestWant.parameters["second_parameter"] = "second_parameter_value";
QtOhosAppKit::AppContext::restartApp(requestWant);

◆ startNoUiChildProcess()

void QtOhosAppKit::AppContext::startNoUiChildProcess	(	const QString &	libraryName,
		const QStringList &	args )

static

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 \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-childprocessmanager-V5} {Child Process Manager}.

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

Definition at line 393 of file qohosappcontext.cpp.

The documentation for this class was generated from the following files:

qtbase/src/plugins/platforms/ohos/ohosappkit/qohosappcontext_p.h (b2b4258a42567f4a4f2bec950c3e01623a97a5df)
qtbase/src/plugins/platforms/ohos/ohosappkit/qohosappcontext.cpp (b2b4258a42567f4a4f2bec950c3e01623a97a5df)

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AppContext()

◆ ~AppContext()

Member Function Documentation

◆ appLaunchWantInfo()

◆ bundleInfo()

◆ fontSizeScale()

◆ fontSizeScaleChanged

◆ hasSerialPortAccessRight()

◆ instance()

◆ isNoUiChildMode()

◆ requestSerialPortAccessRightIfNeeded()

◆ restartApp()

◆ startNoUiChildProcess()