\inmodule QtDBus More...

Enumerations
enum	AllowEmptyFlag { EmptyAllowed , EmptyNotAllowed }

Functions
Q_DBUS_EXPORT bool	isValidInterfaceName (const QString &ifaceName)
	Returns `true` if this is ifaceName is a valid interface name.
Q_DBUS_EXPORT bool	isValidUniqueConnectionName (QStringView busName)
	Returns `true` if connName is a valid unique connection name.
Q_DBUS_EXPORT bool	isValidBusName (const QString &busName)
	Returns `true` if busName is a valid bus name.
Q_DBUS_EXPORT bool	isValidMemberName (QStringView memberName)
	Returns `true` if memberName is a valid member name.
Q_DBUS_EXPORT bool	isValidErrorName (const QString &errorName)
	Returns `true` if errorName is a valid error name.
Q_DBUS_EXPORT bool	isValidPartOfObjectPath (QStringView path)
Q_DBUS_EXPORT bool	isValidObjectPath (const QString &path)
	Returns `true` if path is valid object path.
Q_DBUS_EXPORT bool	isValidFixedType (int c)
	Returns `true` if c is a valid, fixed D-Bus type.
Q_DBUS_EXPORT bool	isValidBasicType (int c)
	Returns `true` if c is a valid, basic D-Bus type.
Q_DBUS_EXPORT bool	isValidSignature (const QString &signature)
	Returns `true` if signature is a valid D-Bus type signature for one or more types.
Q_DBUS_EXPORT bool	isValidSingleSignature (const QString &signature)
	Returns `true` if signature is a valid D-Bus type signature for exactly one full type.
Q_DBUS_EXPORT QString	argumentToString (const QVariant &variant)
bool	checkInterfaceName (const QString &name, AllowEmptyFlag empty, QDBusError *error)
bool	checkBusName (const QString &name, AllowEmptyFlag empty, QDBusError *error)
bool	checkObjectPath (const QString &path, AllowEmptyFlag empty, QDBusError *error)
bool	checkMemberName (const QString &name, AllowEmptyFlag empty, QDBusError error, const char nameType=nullptr)
bool	checkErrorName (const QString &name, AllowEmptyFlag empty, QDBusError *error)
QString	dbusService ()
QString	dbusPath ()
QString	dbusPathLocal ()
QString	dbusInterface ()
QString	dbusInterfaceProperties ()
QString	dbusInterfaceIntrospectable ()
QString	nameOwnerChanged ()
QString	disconnectedErrorMessage ()

Detailed Description

\inmodule QtDBus

The QDBusUtil namespace contains a few functions that are of general use when dealing with D-Bus strings.

Enumeration Type Documentation

◆ AllowEmptyFlag

enum QDBusUtil::AllowEmptyFlag

Enumerator
EmptyAllowed
EmptyNotAllowed

Definition at line 58 of file qdbusutil_p.h.

Function Documentation

◆ argumentToString()

QString QDBusUtil::argumentToString ( const QVariant & arg )

Since: 4.5 Dumps the contents of a Qt D-Bus argument from arg into a string.

Definition at line 297 of file qdbusutil.cpp.

◆ checkBusName()

bool QDBusUtil::checkBusName	(	const QString &	name,
		AllowEmptyFlag	empty,
		QDBusError *	error )

inline

Definition at line 75 of file qdbusutil_p.h.

References EmptyAllowed.

◆ checkErrorName()

bool QDBusUtil::checkErrorName	(	const QString &	name,
		AllowEmptyFlag	empty,
		QDBusError *	error )

inline

Definition at line 113 of file qdbusutil_p.h.

References EmptyAllowed.

◆ checkInterfaceName()

bool QDBusUtil::checkInterfaceName	(	const QString &	name,
		AllowEmptyFlag	empty,
		QDBusError *	error )

inline

Definition at line 63 of file qdbusutil_p.h.

References EmptyAllowed.

◆ checkMemberName()

bool QDBusUtil::checkMemberName	(	const QString &	name,
		AllowEmptyFlag	empty,
		QDBusError *	error,
		const char *	nameType = nullptr )

inline

Definition at line 99 of file qdbusutil_p.h.

References EmptyAllowed.

◆ checkObjectPath()

bool QDBusUtil::checkObjectPath	(	const QString &	path,
		AllowEmptyFlag	empty,
		QDBusError *	error )

inline

Definition at line 87 of file qdbusutil_p.h.

References EmptyAllowed.

◆ dbusInterface()

QString QDBusUtil::dbusInterface ( )

inline

Definition at line 131 of file qdbusutil_p.h.

◆ dbusInterfaceIntrospectable()

QString QDBusUtil::dbusInterfaceIntrospectable ( )

inline

Definition at line 139 of file qdbusutil_p.h.

◆ dbusInterfaceProperties()

QString QDBusUtil::dbusInterfaceProperties ( )

inline

Definition at line 137 of file qdbusutil_p.h.

◆ dbusPath()

QString QDBusUtil::dbusPath ( )

inline

Definition at line 127 of file qdbusutil_p.h.

◆ dbusPathLocal()

QString QDBusUtil::dbusPathLocal ( )

inline

