<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- customtype.qdoc --> <title>Qt 4.8: Custom Type Example</title> <link rel="stylesheet" type="text/css" href="style/style.css" /> <script src="scripts/jquery.js" type="text/javascript"></script> <script src="scripts/functions.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="style/superfish.css" /> <link rel="stylesheet" type="text/css" href="style/narrow.css" /> <!--[if IE]> <meta name="MSSmartTagsPreventParsing" content="true"> <meta http-equiv="imagetoolbar" content="no"> <![endif]--> <!--[if lt IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie6.css"> <![endif]--> <!--[if IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie7.css"> <![endif]--> <!--[if IE 8]> <link rel="stylesheet" type="text/css" href="style/style_ie8.css"> <![endif]--> <script src="scripts/superfish.js" type="text/javascript"></script> <script src="scripts/narrow.js" type="text/javascript"></script> </head> <body class="" onload="CheckEmptyAndLoadList();"> <div class="header" id="qtdocheader"> <div class="content"> <div id="nav-logo"> <a href="index.html">Home</a></div> <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a> <div id="narrowsearch"></div> <div id="nav-topright"> <ul> <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li> <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li> <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/"> DOC</a></li> <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li> </ul> </div> <div id="shortCut"> <ul> <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li> <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li> </ul> </div> <ul class="sf-menu" id="narrowmenu"> <li><a href="#">API Lookup</a> <ul> <li><a href="classes.html">Class index</a></li> <li><a href="functions.html">Function index</a></li> <li><a href="modules.html">Modules</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="qtglobal.html">Global Declarations</a></li> <li><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </li> <li><a href="#">Qt Topics</a> <ul> <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li><a href="supported-platforms.html">Supported Platforms</a></li> <li><a href="technology-apis.html">Qt and Key Technologies</a></li> <li><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </li> <li><a href="#">Examples</a> <ul> <li><a href="all-examples.html">Examples</a></li> <li><a href="tutorials.html">Tutorials</a></li> <li><a href="demos.html">Demos</a></li> <li><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </li> </ul> </div> </div> <div class="wrapper"> <div class="hd"> <span></span> </div> <div class="bd group"> <div class="sidebar"> <div class="searchlabel"> Search index:</div> <div class="search" id="sidebarsearch"> <form id="qtdocsearch" action="" onsubmit="return false;"> <fieldset> <input type="text" name="searchstring" id="pageType" value="" /> <div id="resultdialog"> <a href="#" id="resultclose">Close</a> <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p> <ul id="resultlist" class="all"> </ul> </div> </fieldset> </form> </div> <div class="box first bottombar" id="lookup"> <h2 title="API Lookup"><span></span> API Lookup</h2> <div id="list001" class="list"> <ul id="ul001" > <li class="defaultLink"><a href="classes.html">Class index</a></li> <li class="defaultLink"><a href="functions.html">Function index</a></li> <li class="defaultLink"><a href="modules.html">Modules</a></li> <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li> <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li> <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </div> </div> <div class="box bottombar" id="topics"> <h2 title="Qt Topics"><span></span> Qt Topics</h2> <div id="list002" class="list"> <ul id="ul002" > <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li> <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </div> </div> <div class="box" id="examples"> <h2 title="Examples"><span></span> Examples</h2> <div id="list003" class="list"> <ul id="ul003"> <li class="defaultLink"><a href="all-examples.html">Examples</a></li> <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li> <li class="defaultLink"><a href="demos.html">Demos</a></li> <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </div> </div> </div> <div class="wrap"> <div class="toolbar"> <div class="breadcrumb toolblock"> <ul> <li class="first"><a href="index.html">Home</a></li> <!-- Breadcrumbs go here --> <li><a href="all-examples.html">Examples</a></li> <li>Custom Type Example</li> </ul> </div> <div class="toolbuttons toolblock"> <ul> <li id="smallA" class="t_button">A</li> <li id="medA" class="t_button active">A</li> <li id="bigA" class="t_button">A</li> <li id="print" class="t_button"><a href="javascript:this.print();"> <span>Print</span></a></li> </ul> </div> </div> <div class="content mainContent"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#overview">Overview</a></li> <li class="level1"><a href="#the-message-class-definition">The Message Class Definition</a></li> <li class="level1"><a href="#the-message-class-implementation">The Message Class Implementation</a></li> <li class="level1"><a href="#using-the-message">Using the Message</a></li> <li class="level1"><a href="#further-reading">Further Reading</a></li> </ul> </div> <h1 class="title">Custom Type Example</h1> <span class="subtitle"></span> <!-- $$$tools/customtype-description --> <div class="descr"> <a name="details"></a> <p>Files:</p> <ul> <li><a href="tools-customtype-message-cpp.html">tools/customtype/message.cpp</a></li> <li><a href="tools-customtype-message-h.html">tools/customtype/message.h</a></li> <li><a href="tools-customtype-main-cpp.html">tools/customtype/main.cpp</a></li> <li><a href="tools-customtype-customtype-pro.html">tools/customtype/customtype.pro</a></li> </ul> <p>The Custom Type example shows how to integrate a custom type into Qt's meta-object system.<p>Contents:</p> <a name="overview"></a> <h2>Overview</h2> <p>Qt provides a range of standard value types that are used to provide rich and meaningful APIs. These types are integrated with the meta-object system, enabling them to be stored in <a href="qvariant.html">QVariant</a> objects, written out in debugging information and sent between components in signal-slot communication.</p> <p>Custom types can also be integrated with the meta-object system as long as they are written to conform to some simple guidelines. In this example, we introduce a simple <tt>Message</tt> class, we describe how we make it work with <a href="qvariant.html">QVariant</a>, and we show how it can be extended to generate a printable representation of itself for use in debugging output.</p> <a name="the-message-class-definition"></a> <h2>The Message Class Definition</h2> <p>The <tt>Message</tt> class is a simple value class that contains two pieces of information (a <a href="qstring.html">QString</a> and a <a href="qstringlist.html">QStringList</a>), each of which can be read using trivial getter functions:</p> <pre class="cpp"> <span class="keyword">class</span> Message { <span class="keyword">public</span>: Message(); Message(<span class="keyword">const</span> Message <span class="operator">&</span>other); <span class="operator">~</span>Message(); Message(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>body<span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="qstringlist.html">QStringList</a></span> <span class="operator">&</span>headers); <span class="type"><a href="qstring.html">QString</a></span> body() <span class="keyword">const</span>; <span class="type"><a href="qstringlist.html">QStringList</a></span> headers() <span class="keyword">const</span>; <span class="keyword">private</span>: <span class="type"><a href="qstring.html">QString</a></span> m_body; <span class="type"><a href="qstringlist.html">QStringList</a></span> m_headers; };</pre> <p>The default constructor, copy constructor and destructor are all required, and must be public, if the type is to be integrated into the meta-object system. Other than this, we are free to implement whatever we need to make the type do what we want, so we also include a constructor that lets us set the type's data members.</p> <p>To enable the type to be used with <a href="qvariant.html">QVariant</a>, we declare it using the <a href="qmetatype.html#Q_DECLARE_METATYPE">Q_DECLARE_METATYPE</a>() macro:</p> <pre class="cpp"> <a href="qmetatype.html#Q_DECLARE_METATYPE">Q_DECLARE_METATYPE</a>(Message);</pre> <p>We do not need to write any additional code to accompany this macro.</p> <p>To allow us to see a readable description of each <tt>Message</tt> object when it is sent to the debug output stream, we define a streaming operator:</p> <pre class="cpp"> <span class="type"><a href="qdebug.html">QDebug</a></span> <span class="keyword">operator</span><span class="operator"><</span><span class="operator"><</span>(<span class="type"><a href="qdebug.html">QDebug</a></span> dbg<span class="operator">,</span> <span class="keyword">const</span> Message <span class="operator">&</span>message);</pre> <p>This facility is useful if you need to insert tracing statements in your code for debugging purposes.</p> <a name="the-message-class-implementation"></a> <h2>The Message Class Implementation</h2> <p>The implementation of the default constructor, copy constructor and destructor are straightforward for the <tt>Message</tt> class:</p> <pre class="cpp"> Message<span class="operator">::</span>Message() { } Message<span class="operator">::</span>Message(<span class="keyword">const</span> Message <span class="operator">&</span>other) { m_body <span class="operator">=</span> other<span class="operator">.</span>m_body; m_headers <span class="operator">=</span> other<span class="operator">.</span>m_headers; } Message<span class="operator">::</span><span class="operator">~</span>Message() { }</pre> <p>The streaming operator is implemented in the following way:</p> <pre class="cpp"> <span class="type"><a href="qdebug.html">QDebug</a></span> <span class="keyword">operator</span><span class="operator"><</span><span class="operator"><</span>(<span class="type"><a href="qdebug.html">QDebug</a></span> dbg<span class="operator">,</span> <span class="keyword">const</span> Message <span class="operator">&</span>message) { <span class="type"><a href="qstringlist.html">QStringList</a></span> pieces <span class="operator">=</span> message<span class="operator">.</span>body()<span class="operator">.</span>split(<span class="string">"\r\n"</span><span class="operator">,</span> <span class="type"><a href="qstring.html">QString</a></span><span class="operator">::</span>SkipEmptyParts); <span class="keyword">if</span> (pieces<span class="operator">.</span>isEmpty()) dbg<span class="operator">.</span>nospace() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Message()"</span>; <span class="keyword">else</span> <span class="keyword">if</span> (pieces<span class="operator">.</span>size() <span class="operator">=</span><span class="operator">=</span> <span class="number">1</span>) dbg<span class="operator">.</span>nospace() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Message("</span> <span class="operator"><</span><span class="operator"><</span> pieces<span class="operator">.</span>first() <span class="operator"><</span><span class="operator"><</span> <span class="string">")"</span>; <span class="keyword">else</span> dbg<span class="operator">.</span>nospace() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Message("</span> <span class="operator"><</span><span class="operator"><</span> pieces<span class="operator">.</span>first() <span class="operator"><</span><span class="operator"><</span> <span class="string">" ...)"</span>; <span class="keyword">return</span> dbg<span class="operator">.</span>maybeSpace(); }</pre> <p>Here, we want to represent each value depending on how many lines are stored in the message body. We stream text to the <a href="qdebug.html">QDebug</a> object passed to the operator and return the <a href="qdebug.html">QDebug</a> object obtained from its maybeSpace() member function; this is described in more detail in the <a href="custom-types.html#making-the-type-printable">Creating Custom Qt Types</a> document.</p> <p>We include the code for the getter functions for completeness:</p> <pre class="cpp"> <span class="type"><a href="qstring.html">QString</a></span> Message<span class="operator">::</span>body() <span class="keyword">const</span> { <span class="keyword">return</span> m_body; } <span class="type"><a href="qstringlist.html">QStringList</a></span> Message<span class="operator">::</span>headers() <span class="keyword">const</span> { <span class="keyword">return</span> m_headers; }</pre> <p>With the type fully defined, implemented, and integrated with the meta-object system, we can now use it.</p> <a name="using-the-message"></a> <h2>Using the Message</h2> <p>In the example's <tt>main()</tt> function, we show how a <tt>Message</tt> object can be printed to the console by sending it to the debug stream:</p> <pre class="cpp"> Message message(body<span class="operator">,</span> headers); <a href="qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Original:"</span> <span class="operator"><</span><span class="operator"><</span> message;</pre> <p>You can use the type with <a href="qvariant.html">QVariant</a> in exactly the same way as you would use standard Qt value types. Here's how to store a value using the <a href="qvariant.html#setValue">QVariant::setValue</a>() function:</p> <pre class="cpp"> <span class="type"><a href="qvariant.html">QVariant</a></span> stored; stored<span class="operator">.</span>setValue(message);</pre> <p>Alternatively, the <a href="qvariant.html#fromValue">QVariant::fromValue</a>() and <a href="qvariant-obsolete.html#qVariantSetValue" class="obsolete">qVariantSetValue</a>() functions can be used if you are using a compiler without support for member template functions.</p> <p>The value can be retrieved using the <a href="qvariant.html#value">QVariant::value</a>() member template function:</p> <pre class="cpp"> Message retrieved <span class="operator">=</span> stored<span class="operator">.</span>value<span class="operator"><</span>Message<span class="operator">></span>(); <a href="qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Retrieved:"</span> <span class="operator"><</span><span class="operator"><</span> retrieved; retrieved <span class="operator">=</span> qvariant_cast<span class="operator"><</span>Message<span class="operator">></span>(stored); <a href="qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Retrieved:"</span> <span class="operator"><</span><span class="operator"><</span> retrieved;</pre> <p>Alternatively, the <a href="qvariant-qt3.html#qVariantValue" class="compat">qVariantValue</a>() template function can be used if you are using a compiler without support for member template functions.</p> <a name="further-reading"></a> <h2>Further Reading</h2> <p>The custom <tt>Message</tt> type can also be used with direct signal-slot connections; see the <a href="tools-customtypesending.html">Custom Type Sending Example</a> for a demonstration of this. To register a custom type for use with queued signals and slots, such as those used in cross-thread communication, see the <a href="threads-queuedcustomtype.html">Queued Custom Type Example</a>.</p> <p>More information on using custom types with Qt can be found in the <a href="custom-types.html">Creating Custom Qt Types</a> document.</p> </div> <!-- @@@tools/customtype --> </div> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.</p> <br /> <p> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.</p> <p> Documentation sources may be obtained from <a href="http://www.qt-project.org"> www.qt-project.org</a>.</p> <br /> <p> Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. <a title="Privacy Policy" href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p> </div> <script src="scripts/functions.js" type="text/javascript"></script> </body> </html>