<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /tmp/qt-4.2.1-harald-1161357942206/qt-x11-opensource-src-4.2.1/tools/qdbus/src/qdbusargument.cpp -->
<head>
<title>Qt 4.2: QDBusArgument Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">QDBusArgument Class Reference<br /><sup><sup>[<a href="qtdbus.html">QtDBus</a> module]</sup></sup></h1>
<p>The QDBusArgument class is used to marshall and demarshall D-BUS arguments. <a href="#details">More...</a></p>
<pre> #include <QDBusArgument></pre><p>This class was introduced in Qt 4.2.</p>
<ul>
<li><a href="qdbusargument-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"/><b><a href="qdbusargument.html#QDBusArgument">QDBusArgument</a></b> ()</li>
<li><div class="fn"/><b><a href="qdbusargument.html#QDBusArgument-2">QDBusArgument</a></b> ( const QDBusArgument & <i>other</i> )</li>
<li><div class="fn"/><b><a href="qdbusargument.html#dtor.QDBusArgument">~QDBusArgument</a></b> ()</li>
<li><div class="fn"/>bool <b><a href="qdbusargument.html#atEnd">atEnd</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#beginArray">beginArray</a></b> ( int <i>id</i> )</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#beginArray-2">beginArray</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#beginMap">beginMap</a></b> ( int <i>kid</i>, int <i>vid</i> )</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#beginMap-2">beginMap</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#beginMapEntry">beginMapEntry</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#beginMapEntry-2">beginMapEntry</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#beginStructure">beginStructure</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#beginStructure-2">beginStructure</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#endArray">endArray</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#endArray-2">endArray</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#endMap">endMap</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#endMap-2">endMap</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#endMapEntry">endMapEntry</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#endMapEntry-2">endMapEntry</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#endStructure">endStructure</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qdbusargument.html#endStructure-2">endStructure</a></b> () const</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt">operator<<</a></b> ( uchar <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-2">operator<<</a></b> ( bool <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-3">operator<<</a></b> ( short <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-4">operator<<</a></b> ( ushort <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-5">operator<<</a></b> ( int <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-6">operator<<</a></b> ( uint <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-7">operator<<</a></b> ( qlonglong <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-8">operator<<</a></b> ( qulonglong <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-9">operator<<</a></b> ( double <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-10">operator<<</a></b> ( const QString & <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-13">operator<<</a></b> ( const QDBusVariant & <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-14">operator<<</a></b> ( const QStringList & <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-lt-lt-15">operator<<</a></b> ( const QByteArray & <i>arg</i> )</li>
<li><div class="fn"/>QDBusArgument & <b><a href="qdbusargument.html#operator-eq">operator=</a></b> ( const QDBusArgument & <i>other</i> )</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt">operator>></a></b> ( uchar & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-2">operator>></a></b> ( bool & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-3">operator>></a></b> ( ushort & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-4">operator>></a></b> ( short & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-5">operator>></a></b> ( int & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-6">operator>></a></b> ( uint & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-7">operator>></a></b> ( qlonglong & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-8">operator>></a></b> ( qulonglong & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-9">operator>></a></b> ( double & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-10">operator>></a></b> ( QString & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-13">operator>></a></b> ( QDBusVariant & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-14">operator>></a></b> ( QStringList & <i>arg</i> ) const</li>
<li><div class="fn"/>const QDBusArgument & <b><a href="qdbusargument.html#operator-gt-gt-15">operator>></a></b> ( QByteArray & <i>arg</i> ) const</li>
</ul>
<a name="related-non-members"></a>
<h3>Related Non-Members</h3>
<ul>
<li><div class="fn"/>int <b><a href="qdbusargument.html#qDBusRegisterMetaType">qDBusRegisterMetaType</a></b> ()</li>
<li><div class="fn"/>T <b><a href="qdbusargument.html#qdbus_cast">qdbus_cast</a></b> ( const QDBusArgument & <i>argument</i> )</li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QDBusArgument class is used to marshall and demarshall D-BUS arguments.</p>
<p>The class is used to send arguments over D-BUS to remote applications and to receive them back. D-BUS offers an extensible type system, based on a few primitive types and associations of them. See the <a href="qdbustypesystem.html">QtDBus type system</a> page for more information on the type system.</p>
<p>QDBusArgument is the central class in the <a href="qtdbus.html">QtDBus</a> type system, providing functions to marshall and demarshall the primitive types. The compound types are then created by association of one or more of the primitive types in arrays, dictionaries or structures.</p>
<p>The following example illustrates how a structure containing an integer and a string can be constructed using the <a href="qdbustypesystem.html">QtDBus type system</a>:</p>
<pre> struct MyStructure
{
int count;
QString name;
};
QT_DECLARE_METATYPE(MyStructure)
<span class="comment"> // Marshall the MyStructure data into a D-BUS argument</span>
QDBusArgument &operator<<(QDBusArgument &argument, const MyStructure &mystruct)
{
argument.beginStructure();
argument << mystruct.count << mystruct.name;
argument.endStructure();
return argument;
}
<span class="comment"> // Retrieve the MyStructure data from the D-BUS argument</span>
const QDBusArgument &operator>>(const QDBusArgument &argument, MyStructure &mystruct)
{
argument.beginStructure();
argument >> mystruct.count >> mystruct.name;
argument.endStructure();
return argument;
}</pre>
<p>The type has to be registered with <a href="qdbusargument.html#qDBusRegisterMetaType">qDBusRegisterMetaType</a>() before it can be used with QDBusArgument. Therefore, somewhere in your program, you should add the following code:</p>
<pre> qDBusRegisterMetaType<MyStructure>();</pre>
<p>Once registered, a type can be used in outgoing method calls (placed with <a href="qdbusabstractinterface.html#call">QDBusAbstractInterface::call</a>()), signal emissions from registered objects or in incoming calls from remote applications.</p>
<p>It is important to note that the <tt>operator<<</tt> and <tt>operator>></tt> streaming functions must always produce the same number of entries in case of structures, both in reading and in writing (marshalling and demarshalling), otherwise calls and signals may start to silently fail.</p>
<p>The following example illustrates this wrong usage in context of a class that may contain invalid data:</p>
<pre><font color="#404040"> // Wrongly marshall the MyTime data into a D-BUS argument
QDBusArgument &operator<<(QDBusArgument &argument, const MyTime &mytime)
{
argument.beginStructure();
if (mytime.isValid)
argument << true << mytime.hour
<< mytime.minute << mytime.second;
else
argument << false;
argument.endStructure();
return argument;
}</font></pre>
<p>In this example, both the <tt>operator<<</tt> and the <tt>operator>></tt> functions may produce a different number of reads/writes. This can confuse the <a href="qtdbus.html">QtDBus</a> type system and should be avoided.</p>
<p>See also <a href="qdbusabstractinterface.html">QDBusAbstractInterface</a>, <a href="qdbustypesystem.html">The QtDBus type system</a>, <a href="usingadaptors.html">Using Adaptors</a>, and <a href="qdbusargument.html#qdbus_cast">qdbus_cast</a>().</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QDBusArgument"></a>QDBusArgument::QDBusArgument ()</h3>
<p>Constructs an empty <a href="qdbusargument.html">QDBusArgument</a> argument.</p>
<p>An empty <a href="qdbusargument.html">QDBusArgument</a> object does not allow either reading or writing to be performed.</p>
<h3 class="fn"><a name="QDBusArgument-2"></a>QDBusArgument::QDBusArgument ( const QDBusArgument & <i>other</i> )</h3>
<p>Constructs a copy of the <i>other</i> <a href="qdbusargument.html">QDBusArgument</a> object.</p>
<p>Both objects will therefore contain the same state from this point forward. QDBusArguments are explicitly shared and, therefore, any modification to either copy will affect the other one too.</p>
<h3 class="fn"><a name="dtor.QDBusArgument"></a>QDBusArgument::~QDBusArgument ()</h3>
<p>Disposes of the resources associated with this <a href="qdbusargument.html">QDBusArgument</a> object.</p>
<h3 class="fn"><a name="atEnd"></a>bool QDBusArgument::atEnd () const</h3>
<p>Returns true if there are no more elements to be extracted from this <a href="qdbusargument.html">QDBusArgument</a>. This function is usually used in <a href="qdbusargument.html">QDBusArgument</a> objects returned from <a href="qdbusargument.html#beginMap">beginMap</a>() and <a href="qdbusargument.html#beginArray">beginArray</a>().</p>
<h3 class="fn"><a name="beginArray"></a>void QDBusArgument::beginArray ( int <i>id</i> )</h3>
<p>Opens a new D-BUS array suitable for appending elements of meta-type <i>id</i>.</p>
<p>This function is used usually in <tt>operator<<</tt> streaming operators, as in the following example:</p>
<pre><span class="comment"> // append an array of MyElement types</span>
QDBusArgument &operator<<(QDBusArgument &argument, const MyArray &myarray)
{
argument.beginArray( qMetaTypeId<MyElement>() );
for ( int i = 0; i < myarray.length; ++i )
argument << myarray.elements[i];
argument.endArray();
return argument;
}</pre>
<p>If the type you want to marshall is a <a href="qlist.html">QList</a>, <a href="qvector.html">QVector</a> or any of the Qt's <a href="containers.html">containers</a> that take one template parameter, you need not declare an <tt>operator<<</tt> function for it, since <a href="qtdbus.html">QtDBus</a> provides generic templates to do the job of marshalling the data. The same applies for STL's sequence containers, such as <tt>std::list</tt>, <tt>std::vector</tt>, etc.</p>
<p>See also <a href="qdbusargument.html#endArray">endArray</a>(), <a href="qdbusargument.html#beginStructure">beginStructure</a>(), and <a href="qdbusargument.html#beginMap">beginMap</a>().</p>
<h3 class="fn"><a name="beginArray-2"></a>void QDBusArgument::beginArray () const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Recurses into the D-BUS array to allow extraction of the array elements.</p>
<p>This function is used usually in <tt>operator>></tt> streaming operators, as in the following example:</p>
<pre><span class="comment"> // extract a MyArray array of MyElement elements</span>
const QDBusArgument &operator>>(const QDBusArgument &argument, MyArray &myarray)
{
argument.beginArray();
myarray.clear();
while ( !argument.atEnd() ) {
MyElement element;
argument >> element;
myarray.append( element );
}
argument.endArray();
return argument;
}</pre>
<p>If the type you want to demarshall is a <a href="qlist.html">QList</a>, <a href="qvector.html">QVector</a> or any of the Qt's <a href="containers.html">containers</a> that take one template parameter, you need not declare an <tt>operator>></tt> function for it, since <a href="qtdbus.html">QtDBus</a> provides generic templates to do the job of demarshalling the data. The same applies for STL's sequence containers, such as <tt>std::list</tt>, <tt>std::vector</tt>, etc.</p>
<p>See also <a href="qdbusargument.html#atEnd">atEnd</a>(), <a href="qdbusargument.html#beginStructure">beginStructure</a>(), and <a href="qdbusargument.html#beginMap">beginMap</a>().</p>
<h3 class="fn"><a name="beginMap"></a>void QDBusArgument::beginMap ( int <i>kid</i>, int <i>vid</i> )</h3>
<p>Opens a new D-BUS map suitable for appending elements. Maps are containers that associate one entry (the key) to another (the value), such as Qt's <a href="qmap.html">QMap</a> or <a href="qhash.html">QHash</a>. The ids of the map's key and value meta types must be passed in <i>kid</i> and <i>vid</i> respectively.</p>
<p>This function is used usually in <tt>operator<<</tt> streaming operators, as in the following example:</p>
<pre><span class="comment"> // append a dictionary that associates ints to MyValue types</span>
QDBusArgument &operator<<(QDBusArgument &argument, const MyDictionary &mydict)
{
argument.beginMap( QVariant::Int, qMetaTypeId<MyValue>() );
for ( int i = 0; i < mydict.length; ++i ) {
argument.beginMapEntry();
argument << mydict.data[i].key << mydict.data[i].value;
argument.endMapEntry();
}
argument.endMap();
return argument;
}</pre>
<p>If the type you want to marshall is a <a href="qmap.html">QMap</a> or <a href="qhash.html">QHash</a>, you need not declare an <tt>operator<<</tt> function for it, since <a href="qtdbus.html">QtDBus</a> provides generic templates to do the job of marshalling the data.</p>
<p>See also <a href="qdbusargument.html#endMap">endMap</a>(), <a href="qdbusargument.html#beginStructure">beginStructure</a>(), <a href="qdbusargument.html#beginArray">beginArray</a>(), and <a href="qdbusargument.html#beginMapEntry">beginMapEntry</a>().</p>
<h3 class="fn"><a name="beginMap-2"></a>void QDBusArgument::beginMap () const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Recurses into the D-BUS map to allow extraction of the map's elements.</p>
<p>This function is used usually in <tt>operator>></tt> streaming operators, as in the following example:</p>
<pre><span class="comment"> // extract a MyDictionary map that associates ints to MyValue elements</span>
const QDBusArgument &operator>>(const QDBusArgument &argument, MyDictionary &mydict)
{
argument.beginMap();
mydict.clear();
while ( !argMap.atEnd() ) {
int key;
MyValue value;
argument.beginMapEntry();
argument >> key >> value;
argument.endMapEntry();
mydict.append( key, value );
}
argument.endMap();
return argument;
}</pre>
<p>If the type you want to demarshall is a <a href="qmap.html">QMap</a> or <a href="qhash.html">QHash</a>, you need not declare an <tt>operator>></tt> function for it, since <a href="qtdbus.html">QtDBus</a> provides generic templates to do the job of demarshalling the data.</p>
<p>See also <a href="qdbusargument.html#endMap">endMap</a>(), <a href="qdbusargument.html#beginStructure">beginStructure</a>(), <a href="qdbusargument.html#beginArray">beginArray</a>(), and <a href="qdbusargument.html#beginMapEntry">beginMapEntry</a>().</p>
<h3 class="fn"><a name="beginMapEntry"></a>void QDBusArgument::beginMapEntry ()</h3>
<p>Opens a D-BUS map entry suitable for appending the key and value entries. This function is only valid when a map has been opened with <a href="qdbusargument.html#beginMap">beginMap</a>().</p>
<p>See <a href="qdbusargument.html#beginMap">beginMap</a>() for an example of usage of this function.</p>
<p>See also <a href="qdbusargument.html#endMapEntry">endMapEntry</a>() and <a href="qdbusargument.html#beginMap">beginMap</a>().</p>
<h3 class="fn"><a name="beginMapEntry-2"></a>void QDBusArgument::beginMapEntry () const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Recurses into the D-BUS map entry to allow extraction of the key and value pair.</p>
<p>See <a href="qdbusargument.html#beginMap">beginMap</a>() for an example of how this function is usually used.</p>
<p>See also <a href="qdbusargument.html#endMapEntry">endMapEntry</a>() and <a href="qdbusargument.html#beginMap">beginMap</a>().</p>
<h3 class="fn"><a name="beginStructure"></a>void QDBusArgument::beginStructure ()</h3>
<p>Opens a new D-BUS structure suitable for appending new arguments.</p>
<p>This function is used usually in <tt>operator<<</tt> streaming operators, as in the following example:</p>
<pre> QDBusArgument &operator<<(QDBusArgument &argument, const MyStructure &mystruct)
{
argument.beginStructure();
argument << mystruct.member1 << mystruct.member2 << ... ;
argument.endStructure();
return argument;
}</pre>
<p>Structures can contain other structures, so the following code is also valid:</p>
<pre> QDBusArgument &operator<<(QDBusArgument &argument, const MyStructure &mystruct)
{
argument.beginStructure();
argument << mystruct.member1 << mystruct.member2;
argument.beginStructure();
argument << mystruct.member3.subMember1 << mystruct.member3.subMember2;
argument.endStructure();
argument << mystruct.member4;
argument.endStructure();
return argument;
}</pre>
<p>See also <a href="qdbusargument.html#endStructure">endStructure</a>(), <a href="qdbusargument.html#beginArray">beginArray</a>(), and <a href="qdbusargument.html#beginMap">beginMap</a>().</p>
<h3 class="fn"><a name="beginStructure-2"></a>void QDBusArgument::beginStructure () const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Opens a D-BUS structure suitable for extracting elements.</p>
<p>This function is used usually in <tt>operator>></tt> streaming operators, as in the following example:</p>
<pre> const QDBusArgument &operator>>(const QDBusArgument &argument, MyStructure &mystruct)
{
argument.beginStructure()
argument >> mystruct.member1 >> mystruct.member2 >> mystruct.member3 >> ...;
argument.endStructure();
return argument;
}</pre>
<p>See also <a href="qdbusargument.html#endStructure">endStructure</a>(), <a href="qdbusargument.html#beginArray">beginArray</a>(), and <a href="qdbusargument.html#beginMap">beginMap</a>().</p>
<h3 class="fn"><a name="endArray"></a>void QDBusArgument::endArray ()</h3>
<p>Closes a D-BUS array opened with <a href="qdbusargument.html#beginArray">beginArray</a>(). This function must be called same number of times that <a href="qdbusargument.html#beginArray">beginArray</a>() is called.</p>
<p>See also <a href="qdbusargument.html#beginArray">beginArray</a>(), <a href="qdbusargument.html#endStructure">endStructure</a>(), and <a href="qdbusargument.html#endMap">endMap</a>().</p>
<h3 class="fn"><a name="endArray-2"></a>void QDBusArgument::endArray () const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Closes the D-BUS array and allow extracting of the next element after the array.</p>
<p>See also <a href="qdbusargument.html#beginArray">beginArray</a>().</p>
<h3 class="fn"><a name="endMap"></a>void QDBusArgument::endMap ()</h3>
<p>Closes a D-BUS map opened with <a href="qdbusargument.html#beginMap">beginMap</a>(). This function must be called same number of times that <a href="qdbusargument.html#beginMap">beginMap</a>() is called.</p>
<p>See also <a href="qdbusargument.html#beginMap">beginMap</a>(), <a href="qdbusargument.html#endStructure">endStructure</a>(), and <a href="qdbusargument.html#endArray">endArray</a>().</p>
<h3 class="fn"><a name="endMap-2"></a>void QDBusArgument::endMap () const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Closes the D-BUS map and allow extracting of the next element after the map.</p>
<p>See also <a href="qdbusargument.html#beginMap">beginMap</a>().</p>
<h3 class="fn"><a name="endMapEntry"></a>void QDBusArgument::endMapEntry ()</h3>
<p>Closes a D-BUS map entry opened with <a href="qdbusargument.html#beginMapEntry">beginMapEntry</a>(). This function must be called same number of times that <a href="qdbusargument.html#beginMapEntry">beginMapEntry</a>() is called.</p>
<p>See also <a href="qdbusargument.html#beginMapEntry">beginMapEntry</a>().</p>
<h3 class="fn"><a name="endMapEntry-2"></a>void QDBusArgument::endMapEntry () const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Closes the D-BUS map entry and allow extracting of the next element on the map.</p>
<p>See also <a href="qdbusargument.html#beginMapEntry">beginMapEntry</a>().</p>
<h3 class="fn"><a name="endStructure"></a>void QDBusArgument::endStructure ()</h3>
<p>Closes a D-BUS structure opened with <a href="qdbusargument.html#beginStructure">beginStructure</a>(). This function must be called same number of times that <a href="qdbusargument.html#beginStructure">beginStructure</a>() is called.</p>
<p>See also <a href="qdbusargument.html#beginStructure">beginStructure</a>(), <a href="qdbusargument.html#endArray">endArray</a>(), and <a href="qdbusargument.html#endMap">endMap</a>().</p>
<h3 class="fn"><a name="endStructure-2"></a>void QDBusArgument::endStructure () const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Closes the D-BUS structure and allow extracting of the next element after the structure.</p>
<p>See also <a href="qdbusargument.html#beginStructure">beginStructure</a>().</p>
<h3 class="fn"><a name="operator-lt-lt"></a>QDBusArgument & QDBusArgument::operator<< ( <a href="qtglobal.html#uchar-typedef">uchar</a> <i>arg</i> )</h3>
<p>Appends the primitive value <i>arg</i> of type <tt>BYTE</tt> to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-2"></a>QDBusArgument & QDBusArgument::operator<< ( bool <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>BOOLEAN</tt> to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-3"></a>QDBusArgument & QDBusArgument::operator<< ( short <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>INT16</tt> to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-4"></a>QDBusArgument & QDBusArgument::operator<< ( <a href="qtglobal.html#ushort-typedef">ushort</a> <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>UINT16</tt> to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-5"></a>QDBusArgument & QDBusArgument::operator<< ( int <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>INT32</tt> to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-6"></a>QDBusArgument & QDBusArgument::operator<< ( <a href="qtglobal.html#uint-typedef">uint</a> <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>UINT32</tt> to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-7"></a>QDBusArgument & QDBusArgument::operator<< ( <a href="qtglobal.html#qlonglong-typedef">qlonglong</a> <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>INT64</tt> to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-8"></a>QDBusArgument & QDBusArgument::operator<< ( <a href="qtglobal.html#qulonglong-typedef">qulonglong</a> <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>UINT64</tt> to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-9"></a>QDBusArgument & QDBusArgument::operator<< ( double <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>DOUBLE</tt> (double-precision floating-point) to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-10"></a>QDBusArgument & QDBusArgument::operator<< ( const <a href="qstring.html">QString</a> & <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>STRING</tt> (Unicode character string) to the D-BUS stream.</p>
<h3 class="fn"><a name="operator-lt-lt-13"></a>QDBusArgument & QDBusArgument::operator<< ( const <a href="qdbusvariant.html">QDBusVariant</a> & <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the primitive value <i>arg</i> of type <tt>VARIANT</tt> to the D-BUS stream.</p>
<p>A D-BUS variant type can contain any type, including other variants. It is similar to the Qt <a href="qvariant.html">QVariant</a> type.</p>
<h3 class="fn"><a name="operator-lt-lt-14"></a>QDBusArgument & QDBusArgument::operator<< ( const <a href="qstringlist.html">QStringList</a> & <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the <a href="qstringlist.html">QStringList</a> given by <i>arg</i> as <tt>ARRAY of STRING</tt> to the D-BUS stream.</p>
<p><a href="qstringlist.html">QStringList</a> and <a href="qbytearray.html">QByteArray</a> are the only two non-primitive types that are supported directly by <a href="qdbusargument.html">QDBusArgument</a> because of their widespread usage in Qt applications.</p>
<p>Other arrays are supported through compound types in <a href="qtdbus.html">QtDBus</a>.</p>
<h3 class="fn"><a name="operator-lt-lt-15"></a>QDBusArgument & QDBusArgument::operator<< ( const <a href="qbytearray.html">QByteArray</a> & <i>arg</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Appends the <a href="qbytearray.html">QByteArray</a> given by <i>arg</i> as <tt>ARRAY of BYTE</tt> to the D-BUS stream.</p>
<p><a href="qstringlist.html">QStringList</a> and <a href="qbytearray.html">QByteArray</a> are the only two non-primitive types that are supported directly by <a href="qdbusargument.html">QDBusArgument</a> because of their widespread usage in Qt applications.</p>
<p>Other arrays are supported through compound types in <a href="qtdbus.html">QtDBus</a>.</p>
<h3 class="fn"><a name="operator-eq"></a>QDBusArgument & QDBusArgument::operator= ( const QDBusArgument & <i>other</i> )</h3>
<p>Copies the <i>other</i> <a href="qdbusargument.html">QDBusArgument</a> object into this one.</p>
<p>Both objects will therefore contain the same state from this point forward. QDBusArguments are explicitly shared and, therefore, any modification to either copy will affect the other one too.</p>
<h3 class="fn"><a name="operator-gt-gt"></a>const QDBusArgument & QDBusArgument::operator>> ( <a href="qtglobal.html#uchar-typedef">uchar</a> & <i>arg</i> ) const</h3>
<p>Extracts one D-BUS primitive argument of type <tt>BYTE</tt> from the D-BUS stream and puts it into <i>arg</i>.</p>
<h3 class="fn"><a name="operator-gt-gt-2"></a>const QDBusArgument & QDBusArgument::operator>> ( bool & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>BOOLEAN</tt> from the D-BUS stream.</p>
<h3 class="fn"><a name="operator-gt-gt-3"></a>const QDBusArgument & QDBusArgument::operator>> ( <a href="qtglobal.html#ushort-typedef">ushort</a> & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>UINT16</tt> from the D-BUS stream.</p>
<h3 class="fn"><a name="operator-gt-gt-4"></a>const QDBusArgument & QDBusArgument::operator>> ( short & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>INT16</tt> from the D-BUS stream.</p>
<h3 class="fn"><a name="operator-gt-gt-5"></a>const QDBusArgument & QDBusArgument::operator>> ( int & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>INT32</tt> from the D-BUS stream.</p>
<h3 class="fn"><a name="operator-gt-gt-6"></a>const QDBusArgument & QDBusArgument::operator>> ( <a href="qtglobal.html#uint-typedef">uint</a> & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>UINT32</tt> from the D-BUS stream.</p>
<h3 class="fn"><a name="operator-gt-gt-7"></a>const QDBusArgument & QDBusArgument::operator>> ( <a href="qtglobal.html#qlonglong-typedef">qlonglong</a> & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>INT64</tt> from the D-BUS stream.</p>
<h3 class="fn"><a name="operator-gt-gt-8"></a>const QDBusArgument & QDBusArgument::operator>> ( <a href="qtglobal.html#qulonglong-typedef">qulonglong</a> & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>UINT64</tt> from the D-BUS stream.</p>
<h3 class="fn"><a name="operator-gt-gt-9"></a>const QDBusArgument & QDBusArgument::operator>> ( double & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>DOUBLE</tt> (double-precision floating pount) from the D-BUS stream.</p>
<h3 class="fn"><a name="operator-gt-gt-10"></a>const QDBusArgument & QDBusArgument::operator>> ( <a href="qstring.html">QString</a> & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>STRING</tt> (Unicode character string) from the D-BUS stream.</p>
<h3 class="fn"><a name="operator-gt-gt-13"></a>const QDBusArgument & QDBusArgument::operator>> ( <a href="qdbusvariant.html">QDBusVariant</a> & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts one D-BUS primitive argument of type <tt>VARIANT</tt> from the D-BUS stream.</p>
<p>A D-BUS variant type can contain any type, including other variants. It is similar to the Qt <a href="qvariant.html">QVariant</a> type.</p>
<p>In case the variant contains a type not directly supported by <a href="qdbusargument.html">QDBusArgument</a>, the value of the returned <a href="qdbusvariant.html">QDBusVariant</a> will contain another <a href="qdbusargument.html">QDBusArgument</a>. It is your responsibility to further demarshall it into another type.</p>
<h3 class="fn"><a name="operator-gt-gt-14"></a>const QDBusArgument & QDBusArgument::operator>> ( <a href="qstringlist.html">QStringList</a> & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts an array of strings from the D-BUS stream and return it as a <a href="qstringlist.html">QStringList</a>.</p>
<p><a href="qstringlist.html">QStringList</a> and <a href="qbytearray.html">QByteArray</a> are the only two non-primitive types that are supported directly by <a href="qdbusargument.html">QDBusArgument</a> because of their widespread usage in Qt applications.</p>
<p>Other arrays are supported through compound types in <a href="qtdbus.html">QtDBus</a>.</p>
<h3 class="fn"><a name="operator-gt-gt-15"></a>const QDBusArgument & QDBusArgument::operator>> ( <a href="qbytearray.html">QByteArray</a> & <i>arg</i> ) const</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Extracts an array of bytes from the D-BUS stream and return it as a <a href="qbytearray.html">QByteArray</a>.</p>
<p><a href="qstringlist.html">QStringList</a> and <a href="qbytearray.html">QByteArray</a> are the only two non-primitive types that are supported directly by <a href="qdbusargument.html">QDBusArgument</a> because of their widespread usage in Qt applications.</p>
<p>Other arrays are supported through compound types in <a href="qtdbus.html">QtDBus</a>.</p>
<hr />
<h2>Related Non-Members</h2>
<h3 class="fn"><a name="qDBusRegisterMetaType"></a>int qDBusRegisterMetaType ()</h3>
<p>Registers <tt>T</tt> with the <a href="qdbustypesystem.html">QtDBus type system</a> and the Qt <a href="qmetatype.html">meta-type system</a>, if it's not already registered.</p>
<p>To register a type, it must be declared as a meta-type with the <a href="qmetatype.html#Q_DECLARE_METATYPE">Q_DECLARE_METATYPE</a>() macro, and then registered as in the following example:</p>
<pre> qDBusRegisterMetaType<MyClass>();</pre>
<p>If <tt>T</tt> isn't a type derived from one of Qt's <a href="containers.html#container-classes">container classes</a>, the <tt>operator<<</tt> and <tt>operator>></tt> streaming operators between <tt>T</tt> and <a href="qdbusargument.html">QDBusArgument</a> must be already declared. See the <a href="qdbustypesystem.html">QtDBus type system</a> page for more information on how to declare such types.</p>
<p>This function returns the Qt meta type id for the type (the same value that is returned from <a href="qmetatype.html#qRegisterMetaType">qRegisterMetaType</a>()).</p>
<p><b>Note:</b> This function is <a href="threads.html#thread-safe">thread-safe</a>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p>See also <a href="qdbustypesystem.html">QtDBus type system</a>, <a href="qmetatype.html#qRegisterMetaType">qRegisterMetaType</a>(), and <a href="qmetatype.html">QMetaType</a>.</p>
<h3 class="fn"><a name="qdbus_cast"></a>T qdbus_cast ( const QDBusArgument & <i>argument</i> )</h3>
<p>Attempts to demarshall the contents of <i>argument</i> into the type <tt>T</tt>. For example:</p>
<pre> MyType item = qdbus_cast<Type>(argument);</pre>
<p>Note that it is equivalent to the following:</p>
<pre> MyType item;
argument >> item;</pre>
<p>This function was introduced in Qt 4.2.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2006 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.2.1</div></td>
</tr></table></div></address></body>
</html>