Definition at line 129 of file qdbusutil_p.h.

◆ dbusService()

QString QDBusUtil::dbusService ( )

inline

Definition at line 125 of file qdbusutil_p.h.

◆ disconnectedErrorMessage()

QString QDBusUtil::disconnectedErrorMessage ( )

inline

Definition at line 143 of file qdbusutil_p.h.

◆ isValidBasicType()

bool QDBusUtil::isValidBasicType ( int c )

Returns true if c is a valid, basic D-Bus type.

Definition at line 492 of file qdbusutil.cpp.

References isBasicType().

Referenced by QDBusMarshaller::appendCrossMarshalling(), and QDBusMarshaller::beginMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidBusName()

bool QDBusUtil::isValidBusName ( const QString & busName )

Returns true if busName is a valid bus name.

A valid bus name is either a valid unique connection name or follows the rules: \list

is not empty
does not exceed 255 characters in length
be composed of dot-separated string components that contain only ASCII letters, digits, hyphens or underscores ("_"), but don't start with a digit
contains at least two such elements \endlist

See also: isValidUniqueConnectionName()

Definition at line 402 of file qdbusutil.cpp.

◆ isValidErrorName()

bool QDBusUtil::isValidErrorName ( const QString & errorName )

Returns true if errorName is a valid error name.

Valid error names are valid interface names and vice-versa, so this function is actually an alias for isValidInterfaceName.

Definition at line 453 of file qdbusutil.cpp.

◆ isValidFixedType()

bool QDBusUtil::isValidFixedType ( int c )

Returns true if c is a valid, fixed D-Bus type.

Definition at line 501 of file qdbusutil.cpp.

References isFixedType().

Referenced by QDBusMarshaller::appendCrossMarshalling().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidInterfaceName()

bool QDBusUtil::isValidInterfaceName ( const QString & ifaceName )

Returns true if this is ifaceName is a valid interface name.

Valid interface names must: \list

not be empty
not exceed 255 characters in length
be composed of dot-separated string components that contain only ASCII letters, digits and the underscore ("_") character
contain at least two such components \endlist

Definition at line 341 of file qdbusutil.cpp.

◆ isValidMemberName()

bool QDBusUtil::isValidMemberName ( QStringView memberName )

Returns true if memberName is a valid member name.

A valid member name does not exceed 255 characters in length, is not empty, is composed only of ASCII letters, digits and underscores, but does not start with a digit.

Definition at line 434 of file qdbusutil.cpp.

◆ isValidObjectPath()

bool QDBusUtil::isValidObjectPath ( const QString & path )

Returns true if path is valid object path.

Valid object paths follow the rules: \list

start with the slash character ("/")
do not end in a slash, unless the path is just the initial slash
contain slash-separated parts, each of which is not empty, and composed only of ASCII letters, digits and underscores ("_"). \endlist

Definition at line 470 of file qdbusutil.cpp.

◆ isValidPartOfObjectPath()

bool QDBusUtil::isValidPartOfObjectPath ( QStringView part )

See isValidObjectPath

Definition at line 315 of file qdbusutil.cpp.

◆ isValidSignature()

bool QDBusUtil::isValidSignature ( const QString & signature )

Returns true if signature is a valid D-Bus type signature for one or more types.

This function returns true if it can all of signature into valid, individual types and no characters remain in signature.

See also: isValidSingleSignature()

Definition at line 515 of file qdbusutil.cpp.

References validateSingleType().

Here is the call graph for this function:

◆ isValidSingleSignature()

bool QDBusUtil::isValidSingleSignature ( const QString & signature )

Returns true if signature is a valid D-Bus type signature for exactly one full type.

This function tries to convert the type signature into a D-Bus type and, if it succeeds and no characters remain in the signature, it returns true.

Definition at line 534 of file qdbusutil.cpp.

◆ isValidUniqueConnectionName()

bool QDBusUtil::isValidUniqueConnectionName ( QStringView connName )

Returns true if connName is a valid unique connection name.

Unique connection names start with a colon (":") and are followed by a list of dot-separated components composed of ASCII letters, digits, the hyphen or the underscore ("_") character.

Definition at line 364 of file qdbusutil.cpp.

◆ nameOwnerChanged()

QString QDBusUtil::nameOwnerChanged ( )

inline

Definition at line 141 of file qdbusutil_p.h.

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ AllowEmptyFlag

Function Documentation

◆ argumentToString()

◆ checkBusName()

◆ checkErrorName()

◆ checkInterfaceName()

◆ checkMemberName()

◆ checkObjectPath()

◆ dbusInterface()

◆ dbusInterfaceIntrospectable()

◆ dbusInterfaceProperties()

◆ dbusPath()

◆ dbusPathLocal()

◆ dbusService()

◆ disconnectedErrorMessage()

◆ isValidBasicType()

◆ isValidBusName()

◆ isValidErrorName()

◆ isValidFixedType()

◆ isValidInterfaceName()

◆ isValidMemberName()

◆ isValidObjectPath()

◆ isValidPartOfObjectPath()

◆ isValidSignature()

◆ isValidSingleSignature()

◆ isValidUniqueConnectionName()

◆ nameOwnerChanged()