/usr/share/qt5/doc/qtlocation/qml-qtlocation-pluginparameter.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativegeoserviceprovider.cpp -->
<title>PluginParameter 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>PluginParameter 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="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#example-usage">Example Usage</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">PluginParameter QML Type</h1>
<span class="subtitle"></span>
<!-- $$$PluginParameter-brief -->
<p>The <a href="qml-qtlocation-pluginparameter.html">PluginParameter</a> type describes a parameter to a <a href="location-places-qml.html#plugin">Plugin</a>. <a href="#details">More...</a></p>
<!-- @@@PluginParameter -->
<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-pluginparameter-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtlocation-pluginparameter.html#name-prop">name</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtlocation-pluginparameter.html#value-prop">value</a></b></b> : QVariant</li>
</ul>
<!-- $$$PluginParameter-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The <a href="qml-qtlocation-pluginparameter.html">PluginParameter</a> object is used to provide a parameter of some kind to a Plugin. Typically these parameters contain details like an application token for access to a service, or a proxy server to use for network access.</p>
<p>To set such a parameter, declare a <a href="qml-qtlocation-pluginparameter.html">PluginParameter</a> inside a <a href="location-places-qml.html#plugin">Plugin</a> object, and give it <a href="qml-qtlocation-pluginparameter.html#name-prop">name</a> and <a href="qml-qtlocation-pluginparameter.html#value-prop">value</a> properties. A list of valid parameter names for each plugin is available from the <a href="qtlocation-index.html#plugin-references-and-parameters">plugin reference pages</a>.</p>
<a name="example-usage"></a>
<h3 >Example Usage</h3>
<p>The following example shows an instantiation of the <a href="location-plugin-here.html">HERE</a> plugin with a mapping API <i>app_id</i> and <i>token</i> pair specific to the application.</p>
<pre class="cpp">Plugin {
name: <span class="string">"here"</span>
PluginParameter { name: <span class="string">"here.app_id"</span>; value: <span class="string">"EXAMPLE_API_ID"</span> }
PluginParameter { name: <span class="string">"here.token"</span>; value: <span class="string">"EXAMPLE_TOKEN_123"</span> }
}</pre>
<!-- @@@PluginParameter -->
<h2>Property Documentation</h2>
<!-- $$$name -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="name-prop"><td class="tblQmlPropNode"><p><a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the name of the plugin parameter as a single formatted string.</p>
</div></div><!-- @@@name -->
<br/>
<!-- $$$value -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="value-prop"><td class="tblQmlPropNode"><p><a name="value-prop"></a><span class="name">value</span> : <span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the value of the plugin parameter which support different types of values (variant).</p>
</div></div><!-- @@@value -->
<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>
|