/usr/share/qt5/doc/qtlocation/qml-qtlocation-contactdetails.html is in qtlocation5-doc-html 5.5.1-3ubuntu1.
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 124 125 126 127 128 129 130 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativecontactdetail.cpp -->
<title>ContactDetails QML Type | Qt Location 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="qtlocation-index.html">Qt Location</a></li>
<li><a href="qtlocation-qmlmodule.html">QML Types</a></li>
<li>ContactDetails QML Type</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="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#examples">Examples</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">ContactDetails QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ContactDetails-brief -->
<p>The <a href="qml-qtlocation-contactdetails.html">ContactDetails</a> type holds contact details for a <a href="qml-qtlocation-place.html">Place</a>. <a href="#details">More...</a></p>
<!-- @@@ContactDetails -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtLocation 5.3</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt Location 5.5</td></tr></table></div><ul>
<li><a href="qml-qtlocation-contactdetails-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">variant <b><b><a href="qml-qtlocation-contactdetails.html#keys-method">keys</a></b></b>()</li>
</ul>
<!-- $$$ContactDetails-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The <a href="qml-qtlocation-contactdetails.html">ContactDetails</a> type is a map of <a href="qml-qtlocation-contactdetail.html">ContactDetail</a> objects. To access contact details in the map use the <a href="qml-qtlocation-contactdetails.html#keys-method">keys()</a> method to get the list of keys stored in the map and then use the <code>[]</code> operator to access the <a href="qml-qtlocation-contactdetail.html">ContactDetail</a> items.</p>
<p>The following keys are defined in the API. <a href="location-places-qml.html#plugin">Plugin</a> implementations are free to define additional keys.</p>
<ul>
<li>phone</li>
<li>fax</li>
<li>email</li>
<li>website</li>
</ul>
<p><a href="qml-qtlocation-contactdetails.html">ContactDetails</a> instances are only ever used in the context of <a href="qml-qtlocation-place.html">Places</a>. It is not possible to create a <a href="qml-qtlocation-contactdetails.html">ContactDetails</a> instance directly or re-assign <a href="qml-qtlocation-contactdetails.html">ContactDetails</a> instances to <a href="qml-qtlocation-place.html">Places</a>. Modification of <a href="qml-qtlocation-contactdetails.html">ContactDetails</a> can only be accomplished via Javascript.</p>
<a name="examples"></a>
<h2 id="examples">Examples</h2>
<p>The following example shows how to access all <a href="qml-qtlocation-contactdetail.html">ContactDetails</a> and print them to the console:</p>
<pre class="qml">import QtPositioning 5.5
import QtLocation 5.5
<span class="keyword">function</span> <span class="name">printContactDetails</span>(<span class="name">contactDetails</span>) {
var <span class="name">keys</span> = <span class="name">contactDetails</span>.<span class="name">keys</span>();
<span class="keyword">for</span> (<span class="keyword">var</span> <span class="name">i</span> = <span class="number">0</span>; <span class="name">i</span> <span class="operator"><</span> <span class="name">keys</span>.<span class="name">length</span>; ++<span class="name">i</span>) {
var <span class="name">contactList</span> = <span class="name">contactDetails</span>[<span class="name">keys</span>[<span class="name">i</span>]];
<span class="keyword">for</span> (<span class="keyword">var</span> <span class="name">j</span> = <span class="number">0</span>; <span class="name">j</span> <span class="operator"><</span> <span class="name">contactList</span>.<span class="name">length</span>; ++<span class="name">j</span>) {
<span class="name">console</span>.<span class="name">log</span>(<span class="name">contactList</span>[<span class="name">j</span>].<span class="name">label</span> <span class="operator">+</span> <span class="string">": "</span> <span class="operator">+</span> <span class="name">contactList</span>[<span class="name">j</span>].<span class="name">value</span>);
}
}
}</pre>
<p>The returned list of contact details is an object list and so can be used directly as a data model. For example, the following demonstrates how to display a list of contact phone numbers in a list view:</p>
<pre class="qml">import QtQuick 2.0
import QtPositioning 5.5
import QtLocation 5.5
<span class="type">ListView</span> {
<span class="name">model</span>: <span class="name">place</span>.<span class="name">contactDetails</span>.<span class="name">phone</span>;
<span class="name">delegate</span>: <span class="name">Text</span> { <span class="name">text</span>: <span class="name">modelData</span>.<span class="name">label</span> <span class="operator">+</span> <span class="string">": "</span> <span class="operator">+</span> <span class="name">modelData</span>.<span class="name">value</span> }
}</pre>
<p>The following example demonstrates how to assign a single phone number to a place in JavaScript:</p>
<pre class="qml"><span class="keyword">function</span> <span class="name">writeSingle</span>() {
var <span class="name">phoneNumber</span> = <span class="name">Qt</span>.<span class="name">createQmlObject</span>(<span class="string">'import QtLocation 5.3; ContactDetail {}'</span>, <span class="name">place</span>);
<span class="name">phoneNumber</span>.<span class="name">label</span> <span class="operator">=</span> <span class="string">"Phone"</span>;
<span class="name">phoneNumber</span>.<span class="name">value</span> <span class="operator">=</span> <span class="string">"555-5555"</span>
<span class="name">place</span>.<span class="name">contactDetails</span>.<span class="name">phone</span> <span class="operator">=</span> <span class="name">phoneNumber</span>;
}</pre>
<p>The following demonstrates how to assign multiple phone numbers to a place in JavaScript:</p>
<pre class="qml"><span class="keyword">function</span> <span class="name">writeMultiple</span>() {
var <span class="name">bob</span> = <span class="name">Qt</span>.<span class="name">createQmlObject</span>(<span class="string">'import QtLocation 5.3; ContactDetail {}'</span>, <span class="name">place</span>);
<span class="name">bob</span>.<span class="name">label</span> <span class="operator">=</span> <span class="string">"Bob"</span>;
<span class="name">bob</span>.<span class="name">value</span> <span class="operator">=</span> <span class="string">"555-5555"</span>
var <span class="name">alice</span> = <span class="name">Qt</span>.<span class="name">createQmlObject</span>(<span class="string">'import QtLocation 5.3; ContactDetail {}'</span>, <span class="name">place</span>);
<span class="name">alice</span>.<span class="name">label</span> <span class="operator">=</span> <span class="string">"Alice"</span>;
<span class="name">alice</span>.<span class="name">value</span> <span class="operator">=</span> <span class="string">"555-8745"</span>
var <span class="name">numbers</span> = new <span class="name">Array</span>();
<span class="name">numbers</span>.<span class="name">push</span>(<span class="name">bob</span>);
<span class="name">numbers</span>.<span class="name">push</span>(<span class="name">alice</span>);
<span class="name">place</span>.<span class="name">contactDetails</span>.<span class="name">phone</span> <span class="operator">=</span> <span class="name">numbers</span>;
}</pre>
<!-- @@@ContactDetails -->
<h2>Method Documentation</h2>
<!-- $$$keys -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="keys-method"><td class="tblQmlFuncNode"><p><a name="keys-method"></a><span class="type">variant</span> <span class="name">keys</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>Returns an array of contact detail keys currently stored in the map.</p>
</div></div><!-- @@@keys -->
<br/>
</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>
|