/usr/share/u1db-qt/doc/html/qml-u1db-index.html is in libu1db-qt5-doc 0.1.5+15.10.20150826.1-0ubuntu1.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- index.cpp -->
<title>Index QML Type | U1Db-Qt </title>
<link rel="stylesheet" type="text/css" href="style/css.css">
<link rel="stylesheet" type="text/css" href="style/css_002.css">
<link rel="stylesheet" type="text/css" href="style/reset.css">
<link rel="stylesheet" type="text/css" href="style/qtquick.css">
<link rel="stylesheet" type="text/css" href="style/base.css">
<link rel="stylesheet" type="text/css" href="style/scratch.css">
<link rel="stylesheet" type="text/css" href="style/base.css" /></head>
<body>
<div class="wrapper">
<div class="main-content">
<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>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Index QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Index-brief -->
<p>An Index defines what fields can be filtered using Query. <a href="#details">More...</a></p>
<!-- @@@Index -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import U1db .</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-u1db-index.html"><a href="index.html">Index</a></td></tr></table></div><ul>
<li><a href="qml-u1db-index-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-u1db-index.html#database-prop">database</a></b></b> : Database</li>
<li class="fn"><b><b><a href="qml-u1db-index.html#expression-prop">expression</a></b></b> : list<string></li>
<li class="fn"><b><b><a href="qml-u1db-index.html#name-prop">name</a></b></b> : string</li>
</ul>
<!-- $$$Index-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>Documents in the database will be included if they contain all fields in the expression.</p>
<pre class="qml"><span class="type"><a href="qml-u1db-index.html">Index</a></span> {
<span class="name">database</span>: <span class="name">myDatabase</span>
<span class="name">name</span>: <span class="string">'colorIndex'</span>
<span class="name">expression</span>: [ <span class="string">'color'</span> ]
}</pre>
<p><b>See also </b><a href="qml-u1db-query.html">Query</a>.</p>
<!-- @@@Index -->
<h2>Property Documentation</h2>
<!-- $$$database -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="database-prop"><td class="tblQmlPropNode"><p><a name="database-prop"></a><span class="name">database</span> : <span class="type"><a href="qml-u1db-database.html">Database</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>Sets the Database to lookup documents from and store the index in. The dataInvalidated() signal will be emitted on all changes that could affect the index.</p>
</div></div><!-- @@@database -->
<br/>
<!-- $$$expression -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="expression-prop"><td class="tblQmlPropNode"><p><a name="expression-prop"></a><span class="name">expression</span> : <span class="type">list</span><<span class="type">string</span>></p></td></tr></table></div></div><div class="qmldoc"><p>Sets the expression used. Both an expression and a name must be specified for an index to be created.</p>
<p>Also starts the process of creating the Index result list, which can then be queried or populate the Query model as is.</p>
</div></div><!-- @@@expression -->
<br/>
<!-- $$$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>Sets the name used. Both an expression and a name must be specified for an index to be created.</p>
</div></div><!-- @@@name -->
<br/>
</div>
</div>
</body>
</html>
|