<?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" /> <!-- qml-extending.qdoc --> <title>Qt 4.8: Extending QML - Inheritance and Coercion 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>QML Examples & Demos</li> <li>Extending QML - Inheritance and Coercion 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="#declare-boy-and-girl">Declare Boy and Girl</a></li> <li class="level2"><a href="#define-people-as-a-base-class">Define People as a base class</a></li> <li class="level2"><a href="#define-boy-and-girl">Define Boy and Girl</a></li> <li class="level1"><a href="#running-the-example">Running the example</a></li> </ul> </div> <h1 class="title">Extending QML - Inheritance and Coercion Example</h1> <span class="subtitle"></span> <!-- $$$declarative/cppextensions/referenceexamples/coercion-description --> <div class="descr"> <a name="details"></a> <p>Files:</p> <ul> <li><a href="declarative-cppextensions-referenceexamples-coercion-birthdayparty-cpp.html">declarative/cppextensions/referenceexamples/coercion/birthdayparty.cpp</a></li> <li><a href="declarative-cppextensions-referenceexamples-coercion-birthdayparty-h.html">declarative/cppextensions/referenceexamples/coercion/birthdayparty.h</a></li> <li><a href="declarative-cppextensions-referenceexamples-coercion-example-qml.html">declarative/cppextensions/referenceexamples/coercion/example.qml</a></li> <li><a href="declarative-cppextensions-referenceexamples-coercion-person-cpp.html">declarative/cppextensions/referenceexamples/coercion/person.cpp</a></li> <li><a href="declarative-cppextensions-referenceexamples-coercion-person-h.html">declarative/cppextensions/referenceexamples/coercion/person.h</a></li> <li><a href="declarative-cppextensions-referenceexamples-coercion-main-cpp.html">declarative/cppextensions/referenceexamples/coercion/main.cpp</a></li> <li><a href="declarative-cppextensions-referenceexamples-coercion-coercion-pro.html">declarative/cppextensions/referenceexamples/coercion/coercion.pro</a></li> <li><a href="declarative-cppextensions-referenceexamples-coercion-coercion-qrc.html">declarative/cppextensions/referenceexamples/coercion/coercion.qrc</a></li> </ul> <p>This example builds on:</p> <ul> <li><a href="declarative-cppextensions-referenceexamples-properties.html">Extending QML - Object and List Property Types Example</a></li> <li><a href="declarative-cppextensions-referenceexamples-adding.html">Extending QML - Adding Types Example</a></li> </ul> <p>The Inheritance and Coercion Example shows how to use base classes to assign elements of more than one type to a property. It specializes the Person element developed in the previous examples into two elements - a <tt>Boy</tt> and a <tt>Girl</tt>.</p> <pre class="qml"> <span class="type">BirthdayParty</span> { <span class="name">host</span>: <span class="name">Boy</span> { <span class="name">name</span>: <span class="string">"Bob Jones"</span> <span class="name">shoeSize</span>: <span class="number">12</span> } <span class="name">guests</span>: [ <span class="type">Boy</span> { <span class="name">name</span>: <span class="string">"Leo Hodges"</span> }, <span class="type">Boy</span> { <span class="name">name</span>: <span class="string">"Jack Smith"</span> }, <span class="type">Girl</span> { <span class="name">name</span>: <span class="string">"Anne Brown"</span> } ] }</pre> <a name="declare-boy-and-girl"></a> <h2>Declare Boy and Girl</h2> <pre class="cpp"> <span class="keyword">class</span> Boy : <span class="keyword">public</span> Person { Q_OBJECT <span class="keyword">public</span>: Boy(<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span> parent <span class="operator">=</span> <span class="number">0</span>); }; <span class="keyword">class</span> Girl : <span class="keyword">public</span> Person { Q_OBJECT <span class="keyword">public</span>: Girl(<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span> parent <span class="operator">=</span> <span class="number">0</span>); };</pre> <p>The Person class remains unaltered in this example and the Boy and Girl C++ classes are trivial extensions of it. As an example, the inheritance used here is a little contrived, but in real applications it is likely that the two extensions would add additional properties or modify the Person classes behavior.</p> <a name="define-people-as-a-base-class"></a> <h3>Define People as a base class</h3> <p>The implementation of the People class itself has not changed since the the previous example. However, as we have repurposed the People class as a common base for Boy and Girl, we want to prevent it from being instantiated from QML directly - an explicit Boy or Girl should be instantiated instead.</p> <pre class="cpp"> qmlRegisterType<span class="operator"><</span>Person<span class="operator">></span>();</pre> <p>While we want to disallow instantiating Person from within QML, it still needs to be registered with the QML engine, so that it can be used as a property type and other types can be coerced to it.</p> <a name="define-boy-and-girl"></a> <h3>Define Boy and Girl</h3> <p>The implementation of Boy and Girl are trivial.</p> <pre class="cpp"> Boy<span class="operator">::</span>Boy(<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span> parent) : Person(parent) { } Girl<span class="operator">::</span>Girl(<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span> parent) : Person(parent) { }</pre> <p>All that is necessary is to implement the constructor, and to register the types and their QML name with the QML engine.</p> <a name="running-the-example"></a> <h2>Running the example</h2> <p>The BirthdayParty element has not changed since the previous example. The celebrant and guests property still use the People type.</p> <pre class="cpp"> Q_PROPERTY(Person <span class="operator">*</span>host READ host WRITE setHost) Q_PROPERTY(<span class="type"><a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a></span><span class="operator"><</span>Person<span class="operator">></span> guests READ guests)</pre> <p>However, as all three types, Person, Boy and Girl, have been registered with the QML system, on assignment QML automatically (and type-safely) converts the Boy and Girl objects into a Person.</p> <p>The main.cpp file in the example includes a simple shell application that loads and runs the QML snippet shown at the beginning of this page.</p> </div> <!-- @@@declarative/cppextensions/referenceexamples/coercion --> </div> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc 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>