QDBusIntrospection Class
Information about introspected objects and interfaces on D-Bus. \internal
. More...
Header: | #include <QDBusIntrospection> |
Public Types
struct | Argument |
struct | Interface |
struct | Method |
struct | Object |
struct | Property |
struct | Signal |
Annotations | |
Arguments | |
Interfaces | |
Methods | |
Objects | |
Properties | |
Signals |
Static Public Members
Interface | parseInterface(const QString &xml) |
Interfaces | parseInterfaces(const QString &xml) |
Object | parseObject(const QString &xml, const QString &service = QString(), const QString &path = QString()) |
Detailed Description
\inmodule
QtDBus
This class provides structures and methods for parsing the XML introspection data for D-Bus. Normally, you don't have to use the methods provided here: QDBusInterface and QDBusObject will do that for you.
But they may prove useful if the XML data was obtained through other means (like parsing a file).
Member Type Documentation
QDBusIntrospection::Annotations
Contains a QMap of an annotation pair. The annotation's name is stored in the QMap key and must be unique. The annotation's value is stored in the QMap's value and is arbitrary.
QDBusIntrospection::Arguments
Contains a list of arguments to either a Method or a Signal. The arguments' order is important.
QDBusIntrospection::Interfaces
Contains a QMap of interfaces and their names. Each interface has a unique name.
QDBusIntrospection::Methods
Contains a QMap of methods and their names. The method's name is stored in the map's key and is not necessarily unique. The order in which multiple methods with the same name are stored in this map is undefined.
QDBusIntrospection::Objects
Contains a QMap of objects and their paths relative to their immediate parent.
QDBusIntrospection::Properties
Contains a QMap of properties and their names. Each property must have a unique name.
QDBusIntrospection::Signals
Contains a QMap of signals and their names. The signal's name is stored in the map's key and is not necessarily unique. The order in which multiple signals with the same name are stored in this map is undefined.
Member Function Documentation
[static]
Interface QDBusIntrospection::parseInterface(const QString &xml)
Parses the XML document fragment (given by xml) containing one interface.
The first element tag in this XML data must be either <node> or <interface>. If it is <node>, then the <interface> tag must be a child tag of the <node> one.
If there are multiple interfaces in this XML data, it is undefined which one will be returned.
[static]
Interfaces QDBusIntrospection::parseInterfaces(const QString &xml)
Parses the XML document fragment (given by xml) containing several interfaces.
If the first element tag in this document fragment is <node>, the interfaces parsed will be those found as child elements of the <node> tag.
[static]
Object QDBusIntrospection::parseObject(const QString &xml, const QString &service = QString(), const QString &path = QString())
Parses the XML document fragment (given by xml) containing one object, found at the service service and path path.
The first element tag in this document must be <node>. If that tag does not contain a name attribute, the path argument will be used to determine the path of this object node.
This function does not parse the interfaces contained in the node, nor sub-object's contents. It will only list their names.