/usr/share/u1db-qt/doc/html/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 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | <?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 Class | 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">
<li>Index</li>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</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 Class</h1>
<!-- $$$Index-brief -->
<p>The Index class defines an index to be stored in the database and queried using Query. Changes in documents affected by the index also update the index in the database. <a href="#details">More...</a></p>
<!-- @@@Index -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Index></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-u1db-index.html">Index</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> </td></tr></table></div><ul>
<li><a href="index-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="index.html#Index">Index</a></b>(QObject *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Database * </td><td class="memItemRight bottomAlign"><b><a href="index.html#getDatabase">getDatabase</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="index.html#getExpression">getExpression</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="index.html#getName">getName</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="index.html#setDatabase">setDatabase</a></b>(Database *<i> database</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="index.html#setExpression">setExpression</a></b>(QStringList<i> expression</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="index.html#setName">setName</a></b>(const QString &<i> name</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$Index-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The Index class defines an index to be stored in the database and queried using Query. Changes in documents affected by the index also update the index in the database.</p>
</div>
<!-- @@@Index -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Index[overload1]$$$IndexQObject* -->
<h3 class="fn" id="Index"><a name="Index"></a>Index::<span class="name">Index</span>(<span class="type">QObject</span> *<i> parent</i> = 0)</h3>
<p>Instantiate a new Index with an optional <i>parent</i>, usually by declaring it as a QML item.</p>
<!-- @@@Index -->
<!-- $$$getDatabase[overload1]$$$getDatabase -->
<h3 class="fn" id="getDatabase"><a name="getDatabase"></a><span class="type"><a href="qml-u1db-database.html">Database</a></span> * Index::<span class="name">getDatabase</span>()</h3>
<p>Returns the <a href="qml-u1db-database.html">Database</a> to lookup documents from and store the index in.</p>
<!-- @@@getDatabase -->
<!-- $$$getExpression[overload1]$$$getExpression -->
<h3 class="fn" id="getExpression"><a name="getExpression"></a><span class="type">QStringList</span> Index::<span class="name">getExpression</span>()</h3>
<p>Returns the expression of the index. Both name and expression must be specified.</p>
<!-- @@@getExpression -->
<!-- $$$getName[overload1]$$$getName -->
<h3 class="fn" id="getName"><a name="getName"></a><span class="type">QString</span> Index::<span class="name">getName</span>()</h3>
<p>Returns the name of the index. Both name and expression must be specified.</p>
<!-- @@@getName -->
<!-- $$$setDatabase[overload1]$$$setDatabaseDatabase* -->
<h3 class="fn" id="setDatabase"><a name="setDatabase"></a><span class="type">void</span> Index::<span class="name">setDatabase</span>(<span class="type"><a href="qml-u1db-database.html">Database</a></span> *<i> database</i>)</h3>
<p>Sets the <i>database</i> to lookup documents from and store the index in. The dataInvalidated() signal will be emitted on all changes that could affect the index.</p>
<!-- @@@setDatabase -->
<!-- $$$setExpression[overload1]$$$setExpressionQStringList -->
<h3 class="fn" id="setExpression"><a name="setExpression"></a><span class="type">void</span> Index::<span class="name">setExpression</span>(<span class="type">QStringList</span><i> expression</i>)</h3>
<p>Sets the <i>expression</i> 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>
<!-- @@@setExpression -->
<!-- $$$setName[overload1]$$$setNameconstQString& -->
<h3 class="fn" id="setName"><a name="setName"></a><span class="type">void</span> Index::<span class="name">setName</span>(const <span class="type">QString</span> &<i> name</i>)</h3>
<p>Sets the <i>name</i> used. Both an expression and a name must be specified for an index to be created.</p>
<!-- @@@setName -->
</div>
</div>
</div>
</body>
</html>
|