/usr/share/qt5/doc/qtqml/qtqml-referenceexamples-adding-example.html is in qtdeclarative5-doc-html 5.5.1-2ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qml-extending.qdoc -->
<title>Extending QML - Adding Types Example | Qt QML 5.5</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.5</li>
<li><a href="qtqml-index.html">Qt QML</a></li>
<li>Extending QML - Adding Types Example</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#declare-the-person-class">Declare the Person Class</a></li>
<li class="level1"><a href="#define-the-person-class">Define the Person Class</a></li>
<li class="level1"><a href="#running-the-example">Running the Example</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Extending QML - Adding Types Example</h1>
<span class="subtitle"></span>
<!-- $$$referenceexamples/adding-description -->
<div class="descr"> <a name="details"></a>
<p>The Adding Types Example shows how to add a new object type, <code>Person</code>, to QML. The <code>Person</code> type can be used from QML like this:</p>
<pre class="qml">import People 1.0
<span class="type">Person</span> {
<span class="name">name</span>: <span class="string">"Bob Jones"</span>
<span class="name">shoeSize</span>: <span class="number">12</span>
}</pre>
<a name="declare-the-person-class"></a>
<h2 id="declare-the-person-class">Declare the Person Class</h2>
<p>All QML types map to C++ types. Here we declare a basic C++ Person class with the two properties we want accessible on the QML type - name and shoeSize. Although in this example we use the same name for the C++ class as the QML type, the C++ class can be named differently, or appear in a namespace.</p>
<pre class="cpp"><span class="keyword">class</span> Person : <span class="keyword">public</span> <span class="type">QObject</span>
{
Q_OBJECT
Q_PROPERTY(<span class="type">QString</span> name READ name WRITE setName)
Q_PROPERTY(<span class="type">int</span> shoeSize READ shoeSize WRITE setShoeSize)
<span class="keyword">public</span>:
Person(<span class="type">QObject</span> <span class="operator">*</span>parent <span class="operator">=</span> <span class="number">0</span>);
<span class="type">QString</span> name() <span class="keyword">const</span>;
<span class="type">void</span> setName(<span class="keyword">const</span> <span class="type">QString</span> <span class="operator">&</span>);
<span class="type">int</span> shoeSize() <span class="keyword">const</span>;
<span class="type">void</span> setShoeSize(<span class="type">int</span>);
<span class="keyword">private</span>:
<span class="type">QString</span> m_name;
<span class="type">int</span> m_shoeSize;
};</pre>
<a name="define-the-person-class"></a>
<h2 id="define-the-person-class">Define the Person Class</h2>
<pre class="cpp">Person<span class="operator">::</span>Person(<span class="type">QObject</span> <span class="operator">*</span>parent)
: <span class="type">QObject</span>(parent)<span class="operator">,</span> m_shoeSize(<span class="number">0</span>)
{
}
<span class="type">QString</span> Person<span class="operator">::</span>name() <span class="keyword">const</span>
{
<span class="keyword">return</span> m_name;
}
<span class="type">void</span> Person<span class="operator">::</span>setName(<span class="keyword">const</span> <span class="type">QString</span> <span class="operator">&</span>n)
{
m_name <span class="operator">=</span> n;
}
<span class="type">int</span> Person<span class="operator">::</span>shoeSize() <span class="keyword">const</span>
{
<span class="keyword">return</span> m_shoeSize;
}
<span class="type">void</span> Person<span class="operator">::</span>setShoeSize(<span class="type">int</span> s)
{
m_shoeSize <span class="operator">=</span> s;
}</pre>
<p>The Person class implementation is quite basic. The property accessors simply return members of the object instance.</p>
<p>The <code>main.cpp</code> file also calls the <code>qmlRegisterType()</code> function to register the <code>Person</code> type with QML as a type in the People library version 1.0, and defines the mapping between the C++ and QML class names.</p>
<a name="running-the-example"></a>
<h2 id="running-the-example">Running the Example</h2>
<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>
<p>Files:</p>
<ul>
<li><a href="qtqml-referenceexamples-adding-example-qml.html">referenceexamples/adding/example.qml</a></li>
<li><a href="qtqml-referenceexamples-adding-person-cpp.html">referenceexamples/adding/person.cpp</a></li>
<li><a href="qtqml-referenceexamples-adding-person-h.html">referenceexamples/adding/person.h</a></li>
<li><a href="qtqml-referenceexamples-adding-main-cpp.html">referenceexamples/adding/main.cpp</a></li>
<li><a href="qtqml-referenceexamples-adding-adding-pro.html">referenceexamples/adding/adding.pro</a></li>
<li><a href="qtqml-referenceexamples-adding-adding-qrc.html">referenceexamples/adding/adding.qrc</a></li>
</ul>
</div>
<!-- @@@referenceexamples/adding -->
</div>
</div>
</div>
</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.<br> 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.<br> 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. </p>
</div>
</body>
</html>
|